remark-lint-hard-break-spaces

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:

npm install remark-lint-hard-break-spaces

Use

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));
   });

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, organisation, or community you agree to abide by its terms.

License

MIT © Titus Wormer