remark-lint-no-table-indentation

!Buildbadge-build-imagebadge-build-url !Coveragebadge-coverage-imagebadge-coverage-url !Downloadsbadge-downloads-imagebadge-downloads-url !Sizebadge-size-imagebadge-size-url !Sponsorsbadge-funding-sponsors-imagebadge-funding-url !Backersbadge-funding-backers-imagebadge-funding-url !Chatbadge-chat-imagebadge-chat-url
remark-lintgithub-remark-lint rule to warn when GFM tables are indented.

Contents

• What is this?
• When should I use this?
• Presets
• Install
• Use
• API

unified().use(remarkLintNoTableIndentation)

• Recommendation
• Fix
• Examples
• Compatibility
• Contribute
• License

What is this?

This package checks the indent of GFM tables. Tables are a GFM feature enabled with remark-gfmgithub-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 onlygithub-gist-esm. In Node.js (version 16+), install with npmnpm-install:

npm install remark-lint-no-table-indentation

In Deno with esm.shesm-sh:

import remarkLintNoTableIndentation from 'https://esm.sh/remark-lint-no-table-indentation@5'

In browsers with esm.shesm-sh:

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

Use

On the API:

import remarkLint from 'remark-lint'
import remarkLintNoTableIndentation from 'remark-lint-no-table-indentation'
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(remarkLintNoTableIndentation)
  .use(remarkStringify)
  .process(file)

console.error(reporter(file))

On the CLI:

remark --frail --use remark-lint --use remark-lint-no-table-indentation .

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

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

API

This package exports no identifiers. It exports no additional TypeScripttypescript types. The default export is remarkLintNoTableIndentationapi-remark-lint-no-table-indentation.

unified().use(remarkLintNoTableIndentation)

Warn when GFM tables are indented.

Parameters

There are no options.

Returns

Transform (Transformer from unifiedgithub-unified-transformer).

Recommendation

There is no specific handling of indented tables (or anything else) in markdown. So it’s recommended to not indent tables and to turn this rule on.

Fix

remark-stringifygithub-remark-stringify with remark-gfmgithub-remark-gfm formats all tables without indent.

Examples

ok.md

In

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

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

Out

No messages.

not-ok.md

In

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

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

Out

1:2: Unexpected `1` extra space before table row, remove `1` space
2:3: Unexpected `2` extra spaces before table row, remove `2` spaces
3:4: Unexpected `3` extra spaces before table row, remove `3` spaces

blockquote.md

In

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

>␠| Planet  |
>␠␠| ------- |

Out

2:4: Unexpected `1` extra space before table row, remove `1` space

list.md

In

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

*␠| Planet  |
␠␠␠| ------- |

Out

2:4: Unexpected `1` extra space before table row, remove `1` space

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-no-table-indentation@5, compatible with Node.js 16.

Contribute

See contributing.mdgithub-dotfiles-contributing in remarkjs/.githubgithub-dotfiles-health for ways to get started. See support.mdgithub-dotfiles-support for ways to get help.
This project has a code of conductgithub-dotfiles-coc. By interacting with this repository, organization, or community you agree to abide by its terms.

License

MITfile-license © Titus Wormerauthor