unified

Project: remarkjs/remark-lint

Package: remark-lint-no-missing-blank-lines@3.1.1

  1. Dependents: 0
  2. remark-lint rule to warn when missing blank lines
  1. remark 205
  2. lint 77
  3. rule 72
  4. remark-lint-rule 65
  5. line 3
  6. blank 2

remark-lint-no-missing-blank-lines

Build Coverage Downloads Size Sponsors Backers Chat

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

Contents

What is this?

This package is a unified (remark) plugin, specifically a remark-lint rule. Lint rules check markdown code style.

When should I use this?

You can use this package to check that blank lines are used between blocks.

Presets

This rule is not included in a preset maintained here.

Install

This package is ESM only. In Node.js (version 12.20+, 14.14+, or 16.0+), 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@3'

In browsers with esm.sh:

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

Use

On the API:

import {read} from 'to-vfile'
import {reporter} from 'vfile-reporter'
import {remark} from 'remark'
import remarkLint from 'remark-lint'
import remarkLintNoMissingBlankLines from 'remark-lint-no-missing-blank-lines'

main()

async function main() {
  const file = await remark()
    .use(remarkLint)
    .use(remarkLintNoMissingBlankLines)
    .process(await read('example.md'))

  console.error(reporter(file))
}

On the CLI:

remark --use remark-lint --use remark-lint-no-missing-blank-lines example.md

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. The default export is remarkLintNoMissingBlankLines.

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

This rule supports standard configuration that all remark lint rules accept (such as false to turn it off or [1, options] to configure it).

The following options (default: undefined) are accepted:

Recommendation

While not always required, blank lines are required in certain, sometimes confusing, cases. Due to this, 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
# Foo

## Bar

- Paragraph

  + List.

Paragraph.
Out

No messages.

not-ok.md
In
# Foo
## Bar

- Paragraph
  + List.

Paragraph.
Out
2:1-2:7: Missing blank line before block node
5:3-5:10: Missing blank line before block node
tight.md

When configured with { exceptTightLists: true }.

In
# Foo
## Bar

- Paragraph
  + List.

Paragraph.
Out
2:1-2:7: Missing blank line before block node

Compatibility

Projects maintained by the unified collective are compatible with all maintained versions of Node.js. As of now, that is Node.js 12.20+, 14.14+, and 16.0+. Our projects sometimes work with older versions, but this is not guaranteed.

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