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

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