Package Exports
- remark-lint-fenced-code-flag
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (remark-lint-fenced-code-flag) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
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 |
Example
valid.md
In
```alpha
bravo();
```Out
No messages.
invalid.md
In
```
alpha();
```Out
1:1-3:4: Missing code-language flagvalid.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 flagvalid.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 flagInstall
npm install remark-lint-fenced-code-flagUsage
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.mdOr 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));
});