Package Exports

remark-lint-table-pipe-alignment

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (remark-lint-table-pipe-alignment) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

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

Note: this example uses GFM.

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

Out

No messages.

`not-ok.md`

In

Note: this example uses GFM.

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

Out

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

Install

This package is ESM only: Node 12+ is needed to use it and it must be importeded instead of requiredd.

npm:

npm install remark-lint-table-pipe-alignment

This package exports no identifiers. The default export is remarkLintTablePipeAlignment.

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:

 import {remark} from 'remark'
 import {reporter} from 'vfile-reporter'
 import remarkLint from 'remark-lint'
 import remarkLintTablePipeAlignment from 'remark-lint-table-pipe-alignment'

 remark()
   .use(remarkLint)
+  .use(remarkLintTablePipeAlignment)
   .process('_Emphasis_ and **importance**')
   .then((file) => {
     console.error(reporter(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.