remark-lint-table-pipe-alignment

remark-lint rule to warn when GFM table cells are aligned inconsistently.

Contents

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

What is this?

This package checks table cell dividers are aligned. 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-pipe-alignment

In Deno with esm.sh:

import remarkLintTablePipeAlignment from 'https://esm.sh/remark-lint-table-pipe-alignment@4'

In browsers with esm.sh:

<script type="module">
  import remarkLintTablePipeAlignment from 'https://esm.sh/remark-lint-table-pipe-alignment@4?bundle'
</script>

Use

On the API:

import remarkLint from 'remark-lint'
import remarkLintTablePipeAlignment from 'remark-lint-table-pipe-alignment'
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(remarkLintTablePipeAlignment)
  .use(remarkStringify)
  .process(file)

console.error(reporter(file))

On the CLI:

remark --frail --use remark-lint --use remark-lint-table-pipe-alignment .

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

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

API

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

unified().use(remarkLintTablePipeAlignment)

Warn when GFM table cells are aligned inconsistently.

Parameters

There are no options.

Returns

Transform (Transformer from unified).

Recommendation

While aligning table dividers improves their legibility, it is somewhat hard to maintain manually, especially for tables with many rows.

Fix

remark-stringify with remark-gfm aligns table cell dividers by default. Pass tablePipeAlign: false to use a more compact style.

Aligning perfectly in all cases is not possible because whether characters look aligned or not depends on where the markup is shown. Some characters (such as emoji or Chinese characters) show smaller or bigger in different places. You can pass a stringLength function to remark-gfm, to align better for your use case, in which case this rule must be turned off.

Examples

ok.md

In

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

This rule is only about the alignment of pipes across rows:

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

|Planet|Mean anomaly (°)|
|------|---------------:|
|Venus |         50 115 |

Out

No messages.

not-ok.md

In

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

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

Out

1:10: Unexpected unaligned cell, expected aligned pipes, add `1` space
2:5: Unexpected unaligned cell, expected aligned pipes, add `6` spaces (or add `-` to pad alignment row cells)
2:7: Unexpected unaligned cell, expected aligned pipes, add `14` spaces (or add `-` to pad alignment row cells)
3:13: Unexpected unaligned cell, expected aligned pipes, add `9` spaces

empty.md

In

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

|         | Satellites |     |
| ------- | ---------- | --- |
| Mercury |            |     |

| aaa | bbb | ccc | ddd |
| --- | :-- | :-: | --: |
|     |     |     |     |

Out

No messages.

aligned-pipes-but-weird-content.md

In

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

| Planet | Moon | Mercury | Venus | Sun | Mars | Jupiter | Saturn |
| ------ | ---- | :------ | :---- | --: | ---: | :-----: | :----: |
| Symbol |    ☾ | ☿       |   ♀   | ☉   |   ♂  | ♃       |      ♄ |

Out

No messages.

missing-cells.md

In

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

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

Out

No messages.

alignment.md

In

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

| Planet | Symbol | Satellites | Mean anomaly (°) |
| - | :- | :-: | -: |
| Mercury | ☿ | None | 174 796 |

Out

1:10: Unexpected unaligned cell, expected aligned pipes, add `1` space
2:5: Unexpected unaligned cell, expected aligned pipes, add `6` spaces (or add `-` to pad alignment row cells)
2:10: Unexpected unaligned cell, expected aligned pipes, add `4` spaces (or add `-` to pad alignment row cells)
2:12: Unexpected unaligned cell, expected aligned pipes, add `4` spaces (or add `-` to pad alignment row cells)
2:16: Unexpected unaligned cell, expected aligned pipes, add `3` spaces (or add `-` to pad alignment row cells)
2:18: Unexpected unaligned cell, expected aligned pipes, add `14` spaces (or add `-` to pad alignment row cells)
3:15: Unexpected unaligned cell, expected aligned pipes, add `5` spaces
3:17: Unexpected unaligned cell, expected aligned pipes, add `3` spaces
3:22: Unexpected unaligned cell, expected aligned pipes, add `3` spaces
3:24: Unexpected unaligned cell, expected aligned pipes, add `9` spaces

missing-fences.md

In

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

Planet | Satellites
-: | -
Mercury | ☿

Out

1:1: Unexpected unaligned cell, expected aligned pipes, add `1` space
2:1: Unexpected unaligned cell, expected aligned pipes, add `5` spaces (or add `-` to pad alignment row cells)

trailing-spaces.md

In

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

| Planet |␠␠
| -: |␠

Out

2:3: Unexpected unaligned cell, expected aligned pipes, add `4` spaces (or add `-` to pad alignment row cells)

nothing.md

In

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

||||
|-|-|-|

Out

1:2: Unexpected unaligned cell, expected aligned pipes, add `1` space
1:3: Unexpected unaligned cell, expected aligned pipes, add `1` space
1:4: Unexpected unaligned cell, expected aligned pipes, add `1` space

more-weirdness.md

In

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

Mercury
|-

Venus
-|

Out

5:2: Unexpected unaligned cell, expected aligned pipes, add `4` spaces (or add `-` to pad alignment row cells)

containers.md

In

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

> | Mercury|
> | - |

* | Venus|
  | - |

> * > | Earth|
>   > | - |

Out

2:5: Unexpected unaligned cell, expected aligned pipes, add `5` spaces (or add `-` to pad alignment row cells)
5:5: Unexpected unaligned cell, expected aligned pipes, add `3` spaces (or add `-` to pad alignment row cells)
8:5: Unexpected unaligned cell, expected aligned pipes, add `3` spaces (or add `-` to pad alignment row cells)

windows.md

In

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

| Mercury|␍␊| --- |␍␊| None |

Out

2:7: Unexpected unaligned cell, expected aligned pipes, add `3` spaces (or add `-` to pad alignment row cells)
3:8: Unexpected unaligned cell, expected aligned pipes, add `2` spaces

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-pipe-alignment@4, 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