4.5 KiB
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 allowed: other flags
will not be allowed.
An allowEmpty field (boolean, default: false) can be set to allow
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
ok.md
In
```alpha
bravo()
```
Out
No messages.
not-ok.md
In
```
alpha()
```
Out
1:1-3:4: Missing code language flag
ok.md
When configured with { allowEmpty: true }.
In
```
alpha()
```
Out
No messages.
not-ok.md
When configured with { allowEmpty: false }.
In
```
alpha()
```
Out
1:1-3:4: Missing code language flag
ok.md
When configured with [ 'alpha' ].
In
```alpha
bravo()
```
Out
No messages.
ok.md
When configured with { flags: [ 'alpha' ] }.
In
```alpha
bravo()
```
Out
No messages.
not-ok.md
When configured with [ 'charlie' ].
In
```alpha
bravo()
```
Out
1:1-3:4: Incorrect code language flag
Install
This package is ESM only:
Node 12+ is needed to use it and it must be importeded instead of requiredd.
npm:
npm install remark-lint-fenced-code-flag
This package exports no identifiers.
The default export is remarkLintFencedCodeFlag.
Use
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:
import {remark} from 'remark'
import {reporter} from 'vfile-reporter'
import remarkLint from 'remark-lint'
import remarkLintFencedCodeFlag from 'remark-lint-fenced-code-flag'
remark()
.use(remarkLint)
+ .use(remarkLintFencedCodeFlag)
.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.