{"_id":"remark-lint-mdx-jsx-no-void-children","_rev":"1-280ee50bce42fa8681a7d71c643f094a","name":"remark-lint-mdx-jsx-no-void-children","dist-tags":{"latest":"1.0.1"},"versions":{"1.0.0":{"name":"remark-lint-mdx-jsx-no-void-children","version":"1.0.0","keywords":["children","closing","empty","jsx","lint","mdx","remark","remark-lint","remark-lint-rule","rule","self","void"],"author":{"url":"https://wooorm.com","name":"Titus Wormer","email":"tituswormer@gmail.com"},"license":"MIT","_id":"remark-lint-mdx-jsx-no-void-children@1.0.0","maintainers":[{"name":"wooorm","email":"tituswormer@gmail.com"}],"contributors":[{"name":"Titus Wormer","email":"tituswormer@gmail.com"}],"homepage":"https://github.com/remarkjs/remark-lint/tree/main#readme","bugs":{"url":"https://github.com/remarkjs/remark-lint/issues"},"xo":{"rules":{"capitalized-comments":"off","unicorn/prefer-switch":"off","unicorn/prefer-code-point":"off"},"prettier":true},"dist":{"shasum":"ba911c5d8b6eedbaf2a7fc1821e33c1a38437797","tarball":"https://registry.npmjs.org/remark-lint-mdx-jsx-no-void-children/-/remark-lint-mdx-jsx-no-void-children-1.0.0.tgz","fileCount":5,"integrity":"sha512-ccqc27N21ns2c7YMpZPKAfxyMQ/HW10SCKBVYc278dSDo4DkhlNS8cHAHaxbOo2/l7DUVpxKbojpCwpG6O7iYA==","signatures":[{"sig":"MEUCIQDTDLuuW1KO/902k/bpYevysOd3zpT2lWSFnD+zso2fuwIgFYdbzDxDxMss49Qy07LuEStP0AU4DwxMpbeY01CoJkM=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":12364},"type":"module","types":"./index.d.ts","exports":"./index.js","funding":{"url":"https://opencollective.com/unified","type":"opencollective"},"gitHead":"bdeb4629b6d62362625acbcf0d60fe3073031849","scripts":{},"_npmUser":{"name":"wooorm","email":"tituswormer@gmail.com"},"repository":{"url":"git+https://github.com/remarkjs/remark-lint.git#main","type":"git"},"_npmVersion":"11.0.0","description":"remark-lint rule to check mdx jsx quotes","directories":{},"sideEffects":false,"_nodeVersion":"23.1.0","dependencies":{"@types/mdast":"^4.0.0","mdast-util-mdx":"^3.0.0","unified-lint-rule":"^3.0.0","html-void-elements":"^3.0.0","unist-util-visit-parents":"^6.0.0"},"typeCoverage":{"strict":true,"atLeast":100},"_hasShrinkwrap":false,"_npmOperationalInternal":{"tmp":"tmp/remark-lint-mdx-jsx-no-void-children_1.0.0_1737979138443_0.2014886338745665","host":"s3://npm-registry-packages-npm-production"}},"1.0.1":{"author":{"name":"Titus Wormer","email":"tituswormer@gmail.com","url":"https://wooorm.com"},"bugs":{"url":"https://github.com/remarkjs/remark-lint/issues"},"contributors":[{"name":"Titus Wormer","email":"tituswormer@gmail.com"}],"dependencies":{"@types/mdast":"^4.0.0","html-void-elements":"^3.0.0","mdast-util-mdx":"^3.0.0","unified-lint-rule":"^3.0.0","unist-util-visit-parents":"^6.0.0"},"description":"remark-lint rule to check mdx jsx quotes","exports":"./index.js","funding":{"type":"opencollective","url":"https://opencollective.com/unified"},"keywords":["children","closing","empty","jsx","lint","mdx","remark","remark-lint","remark-lint-rule","rule","self","void"],"license":"MIT","name":"remark-lint-mdx-jsx-no-void-children","repository":{"type":"git","url":"git+https://github.com/remarkjs/remark-lint.git#main"},"scripts":{},"sideEffects":false,"typeCoverage":{"atLeast":100,"strict":true},"type":"module","version":"1.0.1","xo":{"prettier":true,"rules":{"capitalized-comments":"off","unicorn/prefer-code-point":"off","unicorn/prefer-switch":"off"}},"_id":"remark-lint-mdx-jsx-no-void-children@1.0.1","gitHead":"46ccbcd49deaada0172ad10425a2cd6b5f21a2c2","types":"./index.d.ts","homepage":"https://github.com/remarkjs/remark-lint/tree/main#readme","_nodeVersion":"23.1.0","_npmVersion":"11.0.0","dist":{"integrity":"sha512-zL20cvGc6Fqm60OiYVj+z1xiAfbQlI5ouZ8PlwbYY/uGpwrgv7BA2lcOetTFI2xdie1ono6sQMk+q9bpJKvaTg==","shasum":"015cd0ba80e7443c3ec0545b416abfedf344e22d","tarball":"https://registry.npmjs.org/remark-lint-mdx-jsx-no-void-children/-/remark-lint-mdx-jsx-no-void-children-1.0.1.tgz","fileCount":5,"unpackedSize":12364,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEUCIHwHuOPz8iRCjnRJAOHQctqgbbFhK5VogOo1y9NyN4xnAiEAjsrSyizZcDRAWio2JynbVaKzEjsRa+zjjNG2/eCq4Lk="}]},"_npmUser":{"name":"wooorm","email":"tituswormer@gmail.com"},"directories":{},"maintainers":[{"name":"wooorm","email":"tituswormer@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/remark-lint-mdx-jsx-no-void-children_1.0.1_1737981155437_0.748130210263044"},"_hasShrinkwrap":false}},"time":{"created":"2025-01-27T11:58:58.442Z","modified":"2025-01-27T12:32:35.800Z","1.0.0":"2025-01-27T11:58:58.627Z","1.0.1":"2025-01-27T12:32:35.635Z"},"bugs":{"url":"https://github.com/remarkjs/remark-lint/issues"},"author":{"name":"Titus Wormer","email":"tituswormer@gmail.com","url":"https://wooorm.com"},"license":"MIT","homepage":"https://github.com/remarkjs/remark-lint/tree/main#readme","keywords":["children","closing","empty","jsx","lint","mdx","remark","remark-lint","remark-lint-rule","rule","self","void"],"repository":{"type":"git","url":"git+https://github.com/remarkjs/remark-lint.git#main"},"description":"remark-lint rule to check mdx jsx quotes","contributors":[{"name":"Titus Wormer","email":"tituswormer@gmail.com"}],"maintainers":[{"name":"wooorm","email":"tituswormer@gmail.com"}],"readme":"<!--This file is generated-->\n\n# remark-lint-mdx-jsx-no-void-children\n\n[![Build][badge-build-image]][badge-build-url]\n[![Coverage][badge-coverage-image]][badge-coverage-url]\n[![Downloads][badge-downloads-image]][badge-downloads-url]\n[![Size][badge-size-image]][badge-size-url]\n[![Sponsors][badge-funding-sponsors-image]][badge-funding-url]\n[![Backers][badge-funding-backers-image]][badge-funding-url]\n[![Chat][badge-chat-image]][badge-chat-url]\n\n[`remark-lint`][github-remark-lint] rule to warn when void HTML elements (such as `<br>`)\nare seen with children.\n\n## Contents\n\n* [What is this?](#what-is-this)\n* [When should I use this?](#when-should-i-use-this)\n* [Presets](#presets)\n* [Install](#install)\n* [Use](#use)\n* [API](#api)\n  * [`unified().use(remarkLintMdxJsxNoVoidChildren[, options])`](#unifieduseremarklintmdxjsxnovoidchildren-options)\n* [Examples](#examples)\n* [Compatibility](#compatibility)\n* [Contribute](#contribute)\n* [License](#license)\n\n## What is this?\n\nThis package checks that HTML void elements are without children.\n\n## When should I use this?\n\nYou can use this package to check that HTML void elements are\nwithout children.\n\nThis package assumes semantics from HTML.\nIf you use MDX in a place without HTML you should not use this.\n\nThis package also checks `children` and `dangerouslySetInnerHTML` as it\nassumes the semantics that React applies to these names.\nIf how you use JSX conflicts with the React semantics this package may not\nwork for you.\n\n## Presets\n\nThis plugin is not included in presets maintained here.\n\n## Install\n\nThis package is [ESM only][github-gist-esm].\nIn Node.js (version 16+),\ninstall with [npm][npm-install]:\n\n```sh\nnpm install remark-lint-mdx-jsx-no-void-children\n```\n\nIn Deno with [`esm.sh`][esm-sh]:\n\n```js\nimport remarkLintMdxJsxNoVoidChildren from 'https://esm.sh/remark-lint-mdx-jsx-no-void-children@1'\n```\n\nIn browsers with [`esm.sh`][esm-sh]:\n\n```html\n<script type=\"module\">\n  import remarkLintMdxJsxNoVoidChildren from 'https://esm.sh/remark-lint-mdx-jsx-no-void-children@1?bundle'\n</script>\n```\n\n## Use\n\nOn the API:\n\n```js\nimport remarkLint from 'remark-lint'\nimport remarkLintMdxJsxNoVoidChildren from 'remark-lint-mdx-jsx-no-void-children'\nimport remarkParse from 'remark-parse'\nimport remarkStringify from 'remark-stringify'\nimport {read} from 'to-vfile'\nimport {unified} from 'unified'\nimport {reporter} from 'vfile-reporter'\n\nconst file = await read('example.md')\n\nawait unified()\n  .use(remarkParse)\n  .use(remarkLint)\n  .use(remarkLintMdxJsxNoVoidChildren)\n  .use(remarkStringify)\n  .process(file)\n\nconsole.error(reporter(file))\n```\n\nOn the CLI:\n\n```sh\nremark --frail --use remark-lint --use remark-lint-mdx-jsx-no-void-children .\n```\n\nOn the CLI in a config file (here a `package.json`):\n\n```diff\n …\n \"remarkConfig\": {\n   \"plugins\": [\n     …\n     \"remark-lint\",\n+    \"remark-lint-mdx-jsx-no-void-children\",\n     …\n   ]\n }\n …\n```\n\n## API\n\nThis package exports no identifiers.\nIt exports no additional [TypeScript][typescript] types.\nThe default export is\n[`remarkLintMdxJsxNoVoidChildren`][api-remark-lint-mdx-jsx-no-void-children].\n\n### `unified().use(remarkLintMdxJsxNoVoidChildren[, options])`\n\nWarn when void HTML elements (such as `<br>`) are seen with children.\n\n###### Parameters\n\nThere are no parameters.\n\n###### Returns\n\nTransform ([`Transformer` from `unified`][github-unified-transformer]).\n\n## Examples\n\n##### `ok.mdx`\n\n###### In\n\n> 👉 **Note**: this example uses\n> MDX ([`remark-mdx`][github-remark-mdx]).\n\n```mdx\n<b>Mercury</b> is the first planet from the Sun<br />\nand the smallest in the Solar System.\n```\n\n###### Out\n\nNo messages.\n\n##### `not-ok.mdx`\n\n###### In\n\n> 👉 **Note**: this example uses\n> MDX ([`remark-mdx`][github-remark-mdx]).\n\n```mdx\n**Mercury** is the first planet from<br>the</br>\nSun and the smallest in the Solar System.\n\n<hr children={'***'} />\n\n**Venus** is the second planet\nfrom <br dangerouslySetInnerHTML={{__html: 'the'}} />\nSun.\n```\n\n###### Out\n\n```text\n1:41-1:44: Unexpected children in known HTML void element, expected nothing\n4:5-4:21: Unexpected children in known HTML void element, expected nothing\n7:10-7:51: Unexpected children in known HTML void element, expected nothing\n```\n\n## Compatibility\n\nProjects maintained by the unified collective are compatible with maintained\nversions of Node.js.\n\nWhen we cut a new major release, we drop support for unmaintained versions of\nNode.\nThis means we try to keep the current release line,\n`remark-lint-mdx-jsx-no-void-children@1`,\ncompatible with Node.js 16.\n\n## Contribute\n\nSee [`contributing.md`][github-dotfiles-contributing] in [`remarkjs/.github`][github-dotfiles-health] for ways\nto get started.\nSee [`support.md`][github-dotfiles-support] for ways to get help.\n\nThis project has a [code of conduct][github-dotfiles-coc].\nBy interacting with this repository, organization, or community you agree to\nabide by its terms.\n\n## License\n\n[MIT][file-license] © [Titus Wormer][author]\n\n[api-remark-lint-mdx-jsx-no-void-children]: #unifieduseremarklintmdxjsxnovoidchildren-options\n\n[author]: https://wooorm.com\n\n[badge-build-image]: https://github.com/remarkjs/remark-lint/workflows/main/badge.svg\n\n[badge-build-url]: https://github.com/remarkjs/remark-lint/actions\n\n[badge-chat-image]: https://img.shields.io/badge/chat-discussions-success.svg\n\n[badge-chat-url]: https://github.com/remarkjs/remark/discussions\n\n[badge-coverage-image]: https://img.shields.io/codecov/c/github/remarkjs/remark-lint.svg\n\n[badge-coverage-url]: https://codecov.io/github/remarkjs/remark-lint\n\n[badge-downloads-image]: https://img.shields.io/npm/dm/remark-lint-mdx-jsx-no-void-children.svg\n\n[badge-downloads-url]: https://www.npmjs.com/package/remark-lint-mdx-jsx-no-void-children\n\n[badge-funding-backers-image]: https://opencollective.com/unified/backers/badge.svg\n\n[badge-funding-sponsors-image]: https://opencollective.com/unified/sponsors/badge.svg\n\n[badge-funding-url]: https://opencollective.com/unified\n\n[badge-size-image]: https://img.shields.io/bundlejs/size/remark-lint-mdx-jsx-no-void-children\n\n[badge-size-url]: https://bundlejs.com/?q=remark-lint-mdx-jsx-no-void-children\n\n[esm-sh]: https://esm.sh\n\n[file-license]: https://github.com/remarkjs/remark-lint/blob/main/license\n\n[github-dotfiles-coc]: https://github.com/remarkjs/.github/blob/main/code-of-conduct.md\n\n[github-dotfiles-contributing]: https://github.com/remarkjs/.github/blob/main/contributing.md\n\n[github-dotfiles-health]: https://github.com/remarkjs/.github\n\n[github-dotfiles-support]: https://github.com/remarkjs/.github/blob/main/support.md\n\n[github-gist-esm]: https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c\n\n[github-remark-lint]: https://github.com/remarkjs/remark-lint\n\n[github-remark-mdx]: https://mdxjs.com/packages/remark-mdx/\n\n[github-unified-transformer]: https://github.com/unifiedjs/unified#transformer\n\n[npm-install]: https://docs.npmjs.com/cli/install\n\n[typescript]: https://www.typescriptlang.org\n","readmeFilename":"readme.md"}