remark-lint-no-heading-punctuation
!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-urlremark-lint
github-remark-lint rule to warn when headings end in irregular characters.Contents
unified().use(remarkLintNoHeadingPunctuation[, options])
What is this?
This package checks heading text.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 onlygithub-gist-esm. In Node.js (version 16+), install with npmnpm-install:npm install remark-lint-no-heading-punctuation
In Deno with
esm.sh
esm-sh:import remarkLintNoHeadingPunctuation from 'https://esm.sh/remark-lint-no-heading-punctuation@4'
In browsers with
esm.sh
esm-sh:<script type="module">
import remarkLintNoHeadingPunctuation from 'https://esm.sh/remark-lint-no-heading-punctuation@4?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 TypeScripttypescript types. The default export isremarkLintNoHeadingPunctuation
api-remark-lint-no-heading-punctuation.unified().use(remarkLintNoHeadingPunctuation[, options])
Warn when headings end in irregular characters.Parameters
options
(RegExp
orstring
, default:/[!,.:;?]/u
)
new RegExp('[' + x + ']', 'u')
so make sure to
escape regexp charactersReturns
Transform (Transformer
from unified
github-unified-transformer).Examples
ok.md
In
# Mercury
Out
No messages.not-ok.md
In
# Mercury:
# Venus?
# Earth!
# Mars,
# Jupiter;
Out
1:1-1:11: Unexpected character `:` at end of heading, remove it
3:1-3:9: Unexpected character `?` at end of heading, remove it
5:1-5:9: Unexpected character `!` at end of heading, remove it
7:1-7:8: Unexpected character `,` at end of heading, remove it
9:1-9:11: Unexpected character `;` at end of heading, remove it
ok.md
When configured with ',;:!?'
.In
# Mercury…
Out
No messages.regex.md
When configured with { source: '[^A-Za-z0-9]' }
.In
# Mercury!
Out
1:1-1:11: Unexpected character `!` at end of heading, remove it
example.mdx
In
👉 Note: this example uses
MDX (remark-mdx
github-remark-mdx).
<h1>Mercury?</h1>
Out
1:1-1:18: Unexpected character `?` at end of heading, remove it
not-ok-options.md
When configured with 1
.Out
1:1: Unexpected value `1` for `options`, expected `RegExp` or `string`
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@4
,
compatible with Node.js 16.Contribute
Seecontributing.md
github-dotfiles-contributing in remarkjs/.github
github-dotfiles-health for ways
to get started.
See support.md
github-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.