remark-lint-rule-style
!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 thematic breaks (horizontal rules) are
inconsistent.Contents
unified().use(remarkLintRuleStyle[, options])
Options
What is this?
This package checks markers and whitespace of thematic rules.When should I use this?
You can use this package to check that thematic breaks are consistent.Presets
This plugin is included in the following presets:| Preset | Options | | - | - | |
remark-preset-lint-consistent
| 'consistent'
|
| 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-rule-style
In Deno with
esm.sh
esm-sh:import remarkLintRuleStyle from 'https://esm.sh/remark-lint-rule-style@4'
In browsers with
esm.sh
esm-sh:<script type="module">
import remarkLintRuleStyle from 'https://esm.sh/remark-lint-rule-style@4?bundle'
</script>
Use
On the API:import remarkLint from 'remark-lint'
import remarkLintRuleStyle from 'remark-lint-rule-style'
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(remarkLintRuleStyle)
.use(remarkStringify)
.process(file)
console.error(reporter(file))
On the CLI:
remark --frail --use remark-lint --use remark-lint-rule-style .
On the CLI in a config file (here a
package.json
):…
"remarkConfig": {
"plugins": [
…
"remark-lint",
+ "remark-lint-rule-style",
…
]
}
…
API
This package exports no identifiers. It exports the TypeScripttypescript typeOptions
api-options.
The default export is
remarkLintRuleStyle
api-remark-lint-rule-style.unified().use(remarkLintRuleStyle[, options])
Warn when thematic breaks (horizontal rules) are inconsistent.Parameters
options
(Options
api-options, default:'consistent'
)
Options
Configuration (TypeScript type).'consistent'
string
(example:'** * **'
,'___'
)
Type
type Options = string | 'consistent'
Recommendation
Rules consist of a*
, -
, or _
character,
which occurs at least three times with nothing else except for arbitrary
spaces or tabs on a single line.
Using spaces, tabs, or more than three markers is unnecessary work to type
out.
As asterisks can be used as a marker for more markdown constructs,
it’s recommended to use that for rules (and lists, emphasis, strong) too.
So it’s recommended to pass '***'
.Fix
remark-stringify
github-remark-stringify formats rules with ***
by
default.
There are three settings to control rules:rule
(default:'*'
) — markerruleRepetition
(default:3
) — repetitionsruleSpaces
(default:false
) — use spaces between markers
Examples
ok.md
In
Two rules:
* * *
* * *
Out
No messages.ok.md
When configured with '_______'
.In
_______
_______
Out
No messages.not-ok.md
In
***
* * *
Out
3:1-3:6: Unexpected thematic rule `* * *`, expected `***`
not-ok.md
When configured with '🌍'
.Out
1:1: Unexpected value `🌍` for `options`, expected thematic rule or `'consistent'`
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-rule-style@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.