remark-lint-definition-case

remark-lint rule to warn when definition labels are not lowercase

Stats

StarsIssuesVersionUpdatedCreatedSize
remark-lint-definition-case
809133.1.17 months ago5 years agoMinified + gzip package size for remark-lint-definition-case in KB

Readme

remark-lint-definition-case

Build Coverage Downloads Size Sponsors Backers Chat

remark-lint rule to warn when definition labels are not lowercase.

Contents

What is this?

This package is a unified (remark) plugin, specifically a remark-lint rule. Lint rules check markdown code style.

When should I use this?

You can use this package to check that the labels used in definitions are lowercase.

Presets

This rule is included in the following presets:

Preset Setting
remark-preset-lint-markdown-style-guide

Install

This package is ESM only. In Node.js (version 12.20+, 14.14+, or 16.0+), install with npm:

npm install remark-lint-definition-case

In Deno with Skypack:

import remarkLintDefinitionCase from 'https://cdn.skypack.dev/remark-lint-definition-case@3?dts'

In browsers with Skypack:

<script type="module">
  import remarkLintDefinitionCase from 'https://cdn.skypack.dev/remark-lint-definition-case@3?min'
</script>

Use

On the API:

import {read} from 'to-vfile'
import {reporter} from 'vfile-reporter'
import {remark} from 'remark'
import remarkLint from 'remark-lint'
import remarkLintDefinitionCase from 'remark-lint-definition-case'

main()

async function main() {
  const file = await remark()
    .use(remarkLint)
    .use(remarkLintDefinitionCase)
    .process(await read('example.md'))

  console.error(reporter(file))
}

On the CLI:

remark --use remark-lint --use remark-lint-definition-case example.md

On the CLI in a config file (here a package.json):

 …
 "remarkConfig": {
   "plugins": [
     …
     "remark-lint",
+    "remark-lint-definition-case",
     …
   ]
 }
 …

API

This package exports no identifiers. The default export is remarkLintDefinitionCase.

unified().use(remarkLintDefinitionCase[, config])

This rule supports standard configuration that all remark lint rules accept (such as false to turn it off or [1, options] to configure it).

There are no options.

Recommendation

Definitions and references are matched together regardless of casing. Using uppercase in labels might incorrectly indicate that casing is of importance. Due to this, it’s recommended to use lowercase and turn this rule on.

Examples

ok.md
In
[example]: http://example.com "Example Domain"
Out

No messages.

not-ok.md
In
[Example]: http://example.com "Example Domain"
Out
1:1-1:47: Do not use uppercase characters in definition labels

Compatibility

Projects maintained by the unified collective are compatible with all maintained versions of Node.js. As of now, that is Node.js 12.20+, 14.14+, and 16.0+. Our projects sometimes work with older versions, but this is not guaranteed.

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.

License

MIT © Titus Wormer

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.