remark-lint-definition-spacing

remark-lint-definition-spacing

remark-lint rule to warn when consecutive whitespace is used in a definition label.

Contents

• What is this?
• When should I use this?
• Presets
• Install
• Use
• API
  • unified().use(remarkLintDefinitionSpacing)
• Recommendation
• Examples
• Compatibility
• Contribute
• License

What is this?

This package checks the whitepsace in definition labels.

GFM footnotes are not affected by this rule as footnote labels cannot contain whitespace.

When should I use this?

You can use this package to check that definition labels are consistent.

Presets

This plugin is included in the following presets:

Preset	Options
remark-preset-lint-markdown-style-guide

Install

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

npm install remark-lint-definition-spacing

In Deno with esm.sh:

import remarkLintDefinitionSpacing from 'https://esm.sh/remark-lint-definition-spacing@4'

In browsers with esm.sh:

<script type="module">
  import remarkLintDefinitionSpacing from 'https://esm.sh/remark-lint-definition-spacing@4?bundle'
</script>

Use

On the API:

import remarkLint from 'remark-lint'
import remarkLintDefinitionSpacing from 'remark-lint-definition-spacing'
import remarkParse from 'remark-parse'
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(remarkLint)
  .use(remarkLintDefinitionSpacing)
  .use(remarkStringify)
  .process(file)

console.error(reporter(file))

On the CLI:

remark --frail --use remark-lint --use remark-lint-definition-spacing .

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

 …
 "remarkConfig": {
   "plugins": [
     …
     "remark-lint",
+    "remark-lint-definition-spacing",
     …
   ]
 }
 …

API

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

unified().use(remarkLintDefinitionSpacing)

Warn when consecutive whitespace is used in a definition label.

Parameters

There are no options.

Returns

Transform (Transformer from unified).

Recommendation

Definitions and references are matched together by collapsing whitespace. Using more whitespace in labels might incorrectly indicate that they are of importance. Due to this, it’s recommended to use one space and turn this rule on.

Examples

ok.md

In

The first planet is [planet mercury][].

[planet mercury]: https://example.com

Out

No messages.

not-ok-consecutive.md

In

[planet␠␠␠␠mercury]: https://example.com

Out

1:1-1:41: Unexpected `4` consecutive spaces in definition label, expected `1` space, remove `3` spaces

not-ok-non-space.md

In

[pla␉net␊mer␍cury]: https://e.com

Out

1:1-3:21: Unexpected non-space whitespace character `\t` in definition label, expected `1` space, replace it
1:1-3:21: Unexpected non-space whitespace character `\n` in definition label, expected `1` space, replace it
1:1-3:21: Unexpected non-space whitespace character `\r` in definition label, expected `1` space, replace it

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-lint-definition-spacing@4, 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