Warn when tables are indented.
Fix
remark-stringify
removes all unneeded indentation before tables.
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:
Example
valid.md
In
Paragraph.
| A | B |
| ----- | ----- |
| Alpha | Bravo |
Out
No messages.
invalid.md
In
Note: ·
represents a space.
Paragraph.
···| A | B |
···| ----- | ----- |
···| Alpha | Bravo |
Out
3:1-3:21: Do not indent table rows
5:1-5:21: Do not indent table rows
Install
npm install remark-lint-no-table-indentation
Usage
You probably want to use it on the CLI through a config file:
...
"remarkConfig": {
"plugins": [
...
"lint",
+ "lint-no-table-indentation",
...
]
}
...
Or use it on the CLI directly
remark -u lint -u lint-no-table-indentation 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-table-indentation'))
.process('_Emphasis_ and **importance**', function (err, file) {
console.error(report(err || file));
});
License
MIT © Titus Wormer