remark-lint-emphasis-marker

remark-lint-emphasis-marker

Warn for violating emphasis markers.

Options: 'consistent', '*', or '_', default: 'consistent'.

'consistent' detects the first used emphasis style and warns when subsequent emphasis use different styles.

Fix

remark-stringify formats emphasis using _ (underscore) by default. Pass emphasis: '*' to use * (asterisk) instead.

See Using remark to fix your Markdown on how to automatically fix warnings for this rule.

Presets

This rule is included in the following presets:

Preset	Setting
remark-preset-lint-consistent	'consistent'
remark-preset-lint-markdown-style-guide	'*'

Example

ok.md

When configured with '*'.

In

*foo*

Out

No messages.

not-ok.md

When configured with '*'.

In

_foo_

Out

1:1-1:6: Emphasis should use `*` as a marker

ok.md

When configured with '_'.

In

_foo_

Out

No messages.

not-ok.md

When configured with '_'.

In

*foo*

Out

1:1-1:6: Emphasis should use `_` as a marker

not-ok.md

In

*foo*
_bar_

Out

2:1-2:6: Emphasis should use `*` as a marker

not-ok.md

When configured with '💩'.

Out

1:1: Incorrect emphasis marker `💩`: use either `'consistent'`, `'*'`, or `'_'`

Install

This package is ESM only: Node 12+ is needed to use it and it must be importeded instead of requiredd.

npm:

npm install remark-lint-emphasis-marker

This package exports no identifiers. The default export is remarkLintEmphasisMarker.

Use

You probably want to use it on the CLI through a config file:

 …
 "remarkConfig": {
   "plugins": [
     …
     "lint",
+    "lint-emphasis-marker",
     …
   ]
 }
 …

Or use it on the CLI directly

remark -u lint -u lint-emphasis-marker readme.md

Or use this on the API:

 import {remark} from 'remark'
 import {reporter} from 'vfile-reporter'
 import remarkLint from 'remark-lint'
 import remarkLintEmphasisMarker from 'remark-lint-emphasis-marker'

 remark()
   .use(remarkLint)
+  .use(remarkLintEmphasisMarker)
   .process('_Emphasis_ and **importance**')
   .then((file) => {
     console.error(reporter(file))
   })

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