remark-lint-final-definition

remark-lint-final-definition

remark-lint rule to warn when definitions are used in the document instead of at the end.

Contents

• What is this?
• When should I use this?
• Presets
• Install
• Use
• API
  • unified().use(remarkLintFinalDefinition)
• Recommendation
• Examples
• Compatibility
• Contribute
• License

What is this?

This package checks where definitions are placed.

When should I use this?

You can use this package to check that definitions are consistently at the end of the document.

Presets

This plugin is included in the following presets:

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

Install

This package is ESM only. In Node.js (version 16+), install with npm:

npm install remark-lint-final-definition

In Deno with esm.sh:

import remarkLintFinalDefinition from 'https://esm.sh/remark-lint-final-definition@4'

In browsers with esm.sh:

<script type="module">
  import remarkLintFinalDefinition from 'https://esm.sh/remark-lint-final-definition@4?bundle'
</script>

Use

On the API:

import remarkLint from 'remark-lint'
import remarkLintFinalDefinition from 'remark-lint-final-definition'
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(remarkLintFinalDefinition)
  .use(remarkStringify)
  .process(file)

console.error(reporter(file))

On the CLI:

remark --frail --use remark-lint --use remark-lint-final-definition .

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

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

API

This package exports no identifiers. It exports no additional TypeScript types. The default export is remarkLintFinalDefinition.

unified().use(remarkLintFinalDefinition)

Warn when definitions are used in the document instead of at the end.

Parameters

There are no options.

Returns

Transform (Transformer from unified).

Recommendation

There are different strategies for placing definitions. The simplest is perhaps to place them all at the bottem of documents. If you prefer that, turn on this rule.

Examples

ok.md

In

Mercury.

[venus]: https://example.com

Out

No messages.

ok.md

In

[mercury]: https://example.com/mercury/
[venus]: https://example.com/venus/

Out

No messages.

ok-html-comments.md

In

Mercury.

[venus]: https://example.com/venus/

<!-- HTML comments in markdown are ignored. -->

[earth]: https://example.com/earth/

Out

No messages.

ok-mdx-comments.mdx

In

👉 Note: this example uses MDX (remark-mdx).

Mercury.

[venus]: https://example.com/venus/

{/* Comments in expressions in MDX are ignored. */}

[earth]: https://example.com/earth/

Out

No messages.

not-ok.md

In

Mercury.

[venus]: https://example.com/venus/

Earth.

Out

3:1-3:36: Unexpected definition before last content, expected definitions after line `5`

gfm-nok.md

In

👉 Note: this example uses GFM (remark-gfm).

Mercury.

[^venus]:
    **Venus** is the second planet from
    the Sun.

Earth.

Out

3:1-5:13: Unexpected footnote definition before last content, expected definitions after line `7`

gfm-ok.md

In

👉 Note: this example uses GFM (remark-gfm).

Mercury.

Earth.

[^venus]:
    **Venus** is the second planet from
    the Sun.

Out

No messages.

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-final-definition@4, compatible with Node.js 16.

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