remark-lint-mdx-jsx-no-void-children

remark-lint-mdx-jsx-no-void-children

remark-lint rule to warn when void HTML elements (such as <br>) are seen with children.

Contents

• What is this?
• When should I use this?
• Presets
• Install
• Use
• API
  • unified().use(remarkLintMdxJsxNoVoidChildren[, options])
• Examples
• Compatibility
• Contribute
• License

What is this?

This package checks that HTML void elements are without children.

When should I use this?

You can use this package to check that HTML void elements are without children.

This package assumes semantics from HTML. If you use MDX in a place without HTML you should not use this.

This package also checks children and dangerouslySetInnerHTML as it assumes the semantics that React applies to these names. If how you use JSX conflicts with the React semantics this package may not work for you.

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-no-void-children

In Deno with esm.sh:

import remarkLintMdxJsxNoVoidChildren from 'https://esm.sh/remark-lint-mdx-jsx-no-void-children@1'

In browsers with esm.sh:

<script type="module">
  import remarkLintMdxJsxNoVoidChildren from 'https://esm.sh/remark-lint-mdx-jsx-no-void-children@1?bundle'
</script>

Use

On the API:

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

console.error(reporter(file))

On the CLI:

remark --frail --use remark-lint --use remark-lint-mdx-jsx-no-void-children .

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

 …
 "remarkConfig": {
   "plugins": [
     …
     "remark-lint",
+    "remark-lint-mdx-jsx-no-void-children",
     …
   ]
 }
 …

API

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

unified().use(remarkLintMdxJsxNoVoidChildren[, options])

Warn when void HTML elements (such as <br>) are seen with children.

Parameters

There are no parameters.

Returns

Transform (Transformer from unified).

Examples

ok.mdx

In

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

<b>Mercury</b> is the first planet from the Sun<br />
and the smallest in the Solar System.

Out

No messages.

not-ok.mdx

In

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

**Mercury** is the first planet from<br>the</br>
Sun and the smallest in the Solar System.

<hr children={'***'} />

**Venus** is the second planet
from <br dangerouslySetInnerHTML={{__html: 'the'}} />
Sun.

Out

1:41-1:44: Unexpected children in known HTML void element, expected nothing
4:5-4:21: Unexpected children in known HTML void element, expected nothing
7:10-7:51: Unexpected children in known HTML void element, expected nothing

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-no-void-children@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