mirror of
https://github.com/remarkjs/remark-lint.git
synced 2024-10-27 03:37:50 +03:00
.. | ||
index.js | ||
package.json | ||
readme.md | ||
tsconfig.json |
remark-preset-lint-consistent
remark preset to configure remark-lint
with settings that enforce
consistency.
Rules
This preset configures remark-lint
with the following rules:
Rule | Setting |
---|---|
remark-lint-blockquote-indentation |
'consistent' |
remark-lint-checkbox-character-style |
'consistent' |
remark-lint-code-block-style |
'consistent' |
remark-lint-emphasis-marker |
'consistent' |
remark-lint-fenced-code-marker |
'consistent' |
remark-lint-heading-style |
'consistent' |
remark-lint-link-title-style |
'consistent' |
remark-lint-list-item-content-indent |
|
remark-lint-ordered-list-marker-style |
'consistent' |
remark-lint-rule-style |
'consistent' |
remark-lint-strong-marker |
'consistent' |
remark-lint-table-cell-padding |
'consistent' |
Install
This package is ESM only:
Node 12+ is needed to use it and it must be imported
ed instead of required
d.
npm:
npm install remark-preset-lint-consistent
This package exports no identifiers.
The default export is remarkPresetLintConsistent
.
Use
You probably want to use it on the CLI through a config file:
…
"remarkConfig": {
+ "plugins": ["preset-lint-consistent"]
}
…
Or use it on the CLI directly
remark -u preset-lint-consistent readme.md
Or use this on the API:
import {remark} from 'remark'
import {reporter} from 'vfile-reporter'
import remarkPresetLintConsistent from 'remark-preset-lint-consistent'
remark()
+ .use(remarkPresetLintConsistent)
.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.