2016-08-22 11:52:41 +03:00
|
|
|
<!--This file is generated-->
|
|
|
|
|
|
|
|
# remark-preset-lint-consistent
|
|
|
|
|
2017-04-29 14:06:16 +03:00
|
|
|
remark preset to configure remark-lint with
|
|
|
|
settings that enforce consistency.
|
2016-08-22 11:52:41 +03:00
|
|
|
|
2017-08-17 14:52:59 +03:00
|
|
|
## Rules
|
|
|
|
|
|
|
|
This preset configures [`remark-lint`](https://github.com/wooorm/remark-lint) with the following rules:
|
|
|
|
|
|
|
|
| Rule | Setting |
|
|
|
|
| ---- | ------- |
|
|
|
|
| [`blockquote-indentation`](https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-blockquote-indentation) | `'consistent'` |
|
|
|
|
| [`checkbox-character-style`](https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-checkbox-character-style) | `'consistent'` |
|
|
|
|
| [`code-block-style`](https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-code-block-style) | `'consistent'` |
|
|
|
|
| [`emphasis-marker`](https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-emphasis-marker) | `'consistent'` |
|
|
|
|
| [`fenced-code-marker`](https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-fenced-code-marker) | `'consistent'` |
|
|
|
|
| [`heading-style`](https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-heading-style) | `'consistent'` |
|
|
|
|
| [`link-title-style`](https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-link-title-style) | `'consistent'` |
|
|
|
|
| [`list-item-content-indent`](https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-list-item-content-indent) | |
|
|
|
|
| [`ordered-list-marker-style`](https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-ordered-list-marker-style) | `'consistent'` |
|
|
|
|
| [`rule-style`](https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-rule-style) | `'consistent'` |
|
|
|
|
| [`strong-marker`](https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-strong-marker) | `'consistent'` |
|
|
|
|
| [`table-cell-padding`](https://github.com/wooorm/remark-lint/tree/master/packages/remark-lint-table-cell-padding) | `'consistent'` |
|
|
|
|
|
2016-08-22 11:52:41 +03:00
|
|
|
## Install
|
|
|
|
|
|
|
|
npm:
|
|
|
|
|
|
|
|
```sh
|
2017-02-23 20:07:52 +03:00
|
|
|
npm install remark-preset-lint-consistent
|
2016-08-22 11:52:41 +03:00
|
|
|
```
|
|
|
|
|
2017-08-17 14:52:59 +03:00
|
|
|
## Usage
|
|
|
|
|
2017-02-23 20:07:52 +03:00
|
|
|
You probably want to use it on the CLI through a config file:
|
2016-08-22 11:52:41 +03:00
|
|
|
|
|
|
|
```diff
|
2017-02-23 20:07:52 +03:00
|
|
|
...
|
|
|
|
"remarkConfig": {
|
2017-08-17 14:52:59 +03:00
|
|
|
+ "plugins": ["preset-lint-consistent"]
|
2017-02-23 20:07:52 +03:00
|
|
|
}
|
|
|
|
...
|
|
|
|
```
|
|
|
|
|
|
|
|
Or use it on the CLI directly
|
|
|
|
|
|
|
|
```sh
|
2017-08-17 14:52:59 +03:00
|
|
|
remark -u preset-lint-consistent readme.md
|
2017-02-23 20:07:52 +03:00
|
|
|
```
|
|
|
|
|
|
|
|
Or use this on the API:
|
|
|
|
|
|
|
|
```diff
|
|
|
|
var remark = require('remark');
|
|
|
|
var report = require('vfile-reporter');
|
|
|
|
|
2017-08-17 14:52:59 +03:00
|
|
|
remark()
|
2017-02-23 20:07:52 +03:00
|
|
|
+ .use(require('remark-preset-lint-consistent'))
|
2017-08-17 14:52:59 +03:00
|
|
|
.process('_Emphasis_ and **importance**', function (err, file) {
|
|
|
|
console.error(report(err || file));
|
|
|
|
});
|
2016-08-22 11:52:41 +03:00
|
|
|
```
|
|
|
|
|
2017-08-17 14:52:59 +03:00
|
|
|
## License
|
2016-08-22 11:52:41 +03:00
|
|
|
|
2017-08-17 14:52:59 +03:00
|
|
|
[MIT](https://github.com/wooorm/remark-lint/blob/master/LICENSE) © [Titus Wormer](http://wooorm.com)
|