remark-lint-list-item-bullet-indent

remark-lint-list-item-bullet-indent

remark-lint rule to warn when list item markers are indented.

Contents

• What is this?
• When should I use this?
• Presets
• Install
• Use
• API
  • unified().use(remarkLintListItemBulletIndent)
• Recommendation
• Fix
• Examples
• Compatibility
• Contribute
• License

What is this?

This package checks indentation before list item markers.

When should I use this?

You can use this package to check that the style of list items is consistent.

Presets

This plugin is included in the following presets:

Preset	Options
remark-preset-lint-recommended

Install

This package is ESM only. In Node.js (version 16+), install with npm:

npm install remark-lint-list-item-bullet-indent

In Deno with esm.sh:

import remarkLintListItemBulletIndent from 'https://esm.sh/remark-lint-list-item-bullet-indent@5'

In browsers with esm.sh:

<script type="module">
  import remarkLintListItemBulletIndent from 'https://esm.sh/remark-lint-list-item-bullet-indent@5?bundle'
</script>

Use

On the API:

import remarkLint from 'remark-lint'
import remarkLintListItemBulletIndent from 'remark-lint-list-item-bullet-indent'
import remarkParse from 'remark-parse'
import remarkStringify from 'remark-stringify'
import {read} from 'to-vfile'
import {unified} from 'unified'
import {reporter} from 'vfile-reporter'

const file = await read('example.md')

await unified()
  .use(remarkParse)
  .use(remarkLint)
  .use(remarkLintListItemBulletIndent)
  .use(remarkStringify)
  .process(file)

console.error(reporter(file))

On the CLI:

remark --frail --use remark-lint --use remark-lint-list-item-bullet-indent .

On the CLI in a config file (here a package.json):

 …
 "remarkConfig": {
   "plugins": [
     …
     "remark-lint",
+    "remark-lint-list-item-bullet-indent",
     …
   ]
 }
 …

API

This package exports no identifiers. It exports no additional TypeScript types. The default export is remarkLintListItemBulletIndent.

unified().use(remarkLintListItemBulletIndent)

Warn when list item markers are indented.

Parameters

There are no options.

Returns

Transform (Transformer from unified).

Recommendation

There is no specific handling of indented list items in markdown. While it is possible to use an indent to align ordered lists on their marker:

  1. Mercury
 10. Venus
100. Earth

…such a style is uncommon and hard to maintain as adding a 10th item means 9 other items have to change (more arduous while unlikely would be the 100th item). So it is recommended to not indent items and to turn this rule on.

Fix

remark-stringify formats all items without indent.

Examples

ok.md

In

Mercury.

* Venus.
* Earth.

Out

No messages.

not-ok.md

In

Mercury.

␠* Venus.
␠* Earth.

Out

3:2: Unexpected `1` space before list item, expected `0` spaces, remove them
4:2: Unexpected `1` space before list item, expected `0` spaces, remove them

Compatibility

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, remark-lint-list-item-bullet-indent@5, compatible with Node.js 16.

Contribute

See contributing.md in remarkjs/.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