remark-lint-fenced-code-flag

remark-lint rule to warn when fenced code blocks occur without language flag

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
remark-lint-fenced-code-flag
4.0.010 days ago7 years agoMinified + gzip package size for remark-lint-fenced-code-flag in KB

Popular Searches

Readme

remark-lint-fenced-code-flag
!Buildbadge-build-imagebadge-build-url !Coveragebadge-coverage-imagebadge-coverage-url !Downloadsbadge-downloads-imagebadge-downloads-url !Sizebadge-size-imagebadge-size-url !Sponsorsbadge-funding-sponsors-imagebadge-funding-url !Backersbadge-funding-backers-imagebadge-funding-url !Chatbadge-chat-imagebadge-chat-url
remark-lintgithub-remark-lint rule to warn when language flags of fenced code are not used.

Contents

unified().use(remarkLintFencedCodeFlag[, options]) Options

What is this?

This package checks the language flags of fenced code blocks, whether they exist, and optionally what values they hold.

When should I use this?

You can use this package to check that the style of language flags of fenced code blocks is consistent.

Presets

This plugin is included in the following presets:
| Preset | Options | | - | - | | remark-preset-lint-markdown-style-guide | { allowEmpty: false } |

Install

This package is ESM onlygithub-gist-esm. In Node.js (version 16+), install with npmnpm-install:
npm install remark-lint-fenced-code-flag

In Deno with esm.shesm-sh:
import remarkLintFencedCodeFlag from 'https://esm.sh/remark-lint-fenced-code-flag@4'

In browsers with esm.shesm-sh:
<script type="module">
  import remarkLintFencedCodeFlag from 'https://esm.sh/remark-lint-fenced-code-flag@4?bundle'
</script>

Use

On the API:
import remarkLint from 'remark-lint'
import remarkLintFencedCodeFlag from 'remark-lint-fenced-code-flag'
import remarkParse from 'remark-parse'
import remarkStringify from 'remark-stringify'
import {read} from 'to-vfile'
import {unified} from 'unified'
import {reporter} from 'vfile-reporter'

const file = await read('example.md')

await unified()
  .use(remarkParse)
  .use(remarkLint)
  .use(remarkLintFencedCodeFlag)
  .use(remarkStringify)
  .process(file)

console.error(reporter(file))

On the CLI:
remark --frail --use remark-lint --use remark-lint-fenced-code-flag .

On the CLI in a config file (here a package.json):
…
"remarkConfig": {
  "plugins": [
    …
    "remark-lint",
+    "remark-lint-fenced-code-flag",
    …
  ]
}
…

API

This package exports no identifiers. It exports the TypeScripttypescript type Optionsapi-options. The default export is remarkLintFencedCodeFlagapi-remark-lint-fenced-code-flag.

unified().use(remarkLintFencedCodeFlag[, options])

Warn when language flags of fenced code are not used.
Parameters
— configuration or flags to allow
Returns
Transform (Transformer from unifiedgithub-unified-transformer).

Options

Configuration (TypeScript type).
Fields
  • allowEmpty (boolean, default: false)
— allow language flags to be omitted
  • flags (Array<string>, optional)
— flags to allow, other flags will result in a warning

Recommendation

While omitting language flags is fine to signal that code is plain text, it could point to a mistake. It’s recommended to instead use a certain flag for plain text (such as txt) and to turn this rule on.

Examples

ok.md
In
````markdown Some markdown:
# Mercury
````
Out
No messages.
not-ok.md
In
````markdown 
mercury()
````
Out
1:1-3:4: Unexpected missing fenced code language flag in info string, expected keyword
ok-allow-empty.md
When configured with { allowEmpty: true }.
In
````markdown 
mercury()
````
Out
No messages.
not-ok-allow-empty.md
When configured with { allowEmpty: false }.
In
````markdown 
mercury()
````
Out
1:1-3:4: Unexpected missing fenced code language flag in info string, expected keyword
ok-array.md
When configured with [ 'markdown' ].
In
````markdown 
# Mercury
````
Out
No messages.
ok-options.md
When configured with { flags: [ 'markdown' ] }.
In
````markdown 
# Mercury
````
Out
No messages.
not-ok-array.md
When configured with [ 'markdown' ].
In
````markdown 
mercury()
````
Out
1:1-3:4: Unexpected fenced code language flag `javascript` in info string, expected `markdown`
not-ok-long-array.md
When configured with [ 'javascript', 'markdown', 'mdx', 'typescript' ].
In
````markdown 
<h1>Mercury</h1>
````
Out
1:1-3:4: Unexpected fenced code language flag `html` in info string, expected `javascript`, `markdown`, `mdx`, …
not-ok-options.md
When configured with '🌍'.
Out
1:1: Unexpected value `🌍` for `options`, expected array or object

Compatibility

Projects maintained by the unified collective are compatible with maintained versions of Node.js.
When we cut a new major release, we drop support for unmaintained versions of Node. This means we try to keep the current release line, remark-lint-fenced-code-flag@4, compatible with Node.js 16.

Contribute

See contributing.mdgithub-dotfiles-contributing in remarkjs/.githubgithub-dotfiles-health for ways to get started. See support.mdgithub-dotfiles-support for ways to get help.
This project has a code of conductgithub-dotfiles-coc. By interacting with this repository, organization, or community you agree to abide by its terms.

License

MITfile-license © Titus Wormerauthor