mdast-util-gfm-task-list-item

What is mdast-util-gfm-task-list-item?

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.

What are mdast-util-gfm-task-list-item's main functionalities?

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);

Other packages similar to mdast-util-gfm-task-list-item

remark-gfm

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.

remark-task-list

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.

README

mdast-util-gfm-task-list-item

Extension for mdast-util-from-markdown and/or mdast-util-to-markdown to support GitHub flavored markdown task list items in mdast. When parsing (from-markdown), must be combined with micromark-extension-gfm-task-list-item.

When to use this

Use this if you’re dealing with the AST manually. It’s might be better to use remark-gfm with remark, which includes this but provides a nicer interface and makes it easier to combine with hundreds of plugins.

Install

This package is ESM only: Node 12+ is needed to use it and it must be imported instead of required.

npm:

npm install mdast-util-gfm-task-list-item

Use

Say we have the following file, example.md:

* [ ] To do
* [x] Done

1. Mixed…
2. [x] …messages

And our module, example.js, looks as follows:

import fs from 'node:fs'
import {fromMarkdown} from 'mdast-util-from-markdown'
import {toMarkdown} from 'mdast-util-to-markdown'
import {gfmTaskListItem} from 'micromark-extension-gfm-task-list-item'
import {gfmTaskListItemFromMarkdown, gfmTaskListItemToMarkdown} from 'mdast-util-gfm-task-list-item'

const doc = fs.readFileSync('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 yields (positional info removed for the sake of 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

API

This package exports the following identifier: gfmTaskListItemFromMarkdown, gfmTaskListItemToMarkdown. There is no default export.

gfmTaskListItemFromMarkdown

gfmTaskListItemToMarkdown

Support task list items. The exports are extensions, respectively for mdast-util-from-markdown and mdast-util-to-markdown.

Related

• remarkjs/remark — markdown processor powered by plugins
• remarkjs/remark-gfm — remark plugin to support GFM
• micromark/micromark — the smallest commonmark-compliant markdown parser that exists
• micromark/micromark-extension-gfm-task-list-item — micromark extension to parse GFM task list items
• syntax-tree/mdast-util-from-markdown — mdast parser using micromark to create mdast from markdown
• syntax-tree/mdast-util-to-markdown — mdast serializer to create markdown from mdast

Contribute

See 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.

License

MIT © Titus Wormer