Package Exports
- remark-lint-no-file-name-consecutive-dashes
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (remark-lint-no-file-name-consecutive-dashes) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
remark-lint-no-file-name-consecutive-dashes
Warn when file names contain consecutive dashes.
Presets
This rule is included in the following presets:
| Preset | Setting |
|---|---|
remark-preset-lint-markdown-style-guide |
Example
plug-ins.md
Out
No messages.
plug--ins.md
Out
1:1: Do not use consecutive dashes in a file nameInstall
This package is ESM only:
Node 12+ is needed to use it and it must be importeded instead of requiredd.
npm:
npm install remark-lint-no-file-name-consecutive-dashesThis package exports no identifiers.
The default export is remarkLintNoFileNameConsecutiveDashes.
Use
You probably want to use it on the CLI through a config file:
…
"remarkConfig": {
"plugins": [
…
"lint",
+ "lint-no-file-name-consecutive-dashes",
…
]
}
…Or use it on the CLI directly
remark -u lint -u lint-no-file-name-consecutive-dashes readme.mdOr use this on the API:
import {remark} from 'remark'
import {reporter} from 'vfile-reporter'
import remarkLint from 'remark-lint'
import remarkLintNoFileNameConsecutiveDashes from 'remark-lint-no-file-name-consecutive-dashes'
remark()
.use(remarkLint)
+ .use(remarkLintNoFileNameConsecutiveDashes)
.process('_Emphasis_ and **importance**')
.then((file) => {
console.error(reporter(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.