remark-lint-no-file-name-consecutive-dashes
remark-lint
rule to warn when consecutive dashes appear in file names.
Contents
What is this?
This package is a unified (remark) plugin, specifically a remark-lint
rule. Lint rules check markdown code style.
When should I use this?
You can use this package to check that no consecutive dashes appear in file names.
Presets
This rule is included in the following presets:
Preset | Setting |
---|---|
remark-preset-lint-markdown-style-guide |
Install
This package is ESM only. In Node.js (version 12.20+, 14.14+, or 16.0+), install with npm:
npm install remark-lint-no-file-name-consecutive-dashes
In Deno with esm.sh
:
import remarkLintNoFileNameConsecutiveDashes from 'https://esm.sh/remark-lint-no-file-name-consecutive-dashes@2'
In browsers with esm.sh
:
<script type="module">
import remarkLintNoFileNameConsecutiveDashes from 'https://esm.sh/remark-lint-no-file-name-consecutive-dashes@2?bundle'
</script>
Use
On the API:
import {read} from 'to-vfile'
import {reporter} from 'vfile-reporter'
import {remark} from 'remark'
import remarkLint from 'remark-lint'
import remarkLintNoFileNameConsecutiveDashes from 'remark-lint-no-file-name-consecutive-dashes'
main()
async function main() {
const file = await remark()
.use(remarkLint)
.use(remarkLintNoFileNameConsecutiveDashes)
.process(await read('example.md'))
console.error(reporter(file))
}
On the CLI:
remark --use remark-lint --use remark-lint-no-file-name-consecutive-dashes example.md
On the CLI in a config file (here a package.json
):
…
"remarkConfig": {
"plugins": [
…
"remark-lint",
+ "remark-lint-no-file-name-consecutive-dashes",
…
]
}
…
API
This package exports no identifiers. The default export is remarkLintNoFileNameConsecutiveDashes
.
unified().use(remarkLintNoFileNameConsecutiveDashes[, config])
This rule supports standard configuration that all remark lint rules accept (such as false
to turn it off or [1, options]
to configure it).
There are no options.
Examples
plug-ins.md
Out
No messages.
plug--ins.md
Out
1:1: Do not use consecutive dashes in a file name
Compatibility
Projects maintained by the unified collective are compatible with all maintained versions of Node.js. As of now, that is Node.js 12.20+, 14.14+, and 16.0+. Our projects sometimes work with older versions, but this is not guaranteed.
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.