unified

Project: remarkjs/remark-lint

Package: remark-lint-no-inline-padding@4.1.0

  1. Dependents: 21
  2. remark-lint rule to warn when inline nodes are padded with spaces
  1. remark 196
  2. lint 77
  3. rule 72
  4. remark-lint-rule 65
  5. inline 3
  6. padding 2

remark-lint-no-inline-padding

Build Coverage Downloads Size Sponsors Backers Chat

Warn when phrasing content is padded with spaces between their markers and content.

Warns for emphasis, strong, delete, image, and link.

Presets

This rule is included in the following presets:

PresetSetting
remark-preset-lint-markdown-style-guide
remark-preset-lint-recommended

Example

ok.md
In
Alpha [bravo](http://echo.fox/trot)
Out

No messages.

not-ok.md
In
Alpha [ bravo ](http://echo.fox/trot)
Out
1:7-1:38: Don’t pad `link` with inner spaces

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-inline-padding

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

Use

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

 …
 "remarkConfig": {
   "plugins": [
     …
     "lint",
+    "lint-no-inline-padding",
     …
   ]
 }
 …

Or use it on the CLI directly

remark -u lint -u lint-no-inline-padding readme.md

Or use this on the API:

 import {remark} from 'remark'
 import {reporter} from 'vfile-reporter'
 import remarkLint from 'remark-lint'
 import remarkLintNoInlinePadding from 'remark-lint-no-inline-padding'

 remark()
   .use(remarkLint)
+  .use(remarkLintNoInlinePadding)
   .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