remark-preset-lint-recommended

remark-preset-lint-recommended

remark preset to configure remark-lint with settings that prevent mistakes or stuff that fails across vendors.

Rules

This preset configures remark-lint with the following rules:

Rule	Setting
remark-lint-final-newline
remark-lint-list-item-bullet-indent
remark-lint-list-item-indent	'tab-size'
remark-lint-no-auto-link-without-protocol
remark-lint-no-blockquote-without-marker
remark-lint-no-literal-urls
remark-lint-ordered-list-marker-style	'.'
remark-lint-hard-break-spaces
remark-lint-no-duplicate-definitions
remark-lint-no-heading-content-indent
remark-lint-no-inline-padding
remark-lint-no-shortcut-reference-image
remark-lint-no-shortcut-reference-link
remark-lint-no-undefined-references
remark-lint-no-unused-definitions

Install

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

npm:

npm install remark-preset-lint-recommended

This package exports no identifiers. The default export is remarkPresetLintRecommended.

Use

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

 …
 "remarkConfig": {
+  "plugins": ["preset-lint-recommended"]
 }
 …

Or use it on the CLI directly

remark -u preset-lint-recommended readme.md

Or use this on the API:

 import {remark} from 'remark'
 import {reporter} from 'vfile-reporter'
 import remarkPresetLintRecommended from 'remark-preset-lint-recommended'

 remark()
+  .use(remarkPresetLintRecommended)
   .process('_Emphasis_ and **importance**')
   .then((file) => {
     console.error(reporter(file))
   })

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