remark-lint-no-html

!Buildbadge-build-imagebadge-build-url !Coveragebadge-coverage-imagebadge-coverage-url !Downloadsbadge-downloads-imagebadge-downloads-url !Sizebadge-size-imagebadge-size-url !Sponsorsbadge-funding-sponsors-imagebadge-funding-url !Backersbadge-funding-backers-imagebadge-funding-url !Chatbadge-chat-imagebadge-chat-url
remark-lintgithub-remark-lint rule to warn when HTML is used.

Contents

• What is this?
• When should I use this?
• Presets
• Install
• Use
• API

unified().use(remarkLintNoHtml[, options]) Options

• Examples
• Compatibility
• Contribute
• License

What is this?

This package checks HTML.

When should I use this?

You can use this package to check that no HTML is used.

Presets

This plugin is not included in presets maintained here.

Install

This package is ESM onlygithub-gist-esm. In Node.js (version 16+), install with npmnpm-install:

npm install remark-lint-no-html

In Deno with esm.shesm-sh:

import remarkLintNoHtml from 'https://esm.sh/remark-lint-no-html@4'

In browsers with esm.shesm-sh:

<script type="module">
  import remarkLintNoHtml from 'https://esm.sh/remark-lint-no-html@4?bundle'
</script>

Use

On the API:

import remarkLint from 'remark-lint'
import remarkLintNoHtml from 'remark-lint-no-html'
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(remarkLintNoHtml)
  .use(remarkStringify)
  .process(file)

console.error(reporter(file))

On the CLI:

remark --frail --use remark-lint --use remark-lint-no-html .

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

…
"remarkConfig": {
  "plugins": [
    …
    "remark-lint",
+    "remark-lint-no-html",
    …
  ]
}
…

API

This package exports no identifiers. It exports the TypeScripttypescript type Optionsapi-options. The default export is remarkLintNoHtmlapi-remark-lint-no-html.

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

Warn when HTML is used.

Parameters

• options (Optionsapi-options, optional)

— configuration

Returns

Transform (Transformer from unifiedgithub-unified-transformer).

Options

Configuration (TypeScript type).

Fields

• allowComments (boolean, default: true)

— allow comments or not

Examples

ok.md

In

# Mercury

<!--Venus-->

Out

No messages.

not-ok.md

In

<h1>Mercury</h1>

Out

1:1-1:17: Unexpected HTML, use markdown instead

not-ok.md

When configured with { allowComments: false }.

In

<!--Mercury-->

Out

1:1-1:15: Unexpected HTML, use markdown instead

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-no-html@4, compatible with Node.js 16.

Contribute

See contributing.mdgithub-dotfiles-contributing in remarkjs/.githubgithub-dotfiles-health for ways to get started. See support.mdgithub-dotfiles-support for ways to get help.
This project has a code of conductgithub-dotfiles-coc. By interacting with this repository, organization, or community you agree to abide by its terms.

License

MITfile-license © Titus Wormerauthor