remark-lint/packages/remark-lint-no-emphasis-as-heading

remark-lint-no-emphasis-as-heading

remark-lint rule to warn when emphasis or strong are used instead of a heading.

Contents

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

What is this?

This package checks emphasis and strong.

When should I use this?

You can use this package to check that headings are used.

Presets

This plugin is included in the following presets:

Preset	Options
remark-preset-lint-markdown-style-guide

Install

This package is ESM only. In Node.js (version 16+), install with npm:

npm install remark-lint-no-emphasis-as-heading

In Deno with esm.sh:

import remarkLintNoEmphasisAsHeading from 'https://esm.sh/remark-lint-no-emphasis-as-heading@3'

In browsers with esm.sh:

<script type="module">
  import remarkLintNoEmphasisAsHeading from 'https://esm.sh/remark-lint-no-emphasis-as-heading@3?bundle'
</script>

Use

On the API:

import remarkLint from 'remark-lint'
import remarkLintNoEmphasisAsHeading from 'remark-lint-no-emphasis-as-heading'
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(remarkLintNoEmphasisAsHeading)
  .use(remarkStringify)
  .process(file)

console.error(reporter(file))

On the CLI:

remark --frail --use remark-lint --use remark-lint-no-emphasis-as-heading .

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

 …
 "remarkConfig": {
   "plugins": [
     …
     "remark-lint",
+    "remark-lint-no-emphasis-as-heading",
     …
   ]
 }
 …

API

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

unified().use(remarkLintNoEmphasisAsHeading)

Warn when emphasis or strong are used instead of a heading.

Parameters

There are no options.

Returns

Transform (Transformer from unified).

Recommendation

While not always the case, typically emphasis or strong around the text in a paragraph is used as a “faux” heading. It’s recommended to use actual headings instead.

Examples

ok.md

In

# Foo

Bar.

Out

No messages.

not-ok.md

In

*Foo*

Bar.

__Qux__

Quux.

Out

1:1-1:6: Don’t use emphasis to introduce a section, use a heading
5:1-5:8: Don’t use emphasis to introduce a section, use a heading

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-emphasis-as-heading@3, compatible with Node.js 12.

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