Research
Security News
Malicious npm Package Targets Solana Developers and Hijacks Funds
A malicious npm package targets Solana developers, rerouting funds in 2% of transactions to a hardcoded address.
mdast-util-gfm-task-list-item
Advanced tools
mdast extension to parse and serialize GFM task list items
The `mdast-util-gfm-task-list-item` package is a utility for working with GitHub Flavored Markdown (GFM) task list items within the MDAST (Markdown Abstract Syntax Tree) ecosystem. It provides functionality to parse and transform task list items in Markdown documents.
Parse GFM Task List Items
This feature allows you to parse GFM task list items from a Markdown string into an MDAST tree. The code sample demonstrates how to convert a Markdown string containing task list items into an MDAST tree.
const { fromMarkdown } = require('mdast-util-from-markdown');
const { gfmTaskListItemFromMarkdown } = require('mdast-util-gfm-task-list-item');
const markdown = '- [ ] Task 1\n- [x] Task 2';
const tree = fromMarkdown(markdown, { extensions: [gfmTaskListItemFromMarkdown()] });
console.log(JSON.stringify(tree, null, 2));
Serialize GFM Task List Items
This feature allows you to serialize an MDAST tree containing GFM task list items back into a Markdown string. The code sample demonstrates how to convert an MDAST tree with task list items into a Markdown string.
const { toMarkdown } = require('mdast-util-to-markdown');
const { gfmTaskListItemToMarkdown } = require('mdast-util-gfm-task-list-item');
const tree = {
type: 'root',
children: [
{ type: 'listItem', checked: null, children: [{ type: 'text', value: 'Task 1' }] },
{ type: 'listItem', checked: true, children: [{ type: 'text', value: 'Task 2' }] }
]
};
const markdown = toMarkdown(tree, { extensions: [gfmTaskListItemToMarkdown()] });
console.log(markdown);
The `remark-gfm` package is a plugin for the `remark` Markdown processor that adds support for GitHub Flavored Markdown (GFM) features, including task lists, tables, and strikethrough. It provides a more comprehensive set of GFM features compared to `mdast-util-gfm-task-list-item`, which focuses specifically on task list items.
The `remark-task-list` package is a plugin for `remark` that specifically handles task lists in Markdown. It provides similar functionality to `mdast-util-gfm-task-list-item` but is designed to be used directly with the `remark` processor, making it a more integrated solution for users of the `remark` ecosystem.
mdast extensions to parse and serialize GFM task list items.
This package contains two extensions that add support for GFM task list item
syntax in markdown to mdast.
These extensions plug into
mdast-util-from-markdown
(to support parsing
task lists in markdown into a syntax tree) and
mdast-util-to-markdown
(to support serializing
task lists in syntax trees to markdown).
You can use these extensions when you are working with
mdast-util-from-markdown
and mdast-util-to-markdown
already.
When working with mdast-util-from-markdown
, you must combine this package
with
micromark-extension-gfm-task-list-item
.
When you don’t need a syntax tree, you can use micromark
directly with micromark-extension-gfm-task-list-item
.
When you are working with syntax trees and want all of GFM, use
mdast-util-gfm
instead.
All these packages are used remark-gfm
, which
focusses on making it easier to transform content by abstracting these
internals away.
This utility does not handle how markdown is turned to HTML.
That’s done by mdast-util-to-hast
.
This package is ESM only. In Node.js (version 16+), install with npm:
npm install mdast-util-gfm-task-list-item
In Deno with esm.sh
:
import {gfmTaskListItemFromMarkdown, gfmTaskListItemToMarkdown} from 'https://esm.sh/mdast-util-gfm-task-list-item@2'
In browsers with esm.sh
:
<script type="module">
import {gfmTaskListItemFromMarkdown, gfmTaskListItemToMarkdown} from 'https://esm.sh/mdast-util-gfm-task-list-item@2?bundle'
</script>
Say our document example.md
contains:
* [ ] To do
* [x] Done
1. Mixed…
2. [x] …messages
…and our module example.js
looks as follows:
import fs from 'node:fs/promises'
import {gfmTaskListItem} from 'micromark-extension-gfm-task-list-item'
import {fromMarkdown} from 'mdast-util-from-markdown'
import {gfmTaskListItemFromMarkdown, gfmTaskListItemToMarkdown} from 'mdast-util-gfm-task-list-item'
import {toMarkdown} from 'mdast-util-to-markdown'
const doc = await fs.readFile('example.md')
const tree = fromMarkdown(doc, {
extensions: [gfmTaskListItem],
mdastExtensions: [gfmTaskListItemFromMarkdown]
})
console.log(tree)
const out = toMarkdown(tree, {extensions: [gfmTaskListItemToMarkdown]})
console.log(out)
…now running node example.js
yields (positional info removed for brevity):
{
type: 'root',
children: [
{
type: 'list',
ordered: false,
start: null,
spread: false,
children: [
{
type: 'listItem',
spread: false,
checked: false,
children: [
{type: 'paragraph', children: [{type: 'text', value: 'To do'}]}
]
},
{
type: 'listItem',
spread: false,
checked: true,
children: [
{type: 'paragraph', children: [{type: 'text', value: 'Done'}]}
]
}
]
},
{
type: 'list',
ordered: true,
start: 1,
spread: false,
children: [
{
type: 'listItem',
spread: false,
checked: null,
children: [
{type: 'paragraph', children: [{type: 'text', value: 'Mixed…'}]}
]
},
{
type: 'listItem',
spread: false,
checked: true,
children: [
{type: 'paragraph', children: [{type: 'text', value: '…messages'}]}
]
}
]
}
]
}
* [ ] To do
* [x] Done
1. Mixed…
2. [x] …messages
This package exports the identifiers
gfmTaskListItemFromMarkdown
and
gfmTaskListItemToMarkdown
.
There is no default export.
gfmTaskListItemFromMarkdown()
Create an extension for mdast-util-from-markdown
to enable GFM task list items in markdown.
Extension for mdast-util-from-markdown
to enable GFM task list items
(FromMarkdownExtension
).
gfmTaskListItemToMarkdown()
Create an extension for mdast-util-to-markdown
to
enable GFM task list items in markdown.
Extension for mdast-util-to-markdown
to enable GFM task list items
(ToMarkdownExtension
).
This utility does not handle how markdown is turned to HTML.
That’s done by mdast-util-to-hast
.
See Syntax in micromark-extension-gfm-task-list-item
.
The following interfaces are added to mdast by this utility.
ListItem
(GFM)interface ListItemGfm <: ListItem {
checked: boolean?
}
In GFM, a checked
field can be present.
It represents whether the item is done (when true
), not done (when false
),
or indeterminate or not applicable (when null
or not present).
ListContent
(GFM)type ListContentGfm = ListItemGfm
This package is fully typed with TypeScript. It does not export additional types.
The ListItem
type of the mdast nodes are exposed from @types/mdast
.
Projects maintained by the unified collective are compatible with maintained versions of Node.js.
When we cut a new major release, we drop support for unmaintained versions of
Node.
This means we try to keep the current release line,
mdast-util-gfm-task-list-item@^2
, compatible with Node.js 16.
remarkjs/remark-gfm
— remark plugin to support GFMsyntax-tree/mdast-util-gfm
— same but all of GFM (autolink literals, footnotes, strikethrough, tables,
tasklists)micromark/micromark-extension-gfm-task-list-item
— micromark extension to parse GFM task list itemsSee contributing.md
in syntax-tree/.github
for
ways to get started.
See support.md
for ways to get help.
This project has a code of conduct. By interacting with this repository, organization, or community you agree to abide by its terms.
FAQs
mdast extension to parse and serialize GFM task list items
The npm package mdast-util-gfm-task-list-item receives a total of 3,517,888 weekly downloads. As such, mdast-util-gfm-task-list-item popularity was classified as popular.
We found that mdast-util-gfm-task-list-item demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 2 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Research
Security News
A malicious npm package targets Solana developers, rerouting funds in 2% of transactions to a hardcoded address.
Security News
Research
Socket researchers have discovered malicious npm packages targeting crypto developers, stealing credentials and wallet data using spyware delivered through typosquats of popular cryptographic libraries.
Security News
Socket's package search now displays weekly downloads for npm packages, helping developers quickly assess popularity and make more informed decisions.