remark-lint/packages/remark-lint-no-heading-punctuation

remark-lint-no-heading-punctuation

remark-lint rule to warn when headings end in punctuation.

Contents

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

What is this?

This package checks the style of hedings.

When should I use this?

You can use this package to check that heading text is consistent.

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-heading-punctuation

In Deno with esm.sh:

import remarkLintNoHeadingPunctuation from 'https://esm.sh/remark-lint-no-heading-punctuation@3'

In browsers with esm.sh:

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

Use

On the API:

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

console.error(reporter(file))

On the CLI:

remark --frail --use remark-lint --use remark-lint-no-heading-punctuation .

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

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

API

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

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

Warn when headings end in punctuation.

Parameters

• options (string, default: '!,\\.:;?') — configuration, wrapped in new RegExp('[' + x + ']') so make sure to escape regexp characters

Returns

Transform (Transformer from unified).

Examples

ok.md

In

# Hello

Out

No messages.

ok.md

When configured with ',;:!?'.

In

# Hello…

Out

No messages.

not-ok.md

In

# Hello:

# Hello?

# Hello!

# Hello,

# Hello;

Out

1:1-1:9: Don’t add a trailing `:` to headings
3:1-3:9: Don’t add a trailing `?` to headings
5:1-5:9: Don’t add a trailing `!` to headings
7:1-7:9: Don’t add a trailing `,` to headings
9:1-9:9: Don’t add a trailing `;` to headings

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-heading-punctuation@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