remark-lint-no-consecutive-blank-lines

remark-lint-no-consecutive-blank-lines

Warn for too many consecutive blank lines. Knows about the extra line needed between a list and indented code, and two lists.

Fix

remark-stringify always uses one blank line between blocks if possible, or two lines when needed.

See Using remark to fix your Markdown on how to automatically fix warnings for this rule.

Presets

This rule is included in the following presets:

Preset	Setting
remark-preset-lint-markdown-style-guide

Example

ok.md

In

Note: ␊ represents a line feed.

Foo…
␊
…Bar.

Out

No messages.

empty-document.md

Out

No messages.

not-ok.md

In

Note: ␊ represents a line feed.

Foo…
␊
␊
…Bar
␊
␊

Out

4:1: Remove 1 line before node
4:5: Remove 2 lines after node

Install

This package is ESM only: Node 12+ is needed to use it and it must be importeded instead of requiredd.

npm:

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

This package exports no identifiers. The default export is remarkLintNoConsecutiveBlankLines.

Use

You probably want to use it on the CLI through a config file:

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

Or use it on the CLI directly

remark -u lint -u lint-no-consecutive-blank-lines readme.md

Or use this on the API:

 import {remark} from 'remark'
 import {reporter} from 'vfile-reporter'
 import remarkLint from 'remark-lint'
 import remarkLintNoConsecutiveBlankLines from 'remark-lint-no-consecutive-blank-lines'

 remark()
   .use(remarkLint)
+  .use(remarkLintNoConsecutiveBlankLines)
   .process('_Emphasis_ and **importance**')
   .then((file) => {
     console.error(reporter(file))
   })

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