unified

Project: remarkjs/remark-lint

Package: remark-lint-fenced-code-flag@2.0.1

  1. Dependencies: 4·Dependents: 12
  2. remark-lint rule to warn when fenced code blocks occur without language flag
  1. remark 182
  2. lint 68
  3. rule 64
  4. remark-lint-rule 63
  5. code 4
  6. fenced 2

remark-lint-fenced-code-flag

Build Coverage Downloads Size Sponsors Backers Chat

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:

PresetSetting
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.

not-ok.md

When configured with [ 'charlie' ].

In
```alpha
bravo();
```
Out
1:1-3:4: Incorrect code language flag

Install

npm:

npm install remark-lint-fenced-code-flag

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:

 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))
   })

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.

License

MIT © Titus Wormer