remark-lint-definition-sort

remark-lint rule to warn when definitions are not sorted.

Contents

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

What is this?

This package checks definition order.

When should I use this?

You can use this package to check definition order.

Presets

This plugin is not included in presets maintained here.

Install

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

npm install remark-lint-definition-sort

In Deno with esm.sh:

import remarkLintDefinitionSort from 'https://esm.sh/remark-lint-definition-sort@1'

In browsers with esm.sh:

<script type="module">
  import remarkLintDefinitionSort from 'https://esm.sh/remark-lint-definition-sort@1?bundle'
</script>

Use

On the API:

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

console.error(reporter(file))

On the CLI:

remark --frail --use remark-lint --use remark-lint-definition-sort .

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

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

API

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

unified().use(remarkLintDefinitionSort)

Warn when when definitions are not sorted.

Parameters

There are no parameters.

Returns

Transform (Transformer from unified).

Examples

ok.md

In

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

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

Out

No messages.

gfm-ok.md

In

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

[^mercury]:
    **Mercury** is the first planet from the Sun and the smallest
    in the Solar System.

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

Out

No messages.

together.md

In

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

Definitions and footnote definitions are sorted separately.

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

[^mercury]:
    **Mercury** is the first planet from the Sun and the smallest
    in the Solar System.

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

Out

No messages.

together.md

In

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

Definitions are sorted per “group”.

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

This paragraph introduces another group.

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

Out

No messages.

comment.md

In

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

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

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

Out

No messages.

comment.mdx

In

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

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

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

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

Out

No messages.

not-ok.md

In

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

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

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

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

Out

1:1-1:36: Unexpected definition `venus` in 1st place, expected alphabetically sorted definitions, move it to 4th place
3:1-3:40: Unexpected definition `mercury` in 2nd place, expected alphabetically sorted definitions, move it to 3rd place
5:1-5:36: Unexpected definition `earth` in 3rd place, expected alphabetically sorted definitions, move it to 1st place
7:1-7:34: Unexpected definition `mars` in 4th place, expected alphabetically sorted definitions, move it to 2nd place

not-ok-gfm.md

In

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

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

[^mercury]:
    **Mercury** is the first planet from the Sun and the smallest
    in the Solar System.

Out

1:1-3:13: Unexpected footnote definition `venus` in 1st place, expected alphabetically sorted definitions, move it to 2nd place
5:1-7:25: Unexpected footnote definition `mercury` in 2nd place, expected alphabetically sorted definitions, move it to 1st place

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-definition-sort@1, 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