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

remark-lint-no-heading-punctuation

Warn when a heading ends with a group of characters.

Options: string, default: '.,;:!?'.

Note: these are added to a regex, in a group ('[' + char + ']'), be careful to escape the string correctly.

Presets

This rule is included in the following presets:

Preset	Setting
remark-preset-lint-markdown-style-guide	':.'

Example

ok.md

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

ok.md

When configured with ',;:!?'.

In

# Hello…

Out

No messages.

Install

npm:

npm install remark-lint-no-heading-punctuation

Use

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

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

Or use it on the CLI directly

remark -u lint -u lint-no-heading-punctuation readme.md

Or use this on the API:

 var remark = require('remark')
 var report = require('vfile-reporter')

 remark()
   .use(require('remark-lint'))
+  .use(require('remark-lint-no-heading-punctuation'))
   .process('_Emphasis_ and **importance**', function (err, file) {
     console.error(report(err || 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