remark-preset-lint-recommended

[![Build][badge-build-image]][badge-build-url]
[![Coverage][badge-coverage-image]][badge-coverage-url]
[![Downloads][badge-downloads-image]][badge-downloads-url]
[![Size][badge-size-image]][badge-size-url]
[![Sponsors][badge-funding-sponsors-image]][badge-funding-url]
[![Backers][badge-funding-backers-image]][badge-funding-url]
[![Chat][badge-chat-image]][badge-chat-url]

Preset of [remark-lint][github-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][github-gist-esm].
In Node.js (version 16+),
install with [npm][npm-install]:

``sh
npm install remark-preset-lint-recommended
`

In Deno with [esm.sh][esm-sh]:

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

In browsers with [esm.sh][esm-sh]:

`html

`

Use

On the API:

`js
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:

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

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

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

API

This package exports no identifiers.
It exports no additional [TypeScript][typescript] types.
The default export is
[remarkPresetLintRecommended][api-remark-preset-lint-recommended].

$3

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][github-dotfiles-contributing] in [remarkjs/.github][github-dotfiles-health] for ways
to get started.
See [support.md`][github-dotfiles-support] for ways to get help.

This project has a [code of conduct][github-dotfiles-coc].
By interacting with this repository, organization, or community you agree to
abide by its terms.

License

[MIT][file-license] © [Titus Wormer][author]

[api-remark-preset-lint-recommended]: #unifieduseremarkpresetlintrecommended

[author]: https://wooorm.com

[badge-build-image]: https://github.com/remarkjs/remark-lint/workflows/main/badge.svg

[badge-build-url]: https://github.com/remarkjs/remark-lint/actions

[badge-chat-image]: https://img.shields.io/badge/chat-discussions-success.svg

[badge-chat-url]: https://github.com/remarkjs/remark/discussions

[badge-coverage-image]: https://img.shields.io/codecov/c/github/remarkjs/remark-lint.svg

[badge-coverage-url]: https://codecov.io/github/remarkjs/remark-lint

[badge-downloads-image]: https://img.shields.io/npm/dm/remark-preset-lint-recommended.svg

[badge-downloads-url]: https://www.npmjs.com/package/remark-preset-lint-recommended

[badge-funding-backers-image]: https://opencollective.com/unified/backers/badge.svg

[badge-funding-sponsors-image]: https://opencollective.com/unified/sponsors/badge.svg

[badge-funding-url]: https://opencollective.com/unified

[badge-size-image]: https://img.shields.io/bundlejs/size/remark-preset-lint-recommended

[badge-size-url]: https://bundlejs.com/?q=remark-preset-lint-recommended

[esm-sh]: https://esm.sh

[file-license]: https://github.com/remarkjs/remark-lint/blob/main/license

[github-dotfiles-coc]: https://github.com/remarkjs/.github/blob/main/code-of-conduct.md

[github-dotfiles-contributing]: https://github.com/remarkjs/.github/blob/main/contributing.md

[github-dotfiles-health]: https://github.com/remarkjs/.github

[github-dotfiles-support]: https://github.com/remarkjs/.github/blob/main/support.md

[github-gist-esm]: https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c

[github-remark-lint]: https://github.com/remarkjs/remark-lint

[npm-install]: https://docs.npmjs.com/cli/install

[typescript]: https://www.typescriptlang.org