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 214
  2. lint 80
  3. rule 75
  4. remark-lint-rule 68
  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 there are no blank lines between blocks.

Contents

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@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 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 there are no blank lines between blocks.

Parameters
Returns

Transform (Transformer from unified).

Options

Configuration (TypeScript type).

Fields

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
# 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 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@3, compatible with Node.js 12.

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