remark-lint
rule to warn when more spaces are used than needed
for hard breaks.
- What is this?
- When should I use this?
- Presets
- Install
- Use
- API
- Recommendation
- Examples
- Compatibility
- Contribute
- License
This package checks the whitespace of hard breaks.
You can use this package to check that the number of spaces in hard breaks are consistent.
This plugin is included in the following presets:
Preset | Options |
---|---|
remark-preset-lint-markdown-style-guide |
|
remark-preset-lint-recommended |
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@4'
In browsers with esm.sh
:
<script type="module">
import remarkLintHardBreakSpaces from 'https://esm.sh/remark-lint-hard-break-spaces@4?bundle'
</script>
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",
…
]
}
…
This package exports no identifiers.
It exports no additional TypeScript types.
The default export is
remarkLintHardBreakSpaces
.
Warn when more spaces are used than needed for hard breaks.
There are no options.
Transform (Transformer
from unified
).
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.
**Mercury** is the first planet from the Sun␠␠
and the smallest in the Solar System.
No messages.
**Mercury** is the first planet from the Sun␠␠␠
and the smallest in the Solar System.
1:45-2:1: Unexpected `3` spaces for hard break, expected `2` spaces
👉 Note: this example uses GFM (
remark-gfm
).
[^mercury]:
> * > * **Mercury** is the first planet from the Sun␠␠␠
> > and the smallest in the Solar System.
2:57-3:1: Unexpected `3` spaces for hard break, expected `2` spaces
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.
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.