remark-lint-hard-break-spaces

!Buildbadge-build-imagebadge-build-url !Coveragebadge-coverage-imagebadge-coverage-url !Downloadsbadge-downloads-imagebadge-downloads-url !Sizebadge-size-imagebadge-size-url !Sponsorsbadge-funding-sponsors-imagebadge-funding-url !Backersbadge-funding-backers-imagebadge-funding-url !Chatbadge-chat-imagebadge-chat-url
remark-lintgithub-remark-lint rule to warn when more spaces are used than needed for hard breaks.

Contents

• What is this?
• When should I use this?
• Presets
• Install
• Use
• API

unified().use(remarkLintHardBreakSpaces)

• Recommendation
• Examples
• Compatibility
• Contribute
• License

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:
| Preset | Options | | - | - | | remark-preset-lint-markdown-style-guide | | | remark-preset-lint-recommended | |

Install

This package is ESM onlygithub-gist-esm. In Node.js (version 16+), install with npmnpm-install:

npm install remark-lint-hard-break-spaces

In Deno with esm.shesm-sh:

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

In browsers with esm.shesm-sh:

<script type="module">
  import remarkLintHardBreakSpaces from 'https://esm.sh/remark-lint-hard-break-spaces@4?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 TypeScripttypescript types. The default export is remarkLintHardBreakSpacesapi-remark-lint-hard-break-spaces.

unified().use(remarkLintHardBreakSpaces)

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

Parameters

There are no options.

Returns

Transform (Transformer from unifiedgithub-unified-transformer).

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

**Mercury** is the first planet from the Sun␠␠
and the smallest in the Solar System.

Out

No messages.

not-ok.md

In

**Mercury** is the first planet from the Sun␠␠␠
and the smallest in the Solar System.

Out

1:45-2:1: Unexpected `3` spaces for hard break, expected `2` spaces

containers.md

In

👉 Note: this example uses GFM (remark-gfmgithub-remark-gfm).

>   >   and the smallest in the Solar System.

Out

2:57-3:1: Unexpected `3` spaces for hard break, expected `2` spaces

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@4, compatible with Node.js 16.

Contribute

See contributing.mdgithub-dotfiles-contributing in remarkjs/.githubgithub-dotfiles-health for ways to get started. See support.mdgithub-dotfiles-support for ways to get help.
This project has a code of conductgithub-dotfiles-coc. By interacting with this repository, organization, or community you agree to abide by its terms.

License

MITfile-license © Titus Wormerauthor