remark-lint
rule to warn when definition labels are not lowercase.
- What is this?
- When should I use this?
- Presets
- Install
- Use
- API
- Recommendation
- Examples
- Compatibility
- Contribute
- License
This package checks the case of definition labels.
You can use this package to check that definition labels are consistent.
This plugin is included in the following presets:
Preset | Options |
---|---|
remark-preset-lint-markdown-style-guide |
This package is ESM only. In Node.js (version 16+), install with npm:
npm install remark-lint-definition-case
In Deno with esm.sh
:
import remarkLintDefinitionCase from 'https://esm.sh/remark-lint-definition-case@4'
In browsers with esm.sh
:
<script type="module">
import remarkLintDefinitionCase from 'https://esm.sh/remark-lint-definition-case@4?bundle'
</script>
On the API:
import remarkLint from 'remark-lint'
import remarkLintDefinitionCase from 'remark-lint-definition-case'
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(remarkLintDefinitionCase)
.use(remarkStringify)
.process(file)
console.error(reporter(file))
On the CLI:
remark --frail --use remark-lint --use remark-lint-definition-case .
On the CLI in a config file (here a package.json
):
…
"remarkConfig": {
"plugins": [
…
"remark-lint",
+ "remark-lint-definition-case",
…
]
}
…
This package exports no identifiers.
It exports no additional TypeScript types.
The default export is
remarkLintDefinitionCase
.
Warn when definition labels are not lowercase.
There are no options.
Transform (Transformer
from unified
).
Definitions and references are matched together regardless of casing. Using uppercase in definition labels might incorrectly indicate that casing is of importance. Due to this, it’s recommended to use lowercase and turn this rule on.
[mercury]: http://example.com "Mercury"
No messages.
[Mercury]: http://example.com "Mercury"
1:1-1:40: Unexpected uppercase characters in definition label, expected lowercase
👉 Note: this example uses GFM (
remark-gfm
).
[^Mercury]:
**Mercury** is the first planet from the Sun and the smallest
in the Solar System.
1:1-3:25: Unexpected uppercase characters in footnote definition label, expected lowercase
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-definition-case@4
,
compatible with Node.js 16.
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.