remark-lint-mdx-jsx-shorthand-attribute

remark-lint rule to warn when verbose attribute values are used.

Contents

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

What is this?

This package checks that shorthand attributes are used when possible in MDX JSX.

When should I use this?

You can use this package to check that shorthand attributes are used when possible in MDX JSX.

This package does assume JavaScript: that planet and planet={true} are equal. JavaScript is almost always what is used with MDX. But if you use other programming languages embedded in MDX this package should not be used.

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

In Deno with esm.sh:

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

In browsers with esm.sh:

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

Use

On the API:

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

console.error(reporter(file))

On the CLI:

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

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

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

API

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

unified().use(remarkLintMdxJsxShorthandAttribute)

Warn when verbose attribute values are used.

Parameters

There are no parameters.

Returns

Transform (Transformer from unified).

Examples

ok.mdx

In

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

<Jupiter largest />

Out

No messages.

not-ok.mdx

In

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

<Jupiter largest={true} />

Out

1:10-1:24: Unexpected verbose attribute value, expected shorthand boolean attribute

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-shorthand-attribute@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