remark-lint-fenced-code-marker
!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-urlremark-lint
github-remark-lint rule to warn when fenced code markers are
inconsistent.Contents
unified().use(remarkLintFencedCodeMarker[, options])
Marker
Options
What is this?
This package checks fenced code block markers.When should I use this?
You can use this package to check that fenced code block markers are consistent.Presets
This plugin is included in the following presets:| Preset | Options | | - | - | |
remark-preset-lint-consistent
| 'consistent'
|
| remark-preset-lint-markdown-style-guide
| `'
'`` |Install
This package is ESM onlygithub-gist-esm. In Node.js (version 16+), install with npmnpm-install:npm install remark-lint-fenced-code-marker
In Deno with
esm.sh
esm-sh:import remarkLintFencedCodeMarker from 'https://esm.sh/remark-lint-fenced-code-marker@4'
In browsers with
esm.sh
esm-sh:<script type="module">
import remarkLintFencedCodeMarker from 'https://esm.sh/remark-lint-fenced-code-marker@4?bundle'
</script>
Use
On the API:import remarkLint from 'remark-lint'
import remarkLintFencedCodeMarker from 'remark-lint-fenced-code-marker'
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(remarkLintFencedCodeMarker)
.use(remarkStringify)
.process(file)
console.error(reporter(file))
On the CLI:
remark --frail --use remark-lint --use remark-lint-fenced-code-marker .
On the CLI in a config file (here a
package.json
):…
"remarkConfig": {
"plugins": [
…
"remark-lint",
+ "remark-lint-fenced-code-marker",
…
]
}
…
API
This package exports no identifiers. It exports the TypeScripttypescript typesMarker
api-marker and
Options
api-options.
The default export is
remarkLintFencedCodeMarker
api-remark-lint-fenced-code-marker.unified().use(remarkLintFencedCodeMarker[, options])
Warn when fenced code markers are inconsistent.Parameters
options
(Options
api-options, default:'consistent'
)
Returns
Transform (Transformer
from unified
github-unified-transformer).Marker
Marker (TypeScript type).Type
type Marker = '`' | '~'
Options
Configuration (TypeScript type).Type
type Options = Marker | 'consistent'
Recommendation
Tildes are uncommon. So it’s recommended to configure this rule with `'
'``.Fix
remark-stringify
github-remark-stringify formats fenced code with grave
accents by default.
Pass fence: '~'
to always use tildes.Examples
ok-indented.md
In
Indented code blocks are not affected by this rule:
mercury()
Out
No messages.ok-tick.md
When configured with `'
'``.In
````markdownmercury()
venus()
````Out
No messages.ok-tilde.md
When configured with '~'
.In
~~~javascript
mercury()
~~~
~~~
venus()
~~~
Out
No messages.not-ok-consistent-tick.md
In
````markdownmercury()
Out
5:1-7:4: Unexpected fenced code marker `~`, expected `` ` ``
not-ok-consistent-tilde.md
In
````markdownvenus()
````Out
5:1-7:4: Unexpected fenced code marker `` ` ``, expected `~`
not-ok-incorrect.md
When configured with '🌍'
.Out
1:1: Unexpected value `🌍` for `options`, expected ``'`'``, `'~'`, or `'consistent'`
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-marker@4
,
compatible with Node.js 16.Contribute
Seecontributing.md
github-dotfiles-contributing in remarkjs/.github
github-dotfiles-health for ways
to get started.
See support.md
github-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.