JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 98958
  • Score
    100M100P100Q184502F
  • License MIT

remark-lint rule to warn when tables are indented

Package Exports

  • remark-lint-no-table-indentation

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (remark-lint-no-table-indentation) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

remark-lint-no-table-indentation

Build Coverage Downloads Size Sponsors Backers Chat

Warn when tables are indented.

Fix

remark-stringify removes all unneeded indentation before tables.

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:

Preset Setting
remark-preset-lint-markdown-style-guide

Example

ok.md
In

Note: this example uses GFM.

Paragraph.

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

No messages.

not-ok.md
In

Note: this example uses GFM.

Note: · represents a space.

Paragraph.

···| A     | B     |
···| ----- | ----- |
···| Alpha | Bravo |
Out
3:4: Do not indent table rows
4:4: Do not indent table rows
5:4: Do not indent table rows
not-ok-blockquote.md
In

Note: this example uses GFM.

Note: · represents a space.

>··| A |
>·| - |
Out
1:4: Do not indent table rows
not-ok-list.md
In

Note: this example uses GFM.

Note: · represents a space.

-···paragraph

·····| A |
····| - |
Out
3:6: Do not indent table rows

Install

This package is ESM only: Node 12+ is needed to use it and it must be importeded instead of requiredd.

npm:

npm install remark-lint-no-table-indentation

This package exports no identifiers. The default export is remarkLintNoTableIndentation.

Use

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

 …
 "remarkConfig": {
   "plugins": [
     …
     "lint",
+    "lint-no-table-indentation",
     …
   ]
 }
 …

Or use it on the CLI directly

remark -u lint -u lint-no-table-indentation readme.md

Or use this on the API:

 import {remark} from 'remark'
 import {reporter} from 'vfile-reporter'
 import remarkLint from 'remark-lint'
 import remarkLintNoTableIndentation from 'remark-lint-no-table-indentation'

 remark()
   .use(remarkLint)
+  .use(remarkLintNoTableIndentation)
   .process('_Emphasis_ and **importance**')
   .then((file) => {
     console.error(reporter(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