remark-lint rule to warn when file names contain irregular characters.
Contents
What is this?
This package checks file names.
When should I use this?
You can use this package to check that file names are consistent.
Presets
This plugin is included in the following presets:
Install
This package is ESM only. In Node.js (version 16+), install with npm:
npm install remark-lint-no-file-name-irregular-characters
In Deno with esm.sh:
import remarkLintNoFileNameIrregularCharacters from 'https://esm.sh/remark-lint-no-file-name-irregular-characters@3'
In browsers with esm.sh:
<script type="module">
import remarkLintNoFileNameIrregularCharacters from 'https://esm.sh/remark-lint-no-file-name-irregular-characters@3?bundle'
</script>
Use
On the API:
import remarkLint from 'remark-lint'
import remarkLintNoFileNameIrregularCharacters from 'remark-lint-no-file-name-irregular-characters'
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(remarkLintNoFileNameIrregularCharacters)
.use(remarkStringify)
.process(file)
console.error(reporter(file))
On the CLI:
remark --frail --use remark-lint --use remark-lint-no-file-name-irregular-characters .
On the CLI in a config file (here a package.json):
…
"remarkConfig": {
"plugins": [
…
"remark-lint",
+ "remark-lint-no-file-name-irregular-characters",
…
]
}
…
API
This package exports no identifiers. It exports no additional TypeScript types. The default export is remarkLintNoFileNameIrregularCharacters.
Warn when file names contain contain irregular characters.
Parameters
options (RegExp or string, default: /[^-.\dA-Za-z]/) — configuration, when string wrapped in new RegExp('[^' + x + ']') so make sure to escape regexp characters
Returns
Transform (Transformer from unified).
Examples
mercury-and-venus.md
Out
No messages.
mercury.md
Out
No messages.
mercury_and_venus.md
Out
1:1: Unexpected character `_` in file name
Readme.md
When configured with '\\.a-z0-9'.
Out
1:1: Unexpected character `R` in file name
mercury_and_venus.md
When configured with { source: '[^\\.a-z0-9]' }.
Out
1:1: Unexpected character `_` in file name
mercury and venus.md
Out
1:1: Unexpected character ` ` in file name
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-file-name-irregular-characters@3, compatible with Node.js 16.
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.
License
MIT © Titus Wormer