remark-lint-directive-shortcut-attribute

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

Contents

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

What is this?

This package checks that shortcut attributes are used when possible in directives.

When should I use this?

You can use this package to check that shortcut attributes are used when possible in directives.

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

In Deno with esm.sh:

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

In browsers with esm.sh:

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

Use

On the API:

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

console.error(reporter(file))

On the CLI:

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

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

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

API

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

`unified().use(remarkLintDirectiveShortcutAttribute)`

Warn when verbose attribute names are used.

Parameters

There are no parameters.

Returns

Transform (Transformer from unified).

Examples

`ok.md`

In

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

:planet[Jupiter]{#jupiter.fifth.largest}

Out

No messages.

`not-ok.md`

In

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

:planet[Jupiter]{class="fifth largest" id="jupiter"}

Out

1:18-1:23: Unexpected verbose attribute name `class`, expected shortcut attribute with `.`
1:40-1:42: Unexpected verbose attribute name `id`, expected shortcut attribute with `#`

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-shortcut-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

Uh oh!