remark-lint/packages/remark-preset-lint-consistent

remark-preset-lint-consistent

remark preset to configure remark-lint with settings that enforce consistency.

Install

npm:

npm install remark-preset-lint-consistent

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

 ...
 "remarkConfig": {
+  "plugins": ["remark-preset-lint-consistent"]
 }
 ...

Or use it on the CLI directly

remark -u remark-preset-lint-consistent readme.md

Or use this on the API:

 var remark = require('remark');
 var report = require('vfile-reporter');

 var file = remark()
+  .use(require('remark-preset-lint-consistent'))
   .processSync('_Emphasis_ and **importance**')

 console.error(report(file));

Rules

This preset configures remark-lint with the following rules:

Rule	Setting
blockquote-indentation	'consistent'
checkbox-character-style	'consistent'
code-block-style	'consistent'
emphasis-marker	'consistent'
fenced-code-marker	'consistent'
heading-style	'consistent'
link-title-style	'consistent'
list-item-content-indent
ordered-list-marker-style	'consistent'
rule-style	'consistent'
strong-marker	'consistent'
table-cell-padding	'consistent'