remark-preset-lint-recommended

Preset of remark-lint rules to warn for likely problems.

Contents

• What is this?
• When should I use this?
• Plugins
• Install
• Use
• API
  • unified().use(remarkPresetLintRecommended)
• Compatibility
• Contribute
• License

What is this?

This package is a preset containing remark-lint rules. Lint rules check markdown code style.

When should I use this?

You can use this package to check that markdown follows some best practices.

Plugins

This preset includes the following plugins:

| Plugin | Options | | - | - | | remark-lint | | | remark-lint-final-newline | | | remark-lint-hard-break-spaces | | | remark-lint-list-item-bullet-indent | | | remark-lint-list-item-indent | 'one' | | remark-lint-no-blockquote-without-marker | | | remark-lint-no-duplicate-definitions | | | remark-lint-no-heading-content-indent | | | remark-lint-no-literal-urls | | | remark-lint-no-shortcut-reference-image | | | remark-lint-no-shortcut-reference-link | | | remark-lint-no-undefined-references | | | remark-lint-no-unused-definitions | | | remark-lint-ordered-list-marker-style | '.' |

Install

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

npm install remark-preset-lint-recommended

In Deno with esm.sh:

import remarkPresetLintRecommended from 'https://esm.sh/remark-preset-lint-recommended@7'

In browsers with esm.sh:

<script type="module">
  import remarkPresetLintRecommended from 'https://esm.sh/remark-preset-lint-recommended@7?bundle'
</script>

Use

On the API:

import remarkParse from 'remark-parse'
import remarkPresetLintRecommended from 'remark-preset-lint-recommended'
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(remarkPresetLintRecommended)
  .use(remarkStringify)
  .process(file)

console.error(reporter(file))

On the CLI:

remark --frail --use remark-preset-lint-recommended .

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

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

API

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

unified().use(remarkPresetLintRecommended)

Check that markdown follows some best practices.

You can reconfigure rules in the preset by using them afterwards with different options.

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-preset-lint-recommended@7, 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