remark-lint-list-item-indent

What is remark-lint-list-item-indent?

The remark-lint-list-item-indent package is a plugin for remark-lint that ensures consistent indentation for list items in Markdown files. It helps maintain a uniform style and prevents issues related to inconsistent list item indentation.

What are remark-lint-list-item-indent's main functionalities?

Check for consistent indentation

This feature checks that list items are indented using spaces. The configuration specifies 'space' to enforce this rule.

module.exports = {
  plugins: [
    ['remark-lint-list-item-indent', 'space']
  ]
};

Check for tab indentation

This feature checks that list items are indented using tabs. The configuration specifies 'tab' to enforce this rule.

module.exports = {
  plugins: [
    ['remark-lint-list-item-indent', 'tab']
  ]
};

Other packages similar to remark-lint-list-item-indent

remark-lint

remark-lint is a general-purpose Markdown linter that can be extended with various plugins, including remark-lint-list-item-indent. It provides a wide range of rules for ensuring Markdown quality and consistency.

markdownlint

markdownlint is a Node.js style checker and lint tool for Markdown files. It offers a comprehensive set of rules and can be customized to enforce specific styles, similar to remark-lint-list-item-indent.

markdown-it

markdown-it is a Markdown parser that can be extended with plugins to enforce specific styles and rules. While it is primarily a parser, it can be used in conjunction with linting tools to achieve similar functionality to remark-lint-list-item-indent.

README

remark-lint-list-item-indent

Warn when the spacing between a list item’s bullet and its content violates a given style.

Options: 'tab-size', 'mixed', or 'space', default: 'tab-size'.

Presets

This rule is included in the following presets:

Preset	Setting
remark-preset-lint-markdown-style-guide
remark-preset-lint-recommended

Example

valid.md

In

Note: · represents a space.

*···List
····item.

Paragraph.

11.·List
····item.

Paragraph.

*···List
····item.

*···List
····item.

Out

No messages.

valid.md

When configured with 'mixed'.

In

Note: · represents a space.

*·List item.

Paragraph.

11.·List item

Paragraph.

*···List
····item.

*···List
····item.

Out

No messages.

invalid.md

When configured with 'mixed'.

In

Note: · represents a space.

*···List item.

Out

1:5: Incorrect list-item indent: remove 2 spaces

valid.md

When configured with 'space'.

In

Note: · represents a space.

*·List item.

Paragraph.

11.·List item

Paragraph.

*·List
··item.

*·List
··item.

Out

No messages.

invalid.md

When configured with 'space'.

In

Note: · represents a space.

*···List
····item.

Out

1:5: Incorrect list-item indent: remove 2 spaces

invalid.md

When configured with 'tab-size'.

In

Note: · represents a space.

*·List
··item.

Out

1:3: Incorrect list-item indent: add 2 spaces

invalid.md

When configured with 'invalid'.

Out

1:1: Invalid list-item indent style `invalid`: use either `'tab-size'`, `'space'`, or `'mixed'`

Install

npm install remark-lint-list-item-indent

Usage

You probably want to use it on the CLI through a config file:

 ...
 "remarkConfig": {
   "plugins": [
     ...
     "lint",
+    "lint-list-item-indent",
     ...
   ]
 }
 ...

Or use it on the CLI directly

remark -u lint -u lint-list-item-indent readme.md

Or use this on the API:

 var remark = require('remark');
 var report = require('vfile-reporter');

 remark()
   .use(require('remark-lint'))
+  .use(require('remark-lint-list-item-indent'))
   .process('_Emphasis_ and **importance**', function (err, file) {
     console.error(report(err || file));
   });

License

MIT © Titus Wormer