remark-lint-table-pipe-alignment

remark-lint rule to warn when table pipes are not aligned

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
remark-lint-table-pipe-alignment
905153.1.38 months ago7 years agoMinified + gzip package size for remark-lint-table-pipe-alignment in KB

Readme

remark-lint-table-pipe-alignment
!Buildbuild-badgebuild !Coveragecoverage-badgecoverage !Downloadsdownloads-badgedownloads !Sizesize-badgesize !Sponsorssponsors-badgecollective !Backersbackers-badgecollective !Chatchat-badgechat
remark-lintmono rule to warn when table cells are inconsistently padded.

Contents

*   [`unified().use(remarkLintTablePipeAlignment[, config])`](#unifieduseremarklinttablepipealignment-config)

What is this?

This package is a unified (remark) plugin, specifically a remark-lint rule. Lint rules check markdown code style.

When should I use this?

You can use this package to check that table cell dividers are aligned. Tables are a GFM feature enabled with remark-gfm.

Presets

This rule is included in the following presets:
| Preset | Setting | | - | - | | remark-preset-lint-markdown-style-guide | |

Install

This package is ESM onlyesm. In Node.js (version 12.20+, 14.14+, or 16.0+), install with npm:
npm install remark-lint-table-pipe-alignment

In Deno with esm.shesmsh:
import remarkLintTablePipeAlignment from 'https://esm.sh/remark-lint-table-pipe-alignment@3'

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

Use

On the API:
import {read} from 'to-vfile'
import {reporter} from 'vfile-reporter'
import {remark} from 'remark'
import remarkLint from 'remark-lint'
import remarkLintTablePipeAlignment from 'remark-lint-table-pipe-alignment'

main()

async function main() {
  const file = await remark()
    .use(remarkLint)
    .use(remarkLintTablePipeAlignment)
    .process(await read('example.md'))

  console.error(reporter(file))
}

On the CLI:
remark --use remark-lint --use remark-lint-table-pipe-alignment example.md

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. The default export is remarkLintTablePipeAlignment.

unified().use(remarkLintTablePipeAlignment[, config])

This rule supports standard configuration that all remark lint rules accept (such as false to turn it off or [1, options] to configure it).
There are no options.

Recommendation

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

Fix

remark-gfm aligns table dividers by default. Pass tablePipeAlign: false to use a more compact style.
Aligning characters is impossible because whether they 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 your own stringLength to remark-gfm, in which case this rule must be turned off.

Examples

ok.md
In
👉 Note: this example uses GFM (remark-gfmgfm).

| A     | B     |
| ----- | ----- |
| Alpha | Bravo |
Out
No messages.
not-ok.md
In
👉 Note: this example uses GFM (remark-gfmgfm).

| A | B |
| -- | -- |
| Alpha | Bravo |
Out
3:9-3:10: Misaligned table fence
3:17-3:18: Misaligned table fence
ok-empty-columns.md
In
👉 Note: this example uses GFM (remark-gfmgfm).

| | B     |   |
|-| ----- | - |
| | Bravo |   |
Out
No messages.
ok-empty-cells.md
In
👉 Note: this example uses GFM (remark-gfmgfm).

|   |     |         |
| - | --- | ------- |
| A | Bra | Charlie |
Out
No messages.

Compatibility

Projects maintained by the unified collective are compatible with all maintained versions of Node.js. As of now, that is Node.js 12.20+, 14.14+, and 16.0+. Our projects sometimes work with older versions, but this is not guaranteed.

Contribute

See contributing.mdcontributing in remarkjs/.githubhealth for ways to get started. See support.mdsupport for ways to get help.
This project has a code of conductcoc. By interacting with this repository, organization, or community you agree to abide by its terms.

License

MITlicense © Titus Wormerauthor