remark-lint-no-missing-blank-lines

remark-lint-no-missing-blank-lines

remark-lint rule to warn when blank lines are missing.

Contents

• What is this?
• When should I use this?
• Presets
• Install
• Use
• API
  • unified().use(remarkLintNoMissingBlankLines[, options])
  • Options
• Recommendation
• Fix
• Examples
• Compatibility
• Contribute
• License

What is this?

This package checks missing blank lines.

When should I use this?

You can use this package to check blank lines.

Presets

This plugin is not included in presets maintained here.

Install

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

npm install remark-lint-no-missing-blank-lines

In Deno with esm.sh:

import remarkLintNoMissingBlankLines from 'https://esm.sh/remark-lint-no-missing-blank-lines@4'

In browsers with esm.sh:

<script type="module">
  import remarkLintNoMissingBlankLines from 'https://esm.sh/remark-lint-no-missing-blank-lines@4?bundle'
</script>

Use

On the API:

import remarkLint from 'remark-lint'
import remarkLintNoMissingBlankLines from 'remark-lint-no-missing-blank-lines'
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(remarkLintNoMissingBlankLines)
  .use(remarkStringify)
  .process(file)

console.error(reporter(file))

On the CLI:

remark --frail --use remark-lint --use remark-lint-no-missing-blank-lines .

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

 …
 "remarkConfig": {
   "plugins": [
     …
     "remark-lint",
+    "remark-lint-no-missing-blank-lines",
     …
   ]
 }
 …

API

This package exports no identifiers. It exports the TypeScript type Options. The default export is remarkLintNoMissingBlankLines.

unified().use(remarkLintNoMissingBlankLines[, options])

Warn when blank lines are missing.

Parameters

• options (Options, optional) — configuration

Returns

Transform (Transformer from unified).

Options

Configuration (TypeScript type).

Fields

• exceptTightLists (boolean, default: false) — allow omitting blank lines in list items

Recommendation

Blank lines are required in certain sometimes confusing cases. So it’s recommended to always use blank lines between blocks.

Fix

remark-stringify always uses blank lines between blocks. It has a join function to customize such behavior.

Examples

ok.md

In

# Mercury

## Venus

* Earth.

  * Mars.

> # Jupiter
>
> Saturn.

Out

No messages.

not-ok.md

In

# Mercury
## Venus

* Earth
  * Mars.

> # Jupiter
> Saturn.

Out

2:1-2:9: Unexpected `0` blank lines between nodes, expected `1` or more blank lines, add `1` blank line
5:3-5:10: Unexpected `0` blank lines between nodes, expected `1` or more blank lines, add `1` blank line
8:3-8:10: Unexpected `0` blank lines between nodes, expected `1` or more blank lines, add `1` blank line

tight.md

When configured with { exceptTightLists: true }.

In

* Venus.

  * Mars.

Out

No messages.

containers.md

In

> # Venus
>
> Mercury.

- earth.
- mars.

* # Jupiter
  Saturn.

Out

9:3-9:10: Unexpected `0` blank lines between nodes, expected `1` or more blank lines, add `1` blank line

gfm.md

In

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

| Planet  | Diameter |
| ------- | -------- |
| Mercury | 4 880 km |

[^Mercury]:
    **Mercury** is the first planet from the Sun and the smallest
    in the Solar System.
[^Venus]:
    **Venus** is the second planet from the Sun.

Out

8:1-9:49: Unexpected `0` blank lines between nodes, expected `1` or more blank lines, add `1` blank line

mdx.mdx

In

👉 Note: this example uses MDX (remark-mdx).

<Tip kind="info">
  # Venus
  Mars.
</Tip>
{Math.PI}

Out

3:3-3:8: Unexpected `0` blank lines between nodes, expected `1` or more blank lines, add `1` blank line
5:1-5:10: Unexpected `0` blank lines between nodes, expected `1` or more blank lines, add `1` blank line

math.md

In

👉 Note: this example uses math (remark-math).

$$
\frac{1}{2}
$$
$$
\frac{2}{3}
$$

Out

4:1-6:3: Unexpected `0` blank lines between nodes, expected `1` or more blank lines, add `1` blank line

directive.md

In

👉 Note: this example uses directives (remark-directive).

Directives are also checked.

::video{#mercury}
:::planet
Venus.
:::

Out

4:1-6:4: Unexpected `0` blank lines between nodes, expected `1` or more blank lines, add `1` blank line

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-no-missing-blank-lines@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