remark-lint-directive-attribute-sort v1.0.1

remark-lint-directive-attribute-sort

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

Contents

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

What is this?

This package checks directive attribute order.

When should I use this?

You can use this package to check directive attribute 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-directive-attribute-sort

In Deno with esm.sh:

import remarkLintDirectiveAttributeSort from 'https://esm.sh/remark-lint-directive-attribute-sort@1'

In browsers with esm.sh:

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

Use

On the API:

import remarkLint from 'remark-lint'
import remarkLintDirectiveAttributeSort from 'remark-lint-directive-attribute-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(remarkLintDirectiveAttributeSort)
  .use(remarkStringify)
  .process(file)

console.error(reporter(file))

On the CLI:

remark --frail --use remark-lint --use remark-lint-directive-attribute-sort .

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

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

API

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

unified().use(remarkLintDirectiveAttributeSort)

Warn when attributes are not sorted.

This package does not differentiate between what values attributes have, or whether they are collapsed or not.

Parameters

There are no parameters.

Returns

Transform (Transformer from unified).

Examples

ok.md

In

👉 Note: this example uses directives (remark-directive).

:planet[Saturn]{aphelion="1514.50" largest="no" perihelion="1352.55" satellites=146}

Out

No messages.

not-ok.md

In

👉 Note: this example uses directives (remark-directive).

:planet[Saturn]{largest="no" perihelion=1352.55 satellites=146 aphelion="1514.50"}

Out

1:17-1:24: Unexpected attribute `largest` in 1st place, expected alphabetically sorted attributes, move it to 2nd place
1:30-1:40: Unexpected attribute `perihelion` in 2nd place, expected alphabetically sorted attributes, move it to 3rd place
1:49-1:59: Unexpected attribute `satellites` in 3rd place, expected alphabetically sorted attributes, move it to 4th place
1:64-1:72: Unexpected attribute `aphelion` in 4th place, expected alphabetically sorted attributes, move it to 1st place

shortcut.md

In

👉 Note: this example uses directives (remark-directive).

:planet[Saturn]{#saturn.sixth.gas.giant aphelion="1514.50"}

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-directive-attribute-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