remark-preset-lint-recommended

What is remark-preset-lint-recommended?

The remark-preset-lint-recommended package is a preset configuration for remark-lint, a tool used to lint Markdown files. It includes a set of recommended rules to ensure consistent and error-free Markdown content.

What are remark-preset-lint-recommended's main functionalities?

Linting for Markdown

This configuration file sets up remark-lint with the recommended preset. It ensures that your Markdown files adhere to a set of best practices and common standards.

module.exports = {
  "plugins": [
    ["remark-lint", [
      require("remark-preset-lint-recommended")
    ]]
  ]
};

Integration with remark

This code demonstrates how to integrate the recommended linting rules directly into a remark processing pipeline. It processes a Markdown string and applies the linting rules.

const remark = require('remark');
const recommended = require('remark-preset-lint-recommended');

remark()
  .use(recommended)
  .process('# Hello world!', function (err, file) {
    if (err) throw err;
    console.log(String(file));
  });

Other packages similar to remark-preset-lint-recommended

remark-lint

remark-lint is the core linter for Markdown files. It provides the base functionality for linting and can be extended with various plugins, including remark-preset-lint-recommended. It is more flexible but requires manual configuration of rules.

remark-preset-lint-consistent

remark-preset-lint-consistent is another preset for remark-lint that focuses on consistent Markdown formatting. It includes a different set of rules compared to remark-preset-lint-recommended, aimed at ensuring uniformity in Markdown files.

remark-preset-lint-markdown-style-guide

remark-preset-lint-markdown-style-guide is a preset that enforces the rules defined by the Markdown style guide. It is more opinionated and comprehensive compared to remark-preset-lint-recommended, making it suitable for projects that follow the style guide strictly.

README

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