unified

Project: remarkjs/remark-lint

Package: remark-lint-hard-break-spaces@3.1.1

  1. Dependents: 0
  2. remark-lint rule to warn when too many spaces are used to create a hard break
  1. remark 214
  2. lint 80
  3. rule 75
  4. remark-lint-rule 68
  5. break 4
  6. spaces 2
  7. size 2

remark-lint-hard-break-spaces

Build Coverage Downloads Size Sponsors Backers Chat

remark-lint rule to warn when more spaces are used than needed for hard breaks.

Contents

What is this?

This package checks the whitespace of hard breaks.

When should I use this?

You can use this package to check that the number of spaces in hard breaks are consistent.

Presets

This plugin is included in the following presets:

PresetOptions
remark-preset-lint-markdown-style-guide
remark-preset-lint-recommended

Install

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

npm install remark-lint-hard-break-spaces

In Deno with esm.sh:

import remarkLintHardBreakSpaces from 'https://esm.sh/remark-lint-hard-break-spaces@3'

In browsers with esm.sh:

<script type="module">
  import remarkLintHardBreakSpaces from 'https://esm.sh/remark-lint-hard-break-spaces@3?bundle'
</script>

Use

On the API:

import remarkLint from 'remark-lint'
import remarkLintHardBreakSpaces from 'remark-lint-hard-break-spaces'
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(remarkLintHardBreakSpaces)
  .use(remarkStringify)
  .process(file)

console.error(reporter(file))

On the CLI:

remark --frail --use remark-lint --use remark-lint-hard-break-spaces .

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

 …
 "remarkConfig": {
   "plugins": [
     …
     "remark-lint",
+    "remark-lint-hard-break-spaces",
     …
   ]
 }
 …

API

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

unified().use(remarkLintHardBreakSpaces)

Warn when more spaces are used than needed for hard breaks.

Parameters

There are no options.

Returns

Transform (Transformer from unified).

Recommendation

Less than two spaces do not create a hard breaks and more than two spaces have no effect. Due to this, it’s recommended to turn this rule on.

Examples

ok.md
In
Lorem ipsum␠␠
dolor sit amet
Out

No messages.

not-ok.md
In
Lorem ipsum␠␠␠
dolor sit amet.
Out
1:12-2:1: Use two spaces for hard line breaks

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-hard-break-spaces@3, compatible with Node.js 12.

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