remark-lint-table-pipes

remark-lint rule to warn when GFM table rows have no initial or final cell delimiter.

Contents

• What is this?
• When should I use this?
• Presets
• Install
• Use
• API
  • unified().use(remarkLintTablePipes)
• Recommendation
• Fix
• Examples
• Compatibility
• Contribute
• License

What is this?

This package checks that table rows have initial and final delimiters. Tables are a GFM feature enabled with remark-gfm.

When should I use this?

You can use this package to check that tables are consistent.

Presets

This plugin is included in the following presets:

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

Install

This package is ESM only. In Node.js (version 16+), install with npm:

npm install remark-lint-table-pipes

In Deno with esm.sh:

import remarkLintTablePipes from 'https://esm.sh/remark-lint-table-pipes@5'

In browsers with esm.sh:

<script type="module">
  import remarkLintTablePipes from 'https://esm.sh/remark-lint-table-pipes@5?bundle'
</script>

Use

On the API:

import remarkLint from 'remark-lint'
import remarkLintTablePipes from 'remark-lint-table-pipes'
import remarkParse from 'remark-parse'
import remarkStringify from 'remark-stringify'
import {read} from 'to-vfile'
import {unified} from 'unified'
import {reporter} from 'vfile-reporter'

const file = await read('example.md')

await unified()
  .use(remarkParse)
  .use(remarkLint)
  .use(remarkLintTablePipes)
  .use(remarkStringify)
  .process(file)

console.error(reporter(file))

On the CLI:

remark --frail --use remark-lint --use remark-lint-table-pipes .

On the CLI in a config file (here a package.json):

 …
 "remarkConfig": {
   "plugins": [
     …
     "remark-lint",
+    "remark-lint-table-pipes",
     …
   ]
 }
 …

API

This package exports no identifiers. It exports no additional TypeScript types. The default export is remarkLintTablePipes.

unified().use(remarkLintTablePipes)

Warn when GFM table rows have no initial or final cell delimiter.

Parameters

There are no options.

Returns

Transform (Transformer from unified).

Recommendation

While tables don’t require initial or final delimiters (the pipes before the first and after the last cells in a row), it arguably does look weird without.

Fix

remark-stringify with remark-gfm formats all tables with initial and final delimiters.

Examples

ok.md

In

👉 Note: this example uses GFM (remark-gfm).

Small table:

| Planet | Mean anomaly (°) |
| :- | -: |
| Mercury | 174 796 |

Out

No messages.

not-ok.md

In

👉 Note: this example uses GFM (remark-gfm).

Planet | Mean anomaly (°)
:- | -:
Mercury | 174 796

Out

1:1: Unexpected missing closing pipe in row, expected `|`
1:26: Unexpected missing opening pipe in row, expected `|`
2:1: Unexpected missing closing pipe in row, expected `|`
2:8: Unexpected missing opening pipe in row, expected `|`
3:1: Unexpected missing closing pipe in row, expected `|`
3:18: Unexpected missing opening pipe in row, expected `|`

missing-cells.md

In

👉 Note: this example uses GFM (remark-gfm).

Planet | Symbol | Satellites
:- | - | -
Mercury
Venus | ♀
Earth | ♁ | 1
Mars | ♂ | 2 | 19 412

Out

1:1: Unexpected missing closing pipe in row, expected `|`
1:29: Unexpected missing opening pipe in row, expected `|`
2:1: Unexpected missing closing pipe in row, expected `|`
2:11: Unexpected missing opening pipe in row, expected `|`
3:1: Unexpected missing closing pipe in row, expected `|`
3:8: Unexpected missing opening pipe in row, expected `|`
4:1: Unexpected missing closing pipe in row, expected `|`
4:10: Unexpected missing opening pipe in row, expected `|`
5:1: Unexpected missing closing pipe in row, expected `|`
5:14: Unexpected missing opening pipe in row, expected `|`
6:1: Unexpected missing closing pipe in row, expected `|`
6:22: Unexpected missing opening pipe in row, expected `|`

trailing-spaces.md

In

👉 Note: this example uses GFM (remark-gfm).

␠␠Planet␠␠
␠-:␠

␠␠| Planet |␠␠
␠| -: |␠

Out

1:3: Unexpected missing closing pipe in row, expected `|`
1:11: Unexpected missing opening pipe in row, expected `|`
2:2: Unexpected missing closing pipe in row, expected `|`
2:5: Unexpected missing opening pipe in row, expected `|`

windows.md

In

👉 Note: this example uses GFM (remark-gfm).

Mercury␍␊:-␍␊None

Out

1:1: Unexpected missing closing pipe in row, expected `|`
1:8: Unexpected missing opening pipe in row, expected `|`
2:1: Unexpected missing closing pipe in row, expected `|`
2:3: Unexpected missing opening pipe in row, expected `|`
3:1: Unexpected missing closing pipe in row, expected `|`
3:5: Unexpected missing opening pipe in row, expected `|`

Compatibility

Projects maintained by the unified collective are compatible with maintained versions of Node.js.

When we cut a new major release, we drop support for unmaintained versions of Node. This means we try to keep the current release line, remark-lint-table-pipes@5, compatible with Node.js 16.

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