.. | ||
.npmrc | ||
index.js | ||
package.json | ||
readme.md | ||
tsconfig.json |
remark-lint-table-pipes
remark-lint
rule to warn when GFM table rows have no initial or
final cell delimiter.
Contents
- What is this?
- When should I use this?
- Presets
- Install
- Use
- API
- Recommendation
- Fix
- Examples
- Compatibility
- Contribute
- License
What is this?
This package checks that table rows have initial and final delimiters.
Tables are a GFM feature enabled with 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 only. In Node.js (version 16+), install with npm:
npm install remark-lint-table-pipes
In Deno with esm.sh
:
import remarkLintTablePipes from 'https://esm.sh/remark-lint-table-pipes@4'
In browsers with esm.sh
:
<script type="module">
import remarkLintTablePipes from 'https://esm.sh/remark-lint-table-pipes@4?bundle'
</script>
Use
On the API:
import remarkLint from 'remark-lint'
import remarkLintTablePipes from 'remark-lint-table-pipes'
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(remarkLintTablePipes)
.use(remarkStringify)
.process(file)
console.error(reporter(file))
On the CLI:
remark --frail --use remark-lint --use remark-lint-table-pipes .
On the CLI in a config file (here a package.json
):
…
"remarkConfig": {
"plugins": [
…
"remark-lint",
+ "remark-lint-table-pipes",
…
]
}
…
API
This package exports no identifiers.
It exports no additional TypeScript types.
The default export is
remarkLintTablePipes
.
unified().use(remarkLintTablePipes)
Warn when GFM table rows have no initial or final cell delimiter.
Parameters
There are no options.
Returns
Transform (Transformer
from unified
).
Recommendation
While tables don’t require initial or final delimiters (the pipes before the first and after the last cells in a row), it arguably does look weird without.
Fix
remark-stringify
with
remark-gfm
formats all tables with initial and final
delimiters.
Examples
ok.md
In
👉 Note: this example uses GFM (
remark-gfm
).
| A | B |
| ----- | ----- |
| Alpha | Bravo |
Out
No messages.
not-ok.md
In
👉 Note: this example uses GFM (
remark-gfm
).
A | B
----- | -----
Alpha | Bravo
Out
1:1: Missing initial pipe in table fence
1:10: Missing final pipe in table fence
3:1: Missing initial pipe in table fence
3:14: Missing final pipe in table fence
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-table-pipes@4
,
compatible with Node.js 12.
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.