mirror of
https://github.com/remarkjs/remark-lint.git
synced 2024-10-27 11:47:47 +03:00
| .. | ||
| index.js | ||
| package.json | ||
| readme.md | ||
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).
Fix
remark-stringify
always uses one blank line between blocks if possible, or two lines when
needed. The style of the list-items persists.
See Using remark to fix your markdown on how to automatically fix warnings for this rule.
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));
});