remark-lint-no-hidden-table-cell

remark-lint rule to warn for superfluous table cells.

What is this?

This package checks that all table cells are rendered.

When should I use this?

You can use this package to check that table cells are rendered.

Presets

This plugin is not included in presets maintained here.

Install

This package is ESM only. In Node.js (version 16+), install with npm:

npm install remark-lint-no-hidden-table-cell

In Deno with esm.sh:

import remarkLintNoHiddenTableCell from 'https://esm.sh/remark-lint-no-hidden-table-cell@1'

In browsers with esm.sh:

<script type="module">
  import remarkLintNoHiddenTableCell from 'https://esm.sh/remark-lint-no-hidden-table-cell@1?bundle'
</script>

Use

On the API:

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

console.error(reporter(file))

On the CLI:

remark --frail --use remark-lint --use remark-lint-no-hidden-table-cell .

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

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

API

This package exports no identifiers. It exports no additional TypeScript types. The default export is remarkLintNoHiddenTableCell.

`unified().use(remarkLintNoHiddenTableCell)`

Warn for superfluous table cells.

Parameters

There are no parameters.

Returns

Transform (Transformer from unified).

Examples

`ok.md`

In

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

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

Out

No messages.

`not-ok.md`

In

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

| Planet | Symbol | Satellites |
| :- | - | - |
| Venus | ♀ |
| Earth | ♁ | 1 |
| Mars | ♂ | 2 | 19 412 |

Out

5:16-5:26: Unexpected hidden table cell, expected as many cells in body rows as in the head row

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-hidden-table-cell@1, compatible with Node.js 16.

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.

Détail du package