remark-lint
rule to warn when GFM tables are indented.
- What is this?
- When should I use this?
- Presets
- Install
- Use
- API
- Recommendation
- Fix
- Examples
- Compatibility
- Contribute
- License
This package checks the indent of GFM tables.
Tables are a GFM feature enabled with
remark-gfm
.
You can use this package to check that tables are consistent.
This plugin is included in the following presets:
Preset | Options |
---|---|
remark-preset-lint-markdown-style-guide |
This package is ESM only. In Node.js (version 16+), install with npm:
npm install remark-lint-no-table-indentation
In Deno with esm.sh
:
import remarkLintNoTableIndentation from 'https://esm.sh/remark-lint-no-table-indentation@5'
In browsers with esm.sh
:
<script type="module">
import remarkLintNoTableIndentation from 'https://esm.sh/remark-lint-no-table-indentation@5?bundle'
</script>
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",
…
]
}
…
This package exports no identifiers.
It exports no additional TypeScript types.
The default export is
remarkLintNoTableIndentation
.
Warn when GFM tables are indented.
There are no options.
Transform (Transformer
from unified
).
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.
remark-stringify
with
remark-gfm
formats all tables without indent.
👉 Note: this example uses GFM (
remark-gfm
).
| Planet | Mean anomaly (°) |
| ------- | ---------------: |
| Mercury | 174 796 |
No messages.
👉 Note: this example uses GFM (
remark-gfm
).
␠| Planet | Mean anomaly (°) |
␠␠| ------- | ---------------: |
␠␠␠| Mercury | 174 796 |
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
👉 Note: this example uses GFM (
remark-gfm
).
>␠| Planet |
>␠␠| ------- |
2:4: Unexpected `1` extra space before table row, remove `1` space
👉 Note: this example uses GFM (
remark-gfm
).
*␠| Planet |
␠␠␠| ------- |
2:4: Unexpected `1` extra space before table row, remove `1` space
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.
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.