remark-lint-directive-unique-attribute-name

remark-lint rule to warn when directive attribute names are reused.

Contents

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

What is this?

This package checks that directive attribute names are unique.

When should I use this?

You can use this package to check that directive attribute names are unique.

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-unique-attribute-name

In Deno with esm.sh:

import remarkLintDirectiveUniqueAttributeName from 'https://esm.sh/remark-lint-directive-unique-attribute-name@1'

In browsers with esm.sh:

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

Use

On the API:

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

console.error(reporter(file))

On the CLI:

remark --frail --use remark-lint --use remark-lint-directive-unique-attribute-name .

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

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

API

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

unified().use(remarkLintDirectiveUniqueAttributeName)

Warn when directive attribute names are reused.

Parameters

There are no parameters.

Returns

Transform (Transformer from unified).

Examples

ok.md

In

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

:planet[Venus]{aphelion=0.728213 perihelion=0.718440 symbol=♀︎}

Out

No messages.

ok.md

In

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

:planet{#mercury value="Mercury"}

Out

No messages.

not-ok.md

In

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

:planet{#mercury adjective="Venusian" adjective="Cytherean" aphelion="0.728213" id="venus"}

Out

1:39-1:48: Unexpected attribute name with equal text, expected unique attribute names
1:81-1:83: Unexpected attribute name with equivalent text, expected unique attribute names

other-attributes.md

In

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

:planet[Mercury]{closest},
:planet[Venus]{aphelion=0.728213}, and
:planet[Mars]{.red.orange class="fourth"}.

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-unique-attribute-name@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