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-table-pipes
Warn when table rows are not fenced with pipes.
Fix
remark-stringify
creates fenced rows with initial and final pipes by default.
Pass
looseTable: true
to not use row fences.
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
| A | B |
| ----- | ----- |
| Alpha | Bravo |
Out
No messages.
not-ok.md
In
A | B
----- | -----
Alpha | Bravo
Out
1:1: Missing initial pipe in table fence
1:10: Missing final pipe in table fence
3:1: Missing initial pipe in table fence
3:14: Missing final pipe in table fence
Install
npm:
npm install remark-lint-table-pipes
Use
You probably want to use it on the CLI through a config file:
…
"remarkConfig": {
"plugins": [
…
"lint",
+ "lint-table-pipes",
…
]
}
…
Or use it on the CLI directly
remark -u lint -u lint-table-pipes 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-table-pipes'))
.process('_Emphasis_ and **importance**', function (err, file) {
console.error(report(err || 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.