remark-lint-mdx-jsx-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(remarkLintMdxJsxAttributeSort)
Examples
Compatibility
Contribute
License

What is this?

This package checks MDX JSX attribute order.

When should I use this?

You can use this package to check MDX JSX 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-mdx-jsx-attribute-sort

In Deno with esm.sh:

import remarkLintMdxJsxAttributeSort from 'https://esm.sh/remark-lint-mdx-jsx-attribute-sort@1'

In browsers with esm.sh:

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

Use

On the API:

import remarkLint from 'remark-lint'
import remarkLintMdxJsxAttributeSort from 'remark-lint-mdx-jsx-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(remarkLintMdxJsxAttributeSort)
  .use(remarkStringify)
  .process(file)

console.error(reporter(file))

On the CLI:

remark --frail --use remark-lint --use remark-lint-mdx-jsx-attribute-sort .

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

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

API

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

`unified().use(remarkLintMdxJsxAttributeSort)`

Warn when attributes are not sorted.

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

Spreads must come first.

Parameters

There are no parameters.

Returns

Transform (Transformer from unified).

Examples

`ok.mdx`

In

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

<Saturn
  aphelion={1514.50}
  largest={false}
  perihelion={1352.55}
  satellites={146}
/>

Out

No messages.

`not-ok.mdx`

In

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

<Saturn
  largest={false}
  perihelion={1352.55}
  satellites={146}
  aphelion={1514.50}
/>

Out

2:3-2:18: Unexpected attribute `largest` in 1st place, expected alphabetically sorted attributes, move it to 2nd place
3:3-3:23: Unexpected attribute `perihelion` in 2nd place, expected alphabetically sorted attributes, move it to 3rd place
4:3-4:19: Unexpected attribute `satellites` in 3rd place, expected alphabetically sorted attributes, move it to 4th place
5:3-5:21: Unexpected attribute `aphelion` in 4th place, expected alphabetically sorted attributes, move it to 1st place

`spread.mdx`

In

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

<Earth
  {...animals}
  symbol="🜨"
  {...humans}
/>

Out

4:3-4:14: Unexpected spread attribute after named attribute, expected spread attributes to come first

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-mdx-jsx-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

Uh oh!