JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 11348
  • Score
    100M100P100Q160456F
  • License MIT

remark-lint rule to warn when missing blank lines

Package Exports

  • remark-lint-no-missing-blank-lines

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (remark-lint-no-missing-blank-lines) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

remark-lint-no-missing-blank-lines

Warn when missing blank lines before a block node.

This rule can be configured to allow tight list items without blank lines between their contents by passing {exceptTightLists: true} (default: false).

Presets

This rule is not included in any default preset

Example

valid.md
In
# Foo

## Bar

- Paragraph

  + List.

Paragraph.
Out

No messages.

invalid.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

Install

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

Usage

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

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

Or use it on the CLI directly

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

Or use this on the API:

 var remark = require('remark');
 var report = require('vfile-reporter');

 remark()
   .use(require('remark-lint'))
+  .use(require('remark-lint-no-missing-blank-lines'))
   .process('_Emphasis_ and **importance**', function (err, file) {
     console.error(report(err || file));
   });

License

MIT © Titus Wormer