unified

Project: remarkjs/remark-lint

Package: remark-lint-table-cell-padding@2.0.1

  1. Dependencies: 4·Dependents: 18
  2. remark-lint rule to warn when table cells are incorrectly padded
  1. remark 182
  2. lint 68
  3. rule 64
  4. remark-lint-rule 63
  5. table 6
  6. cell 2
  7. padding 2

remark-lint-table-cell-padding

Build Coverage Downloads Size Sponsors Backers Chat

Warn when table cells are incorrectly padded.

Options: 'consistent', 'padded', or 'compact', default: 'consistent'.

'consistent' detects the first used cell padding style and warns when subsequent cells use different styles.

Fix

remark-stringify formats tables with padding by default. Pass spacedTable: false to not use padding.

See Using remark to fix your Markdown on how to automatically fix warnings for this rule.

Presets

This rule is included in the following presets:

PresetSetting
remark-preset-lint-consistent'consistent'
remark-preset-lint-markdown-style-guide'padded'

Example

ok.md

When configured with 'padded'.

In
| A     | B     |
| ----- | ----- |
| Alpha | Bravo |
Out

No messages.

not-ok.md

When configured with 'padded'.

In
| A    |    B |
| :----|----: |
| Alpha|Bravo |

| C      |    D |
| :----- | ---: |
|Charlie | Delta|

Too much padding isn’t good either:

| E     | F        |   G    |      H |
| :---- | -------- | :----: | -----: |
| Echo  | Foxtrot  |  Golf  |  Hotel |
Out
3:8: Cell should be padded
3:9: Cell should be padded
7:2: Cell should be padded
7:17: Cell should be padded
13:23: Cell should be padded with 1 space, not 2
13:32: Cell should be padded with 1 space, not 2
empty.md

When configured with 'padded'.

In
<!-- Empty cells are OK, but those surrounding them may not be. -->

|        | Alpha | Bravo|
| ------ | ----- | ---: |
| Charlie|       |  Echo|
Out
3:25: Cell should be padded
5:10: Cell should be padded
5:25: Cell should be padded
missing-body.md

When configured with 'padded'.

In
<!-- Missing cells are fine as well. -->

| Alpha | Bravo   | Charlie |
| ----- | ------- | ------- |
| Delta |
| Echo  | Foxtrot |
Out

No messages.

ok.md

When configured with 'compact'.

In
|A    |B    |
|-----|-----|
|Alpha|Bravo|
Out

No messages.

not-ok.md

When configured with 'compact'.

In
|   A    | B    |
|   -----| -----|
|   Alpha| Bravo|

|C      |     D|
|:------|-----:|
|Charlie|Delta |
Out
3:5: Cell should be compact
3:12: Cell should be compact
7:15: Cell should be compact
ok-padded.md

When configured with 'consistent'.

In
| A     | B     |
| ----- | ----- |
| Alpha | Bravo |

| C       | D     |
| ------- | ----- |
| Charlie | Delta |
Out

No messages.

not-ok-padded.md

When configured with 'consistent'.

In
| A     | B     |
| ----- | ----- |
| Alpha | Bravo |

| C      |     D |
| :----- | ----: |
|Charlie | Delta |
Out
7:2: Cell should be padded
ok-compact.md

When configured with 'consistent'.

In
|A    |B    |
|-----|-----|
|Alpha|Bravo|

|C      |D    |
|-------|-----|
|Charlie|Delta|
Out

No messages.

not-ok-compact.md

When configured with 'consistent'.

In
|A    |B    |
|-----|-----|
|Alpha|Bravo|

|C      |     D|
|:------|-----:|
|Charlie|Delta |
Out
7:15: Cell should be compact
not-ok.md

When configured with '💩'.

Out
1:1: Incorrect table cell padding style `💩`, expected `'padded'`, `'compact'`, or `'consistent'`

Install

npm:

npm install remark-lint-table-cell-padding

Use

You probably want to use it on the CLI through a config file:

 …
 "remarkConfig": {
   "plugins": [
     …
     "lint",
+    "lint-table-cell-padding",
     …
   ]
 }
 …

Or use it on the CLI directly

remark -u lint -u lint-table-cell-padding readme.md

Or use this on the API:

 var remark = require('remark')
 var report = require('vfile-reporter')

 remark()
   .use(require('remark-lint'))
+  .use(require('remark-lint-table-cell-padding'))
   .process('_Emphasis_ and **importance**', function (err, file) {
     console.error(report(err || file))
   })

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