mirror of
https://github.com/remarkjs/remark-lint.git
synced 2024-09-19 23:57:10 +03:00
201e995044
Reviewed-by: Christian Murphy <christian.murphy.42@gmail.com> Reviewed-by: Titus Wormer <tituswormer@gmail.com> Closes GH-272. Closes GH-273. |
||
---|---|---|
.. | ||
index.js | ||
package.json | ||
readme.md | ||
tsconfig.json |
remark-lint-no-file-name-outer-dashes
Warn when file names contain initial or final dashes (hyphen-minus, -
).
Presets
This rule is included in the following presets:
Preset | Setting |
---|---|
remark-preset-lint-markdown-style-guide |
Example
readme.md
Out
No messages.
-readme.md
Out
1:1: Do not use initial or final dashes in a file name
readme-.md
Out
1:1: Do not use initial or final dashes in a file name
Install
This package is ESM only:
Node 12+ is needed to use it and it must be imported
ed instead of required
d.
npm:
npm install remark-lint-no-file-name-outer-dashes
This package exports no identifiers.
The default export is remarkLintNoFileNameOuterDashes
.
Use
You probably want to use it on the CLI through a config file:
…
"remarkConfig": {
"plugins": [
…
"lint",
+ "lint-no-file-name-outer-dashes",
…
]
}
…
Or use it on the CLI directly
remark -u lint -u lint-no-file-name-outer-dashes readme.md
Or use this on the API:
import {remark} from 'remark'
import {reporter} from 'vfile-reporter'
import remarkLint from 'remark-lint'
import remarkLintNoFileNameOuterDashes from 'remark-lint-no-file-name-outer-dashes'
remark()
.use(remarkLint)
+ .use(remarkLintNoFileNameOuterDashes)
.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.