JSPM

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

remark-lint rule to warn when too many spaces are used to create a hard break

Package Exports

  • remark-lint-hard-break-spaces

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-hard-break-spaces) 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-hard-break-spaces

Warn when too many spaces are used to create a hard break.

Presets

This rule is included in the following presets:

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

Example

valid.md
In

Note: · represents a space.

Lorem ipsum··
dolor sit amet
Out

No messages.

invalid.md
In

Note: · represents a space.

Lorem ipsum···
dolor sit amet.
Out
1:12-2:1: Use two spaces for hard line breaks

Install

npm install remark-lint-hard-break-spaces

Usage

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

 ...
 "remarkConfig": {
   "plugins": [
     ...
     "lint",
+    "lint-hard-break-spaces",
     ...
   ]
 }
 ...

Or use it on the CLI directly

remark -u lint -u lint-hard-break-spaces 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-hard-break-spaces'))
   .process('_Emphasis_ and **importance**', function (err, file) {
     console.error(report(err || file));
   });

License

MIT © Titus Wormer