Skip to main content
Version: 1.x.x

@yozora/tokenizer-list-item

Npm VersionNpm DownloadNpm LicenseModule formats: cjs, esmNode.js VersionTested with JestCode Style: prettier

github flavor markdown spec

A list marker is a bullet list marker or an ordered list marker.

A bullet list marker is a -, +, or * character.

An ordered list markeris a sequence of 191-9 arabic digits (0-9), followed by either a . character or a ) character. (The reason for the length limit is that with 10 digits we start seeing integer overflows in some browsers.)

The following rules define list items:

  1. Basic case. If a sequence of lines LsL_s constitute a sequence of blocks BsB_s starting with a non-whitespace character, and MM is a list marker of width WW followed by 1N41 \leqslant N \leqslant 4 spaces, then the result of prepending MM and the following spaces to the first line of LsL_s, and indenting subsequent lines of LsL_s by W+NW + N spaces, is a list item with Bs as its contents. The type of the list item (bullet or ordered) is determined by the type of its list marker. If the list item is ordered, then it is also assigned a start number, based on the ordered list marker.

Exceptions:

  1. When the first list item in a list interrupts a paragraph—that is, when it starts on a line that would otherwise count as paragraph continuation text—then

    • (a) the lines Ls must not begin with a blank line, and
    • (b) if the list item is ordered, the start number must be 11.
  2. If any line is a thematic break then that line is not a list item.

  3. Item starting with indented code. If a sequence of lines LsL_s constitute a sequence of blocks BsB_s starting with an indented code block, and MM is a list marker of width WW followed by one space, then the result of prepending MM and the following space to the first line of LsL_s, and indenting subsequent lines of LsL_s by W+1W + 1 spaces, is a list item with BsB_s as its contents. If a line is empty, then it need not be indented. The type of the list item (bullet or ordered) is determined by the type of its list marker. If the list item is ordered, then it is also assigned a start number, based on the ordered list marker.

  4. Item starting with a blank line. If a sequence of lines LsL_s starting with a single blank line constitute a (possibly empty) sequence of blocks BsB_s, not separated from each other by more than one blank line, and MM is a list marker of width WW, then the result of prepending MM to the first line of LsL_s, and indenting subsequent lines of LsL_s by W+1W + 1 spaces, is a list item with BsB_s as its contents. If a line is empty, then it need not be indented. The type of the list item (bullet or ordered) is determined by the type of its list marker. If the list item is ordered, then it is also assigned a start number, based on the ordered list marker.

  5. Indentation. If a sequence of lines LsL_s constitutes a list item according to rule #1, #2, or #3, then the result of indenting each line of LsL_s by 131-3 spaces (the same for each line) also constitutes a list item with the same contents and attributes. If a line is empty, then it need not be indented.

  6. Laziness. If a string of lines LsL_s constitute a list item with contents BsB_s, then the result of deleting some or all of the indentation from one or more lines in which the next non-whitespace character after the indentation is paragraph continuation text is a list item with the same contents and attributes. The unindented lines are called lazy continuation lines.

Install

npm install --save @yozora/tokenizer-list-item

Usage

tip

@yozora/tokenizer-list-item has been integrated into @yozora/parser / @yozora/parser-gfm-ex / @yozora/parser-gfm, so you can use YozoraParser / GfmExParser / GfmParser directly.

import YozoraParser from '@yozora/parser'

const parser = new YozoraParser()

// parse source markdown content
parser.parse(`
- a
- b
- c
- d
- e
- f
- g

---

- [ ] This is a TODO item.
- [-] This is a processing TODO item.
- [x] This is a finished TODO item.

---

1. This is an ordered list item

a. This is an another type of ordered list item
`)

Options

NameTypeRequiredDefault
namestringfalse"@yozora/tokenizer-list-item"
prioritynumberfalseTokenizerPriority.CONTAINING_BLOCK
emptyItemCouldNotInterruptedTypesstring[]false[ParagraphType, PhrasingContentType]
enableTaskListItembooleanfalsefalse
  • name: The unique name of the tokenizer, used to bind the token it generates, to determine the tokenizer that should be called in each life cycle of the token in the entire matching / parsing phase.

  • priority: Priority of the tokenizer, determine the order of processing, high priority priority execution. interruptable. In addition, in the match-block stage, a high-priority tokenizer can interrupt the matching process of a low-priority tokenizer.`

  • emptyItemCouldNotInterruptedTypes: Specify an array of YastNode types that could not be interrupted by this Tokenizer if the current list-item is empty.

    See https://github.github.com/gfm/#example-263.

  • enableTaskListItem: Should enable task list item (extension).

Types

@yozora/tokenizer-list-item produce ListItem type nodes. See @yozora/ast for full base types.

import type { YastParent } from '@yozora/ast'

export const ListItemType = 'listItem'
export type ListItemType = typeof ListItemType

/**
* Status of a task list item.
* @see https://github.github.com/gfm/#task-list-items-extension-
*/
export enum TaskStatus {
/**
* To do, not yet started.
*/
TODO = 'todo',
/**
* In progress.
*/
DOING = 'doing',
/**
* Completed.
*/
DONE = 'done',
}

/**
* ListItem represents an item in a List.
* @see https://github.com/syntax-tree/mdast#listitem
* @see https://github.github.com/gfm/#list-items
*/
export interface ListItem extends YastParent<ListItemType> {
/**
* Status of a todo task.
*/
status?: TaskStatus
}

Live Examples

  • Basic.

      
      
  • Item Starting with indented code.

      
      
  • Item Starting with a blank line.

      
      
  • Indentation.

      
      
  • Lazyniess.

      
      
  • Indentation in sublist.

      
      
  • Task list item (extension).