| .. | ||
| .npmrc | ||
| index.js | ||
| package.json | ||
| readme.md | ||
| tsconfig.json | ||
remark-lint-fenced-code-marker
remark-lint rule to warn when fenced code markers are
inconsistent.
Contents
- What is this?
- When should I use this?
- Presets
- Install
- Use
- API
- Recommendation
- Fix
- Examples
- Compatibility
- Contribute
- License
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 only. In Node.js (version 16+), install with npm:
npm install remark-lint-fenced-code-marker
In Deno with esm.sh:
import remarkLintFencedCodeMarker from 'https://esm.sh/remark-lint-fenced-code-marker@3'
In browsers with esm.sh:
<script type="module">
import remarkLintFencedCodeMarker from 'https://esm.sh/remark-lint-fenced-code-marker@3?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 TypeScript types
Marker and
Options.
The default export is
remarkLintFencedCodeMarker.
unified().use(remarkLintFencedCodeMarker[, options])
Warn when fenced code markers are inconsistent.
Parameters
options(Options, default:'consistent') — preferred style or whether to detect the first style and warn for further differences
Returns
Transform (Transformer from unified).
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 formats fenced code with grave
accents by default.
Pass fence: '~' to always use tildes.
Examples
ok.md
In
Indented code blocks are not affected by this rule:
bravo()
Out
No messages.
ok.md
When configured with '`'.
In
```alpha
bravo()
```
```
charlie()
```
Out
No messages.
ok.md
When configured with '~'.
In
~~~alpha
bravo()
~~~
~~~
charlie()
~~~
Out
No messages.
not-ok-consistent-tick.md
In
```alpha
bravo()
```
~~~
charlie()
~~~
Out
5:1-7:4: Fenced code should use `` ` `` as a marker
not-ok-consistent-tilde.md
In
~~~alpha
bravo()
~~~
```
charlie()
```
Out
5:1-7:4: Fenced code should use `~` as a marker
not-ok-incorrect.md
When configured with '💩'.
Out
1:1: Incorrect fenced code marker `💩`: use either `'consistent'`, `` '`' ``, or `'~'`
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@3,
compatible with Node.js 12.
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.