remark-lint/packages/remark-lint-no-table-indentation

remark-lint-no-table-indentation

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:

Preset	Setting
remark-preset-lint-markdown-style-guide

Example

ok.md

In

Paragraph.

| A     | B     |
| ----- | ----- |
| Alpha | Bravo |

Out

No messages.

not-ok.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:

npm install remark-lint-no-table-indentation

Use

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))
   })

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