remark-lint/packages/remark-lint-table-pipe-alignment

remark-lint-table-pipe-alignment

Warn when table pipes are not aligned.

Fix

remark-stringify tries to align tables by default. Pass paddedTable: false to not align cells.

Aligning cells perfectly is impossible as some characters (such as emoji or Chinese characters) are rendered differently in different browsers, terminals, and editors. You can pass your own stringLength function to customize how cells are aligned. In that case, this rule must be turned off.

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

3:9-3:10: Misaligned table fence
3:17-3:18: Misaligned table fence

Install

npm:

npm install remark-lint-table-pipe-alignment

Use

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

 …
 "remarkConfig": {
   "plugins": [
     …
     "lint",
+    "lint-table-pipe-alignment",
     …
   ]
 }
 …

Or use it on the CLI directly

remark -u lint -u lint-table-pipe-alignment 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-pipe-alignment'))
   .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