mirror of
https://github.com/remarkjs/remark-lint.git
synced 2024-10-27 11:47:47 +03:00
| .. | ||
| index.js | ||
| package.json | ||
| readme.md | ||
remark-lint-fenced-code-flag
Check fenced code-block flags.
Options: Array.<string> or Object, optional.
Providing an array is as passing {flags: Array}.
The object can have an array of 'flags' which are deemed valid.
In addition it can have the property allowEmpty (boolean, default:
false) which signifies whether or not to warn for fenced code-blocks
without language flags.
Presets
This rule is included in the following presets:
| Preset | Setting |
|---|---|
remark-preset-lint-markdown-style-guide |
{allowEmpty: false} |
Example
valid.md
In
```alpha
bravo();
```
Out
No messages.
invalid.md
In
```
alpha();
```
Out
1:1-3:4: Missing code-language flag
valid.md
When configured with { allowEmpty: true }.
In
```
alpha();
```
Out
No messages.
invalid.md
When configured with { allowEmpty: false }.
In
```
alpha();
```
Out
1:1-3:4: Missing code-language flag
valid.md
When configured with [ 'alpha' ].
In
```alpha
bravo();
```
Out
No messages.
invalid.md
When configured with [ 'charlie' ].
In
```alpha
bravo();
```
Out
1:1-3:4: Invalid code-language flag
Install
npm install remark-lint-fenced-code-flag
Usage
You probably want to use it on the CLI through a config file:
...
"remarkConfig": {
"plugins": [
...
"lint",
+ "lint-fenced-code-flag",
...
]
}
...
Or use it on the CLI directly
remark -u lint -u lint-fenced-code-flag 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-fenced-code-flag'))
.process('_Emphasis_ and **importance**', function (err, file) {
console.error(report(err || file));
});