remark-lint-table-cell-padding
Advanced tools
remark-lint rule to warn when table cells are incorrectly padded
remark-lint rule to warn when GFM table cells are padded inconsistently.
This package checks table cell padding.
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-consistent | 'consistent' |
remark-preset-lint-markdown-style-guide | 'padded' |
This package is ESM only. In Node.js (version 16+), install with npm:
npm install remark-lint-table-cell-padding
In Deno with esm.sh:
import remarkLintTableCellPadding from 'https://esm.sh/remark-lint-table-cell-padding@5'
In browsers with esm.sh:
<script type="module">
import remarkLintTableCellPadding from 'https://esm.sh/remark-lint-table-cell-padding@5?bundle'
</script>
On the API:
import remarkLint from 'remark-lint'
import remarkLintTableCellPadding from 'remark-lint-table-cell-padding'
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(remarkLintTableCellPadding)
.use(remarkStringify)
.process(file)
console.error(reporter(file))
On the CLI:
remark --frail --use remark-lint --use remark-lint-table-cell-padding .
On the CLI in a config file (here a package.json):
…
"remarkConfig": {
"plugins": [
…
"remark-lint",
+ "remark-lint-table-cell-padding",
…
]
}
…
This package exports no identifiers.
It exports the TypeScript types
Options and
Style.
The default export is
remarkLintTableCellPadding.
unified().use(remarkLintTableCellPadding[, options])Warn when GFM table cells are padded inconsistently.
Transform (Transformer from unified).
OptionsConfiguration (TypeScript type).
stringLength ((value: string) => number, optional)
— function to detect cell sizestyle (Style or 'consistent', optional)
— preferred style or whether to detect the first styleStyleStyle (TypeScript type).
'compact'
— prefer zero spaces between pipes and content'padded'
— prefer at least one space between pipes and contenttype Style = 'compact' | 'padded'
It’s recommended to use at least one space between pipes and content for
legibility of the markup ('padded').
remark-stringify with
remark-gfm formats all table cells as padded by
default.
Pass tableCellPadding: 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 configured with the same stringLength.
ok.mdWhen configured with 'padded'.
👉 Note: this example uses GFM (
remark-gfm).
| Planet | Symbol | Satellites | Mean anomaly (°) |
| ------- | :----- | :--------: | ---------------: |
| Mercury | ☿ | None | 174 796 |
| Planet | Symbol | Satellites | Mean anomaly (°) |
| - | :- | :-: | -: |
| Venus | ♀ | None | 50 115 |
No messages.
not-ok.mdWhen configured with 'padded'.
👉 Note: this example uses GFM (
remark-gfm).
| Planet |
| -------|
| Mercury|
|Planet |
|------ |
|Venus |
| Planet |
| ------ |
| Venus |
2:10: Unexpected `0` spaces between cell content and edge, expected `1` space, add `1` space
3:10: Unexpected `0` spaces between cell content and edge, expected `1` space, add `1` space
5:2: Unexpected `0` spaces between cell edge and content, expected `1` space, add `1` space
6:2: Unexpected `0` spaces between cell edge and content, expected `1` space, add `1` space
7:2: Unexpected `0` spaces between cell edge and content, expected `1` space, add `1` space
9:4: Unexpected `2` spaces between cell edge and content, expected `1` space, remove `1` space
9:12: Unexpected `2` spaces between cell content and edge, expected `1` space, remove `1` space
10:4: Unexpected `2` spaces between cell edge and content, expected `1` space, remove `1` space
10:12: Unexpected `2` spaces between cell content and edge, expected `1` space, remove `1` space
11:4: Unexpected `2` spaces between cell edge and content, expected `1` space, remove `1` space
11:12: Unexpected `3` spaces between cell content and edge, expected between `1` (unaligned) and `2` (aligned) spaces, remove between `1` and `2` spaces
ok.mdWhen configured with 'compact'.
👉 Note: this example uses GFM (
remark-gfm).
|Planet |Symbol|Satellites|Mean anomaly (°)|
|-------|:-----|:--------:|---------------:|
|Mercury|☿ | None | 174 796|
|Planet|Symbol|Satellites|Mean anomaly (°)|
|-|:-|:-:|-:|
|Venus|♀|None|50 115|
No messages.
not-ok.mdWhen configured with 'compact'.
👉 Note: this example uses GFM (
remark-gfm).
| Planet |
| -------|
| Mercury|
|Planet |
|------ |
|Venus |
| Planet |
| ------ |
| Venus |
1:3: Unexpected `1` space between cell edge and content, expected `0` spaces, remove `1` space
2:3: Unexpected `1` space between cell edge and content, expected `0` spaces, remove `1` space
3:3: Unexpected `1` space between cell edge and content, expected `0` spaces, remove `1` space
5:9: Unexpected `1` space between cell content and edge, expected `0` spaces, remove `1` space
6:9: Unexpected `1` space between cell content and edge, expected `0` spaces, remove `1` space
7:9: Unexpected `2` spaces between cell content and edge, expected between `0` (unaligned) and `1` (aligned) space, remove between `1` and `2` spaces
9:4: Unexpected `2` spaces between cell edge and content, expected `0` spaces, remove `2` spaces
9:12: Unexpected `2` spaces between cell content and edge, expected `0` spaces, remove `2` spaces
10:4: Unexpected `2` spaces between cell edge and content, expected `0` spaces, remove `2` spaces
10:12: Unexpected `2` spaces between cell content and edge, expected `0` spaces, remove `2` spaces
11:4: Unexpected `2` spaces between cell edge and content, expected `0` spaces, remove `2` spaces
11:12: Unexpected `3` spaces between cell content and edge, expected between `0` (unaligned) and `1` (aligned) space, remove between `2` and `3` spaces
consistent-padded-ok.md👉 Note: this example uses GFM (
remark-gfm).
| Planet |
| - |
No messages.
consistent-padded-nok.md👉 Note: this example uses GFM (
remark-gfm).
| Planet|
| - |
1:9: Unexpected `0` spaces between cell content and edge, expected `1` space, add `1` space
consistent-compact-ok.md👉 Note: this example uses GFM (
remark-gfm).
|Planet|
|-|
No messages.
consistent-compact-nok.md👉 Note: this example uses GFM (
remark-gfm).
|Planet |
|-|
1:9: Unexpected `1` space between cell content and edge, expected `0` spaces, remove `1` space
empty.md👉 Note: this example uses GFM (
remark-gfm).
| | Satellites |
| - | - |
| Mercury | |
No messages.
string-length-default.mdWhen configured with 'compact'.
👉 Note: this example uses GFM (
remark-gfm).
|Alpha|Bravo |
|-----|-------|
|冥王星 |Charlie|
|🪐 |Delta |
No messages.
string-length-custom.mdWhen configured with { style: 'compact', stringLength: [Function: stringWidth] }.
👉 Note: this example uses GFM (
remark-gfm).
|Alpha|Bravo |
|-----|-------|
|冥王星|Charlie|
|🪐 |Delta |
No messages.
missing-cells.md👉 Note: this example uses GFM (
remark-gfm).
| Planet | Symbol | Satellites |
| - | - | - |
| Mercury |
| Venus | ♀ |
| Earth | 🜨 and ♁ | 1 |
| Mars | ♂ | 2 | 19 412 |
No messages.
missing-fences.mdWhen configured with 'padded'.
👉 Note: this example uses GFM (
remark-gfm).
␠Planet|Symbol|Satellites
------:|:-----|----------
Mercury|☿ |0
Planet|Symbol
-----:|------
␠Venus|♀
1:8: Unexpected `0` spaces between cell content and edge, expected `1` space, add `1` space
1:9: Unexpected `0` spaces between cell edge and content, expected `1` space, add `1` space
1:15: Unexpected `0` spaces between cell content and edge, expected `1` space, add `1` space
1:16: Unexpected `0` spaces between cell edge and content, expected `1` space, add `1` space
2:8: Unexpected `0` spaces between cell content and edge, expected `1` space, add `1` space
2:9: Unexpected `0` spaces between cell edge and content, expected `1` space, add `1` space
2:15: Unexpected `0` spaces between cell content and edge, expected `1` space, add `1` space
2:16: Unexpected `0` spaces between cell edge and content, expected `1` space, add `1` space
3:8: Unexpected `0` spaces between cell content and edge, expected `1` space, add `1` space
3:9: Unexpected `0` spaces between cell edge and content, expected `1` space, add `1` space
3:16: Unexpected `0` spaces between cell edge and content, expected `1` space, add `1` space
5:7: Unexpected `0` spaces between cell content and edge, expected `1` space, add `1` space
5:8: Unexpected `0` spaces between cell edge and content, expected `1` space, add `1` space
6:7: Unexpected `0` spaces between cell content and edge, expected `1` space, add `1` space
6:8: Unexpected `0` spaces between cell edge and content, expected `1` space, add `1` space
7:7: Unexpected `0` spaces between cell content and edge, expected `1` space, add `1` space
7:8: Unexpected `0` spaces between cell edge and content, expected `1` space, add `1` space
missing-fences.mdWhen configured with 'compact'.
👉 Note: this example uses GFM (
remark-gfm).
Planet | Symbol | Satellites
-: | - | -
Mercury | ☿ | 0
Planet | Symbol
-----: | ------
␠Venus | ♀
1:8: Unexpected `1` space between cell content and edge, expected `0` spaces, remove `1` space
1:10: Unexpected `1` space between cell edge and content, expected `0` spaces, remove `1` space
1:17: Unexpected `1` space between cell content and edge, expected `0` spaces, remove `1` space
1:19: Unexpected `1` space between cell edge and content, expected `0` spaces, remove `1` space
2:4: Unexpected `1` space between cell content and edge, expected `0` spaces, remove `1` space
2:6: Unexpected `1` space between cell edge and content, expected `0` spaces, remove `1` space
2:10: Unexpected `1` space between cell edge and content, expected `0` spaces, remove `1` space
3:9: Unexpected `1` space between cell content and edge, expected `0` spaces, remove `1` space
3:11: Unexpected `1` space between cell edge and content, expected `0` spaces, remove `1` space
3:15: Unexpected `1` space between cell edge and content, expected `0` spaces, remove `1` space
5:8: Unexpected `1` space between cell content and edge, expected `0` spaces, remove `1` space
5:10: Unexpected `1` space between cell edge and content, expected `0` spaces, remove `1` space
6:8: Unexpected `1` space between cell content and edge, expected `0` spaces, remove `1` space
6:10: Unexpected `1` space between cell edge and content, expected `0` spaces, remove `1` space
7:8: Unexpected `1` space between cell content and edge, expected `0` spaces, remove `1` space
7:10: Unexpected `1` space between cell edge and content, expected `0` spaces, remove `1` space
trailing-spaces.mdWhen configured with 'compact'.
👉 Note: this example uses GFM (
remark-gfm).
Planet | Symbol␠
-: | -␠
Mercury | ☿␠␠
| Planet | Symbol |␠
| ------ | ------ |␠
| Venus | ♀ |␠␠
1:8: Unexpected `1` space between cell content and edge, expected `0` spaces, remove `1` space
1:10: Unexpected `1` space between cell edge and content, expected `0` spaces, remove `1` space
2:4: Unexpected `1` space between cell content and edge, expected `0` spaces, remove `1` space
2:6: Unexpected `1` space between cell edge and content, expected `0` spaces, remove `1` space
3:9: Unexpected `1` space between cell content and edge, expected `0` spaces, remove `1` space
3:11: Unexpected `1` space between cell edge and content, expected `0` spaces, remove `1` space
5:3: Unexpected `1` space between cell edge and content, expected `0` spaces, remove `1` space
5:10: Unexpected `1` space between cell content and edge, expected `0` spaces, remove `1` space
5:12: Unexpected `1` space between cell edge and content, expected `0` spaces, remove `1` space
5:19: Unexpected `1` space between cell content and edge, expected `0` spaces, remove `1` space
6:3: Unexpected `1` space between cell edge and content, expected `0` spaces, remove `1` space
6:10: Unexpected `1` space between cell content and edge, expected `0` spaces, remove `1` space
6:12: Unexpected `1` space between cell edge and content, expected `0` spaces, remove `1` space
6:19: Unexpected `1` space between cell content and edge, expected `0` spaces, remove `1` space
7:3: Unexpected `1` space between cell edge and content, expected `0` spaces, remove `1` space
7:10: Unexpected `2` spaces between cell content and edge, expected between `0` (unaligned) and `1` (aligned) space, remove between `1` and `2` spaces
7:12: Unexpected `1` space between cell edge and content, expected `0` spaces, remove `1` space
7:19: Unexpected `6` spaces between cell content and edge, expected between `0` (unaligned) and `5` (aligned) spaces, remove between `1` and `6` spaces
nothing.mdWhen configured with 'compact'.
👉 Note: this example uses GFM (
remark-gfm).
| | | |
| - | - | - |
| | | |
1:5: Unexpected `3` spaces between cell edge and content, expected between `0` (unaligned) and `1` (aligned) space, remove between `2` and `3` spaces
1:9: Unexpected `3` spaces between cell edge and content, expected between `0` (unaligned) and `1` (aligned) space, remove between `2` and `3` spaces
1:13: Unexpected `3` spaces between cell edge and content, expected between `0` (unaligned) and `1` (aligned) space, remove between `2` and `3` spaces
2:3: Unexpected `1` space between cell edge and content, expected `0` spaces, remove `1` space
2:5: Unexpected `1` space between cell content and edge, expected `0` spaces, remove `1` space
2:7: Unexpected `1` space between cell edge and content, expected `0` spaces, remove `1` space
2:9: Unexpected `1` space between cell content and edge, expected `0` spaces, remove `1` space
2:11: Unexpected `1` space between cell edge and content, expected `0` spaces, remove `1` space
2:13: Unexpected `1` space between cell content and edge, expected `0` spaces, remove `1` space
3:5: Unexpected `3` spaces between cell edge and content, expected between `0` (unaligned) and `1` (aligned) space, remove between `2` and `3` spaces
3:9: Unexpected `3` spaces between cell edge and content, expected between `0` (unaligned) and `1` (aligned) space, remove between `2` and `3` spaces
3:13: Unexpected `3` spaces between cell edge and content, expected between `0` (unaligned) and `1` (aligned) space, remove between `2` and `3` spaces
nothing.mdWhen configured with 'padded'.
👉 Note: this example uses GFM (
remark-gfm).
||||
|-|-|-|
||||
1:2: Unexpected `0` spaces between cell edge and content, expected between `1` (unaligned) and `3` (aligned) spaces, add between `3` and `1` space
1:3: Unexpected `0` spaces between cell edge and content, expected between `1` (unaligned) and `3` (aligned) spaces, add between `3` and `1` space
1:4: Unexpected `0` spaces between cell edge and content, expected between `1` (unaligned) and `3` (aligned) spaces, add between `3` and `1` space
2:2: Unexpected `0` spaces between cell edge and content, expected `1` space, add `1` space
2:3: Unexpected `0` spaces between cell content and edge, expected `1` space, add `1` space
2:4: Unexpected `0` spaces between cell edge and content, expected `1` space, add `1` space
2:5: Unexpected `0` spaces between cell content and edge, expected `1` space, add `1` space
2:6: Unexpected `0` spaces between cell edge and content, expected `1` space, add `1` space
2:7: Unexpected `0` spaces between cell content and edge, expected `1` space, add `1` space
3:2: Unexpected `0` spaces between cell edge and content, expected between `1` (unaligned) and `3` (aligned) spaces, add between `3` and `1` space
3:3: Unexpected `0` spaces between cell edge and content, expected between `1` (unaligned) and `3` (aligned) spaces, add between `3` and `1` space
3:4: Unexpected `0` spaces between cell edge and content, expected between `1` (unaligned) and `3` (aligned) spaces, add between `3` and `1` space
more-weirdness.mdWhen configured with 'padded'.
👉 Note: this example uses GFM (
remark-gfm).
Mercury
|-
Venus
-|
2:2: Unexpected `0` spaces between cell edge and content, expected `1` space, add `1` space
5:2: Unexpected `0` spaces between cell content and edge, expected between `1` (unaligned) and `5` (aligned) spaces, add between `5` and `1` space
containers.mdWhen configured with 'padded'.
👉 Note: this example uses GFM (
remark-gfm).
> | Mercury|
> | - |
* | Venus|
| - |
> * > | Earth|
> > | - |
1:12: Unexpected `0` spaces between cell content and edge, expected `1` space, add `1` space
4:10: Unexpected `0` spaces between cell content and edge, expected `1` space, add `1` space
7:14: Unexpected `0` spaces between cell content and edge, expected `1` space, add `1` space
windows.mdWhen configured with 'padded'.
👉 Note: this example uses GFM (
remark-gfm).
| Mercury|␍␊| --- |␍␊| None |
1:10: Unexpected `0` spaces between cell content and edge, expected `1` space, add `1` space
not-ok.mdWhen configured with '🌍'.
1:1: Unexpected value `🌍` for `style`, expected `'compact'`, `'padded'`, or `'consistent'`
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-cell-padding@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.
FAQs
remark-lint rule to warn when table cells are incorrectly padded
The npm package remark-lint-table-cell-padding receives a total of 102,403 weekly downloads. As such, remark-lint-table-cell-padding popularity was classified as popular.
We found that remark-lint-table-cell-padding demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 3 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
The EU Cyber Resilience Act is prompting compliance requests that open source maintainers may not be obligated or equipped to handle.
Security News
Crates.io adds Trusted Publishing support, enabling secure GitHub Actions-based crate releases without long-lived API tokens.
Research
/Security News
Undocumented protestware found in 28 npm packages disrupts UI for Russian-language users visiting Russian and Belarusian domains.