remark-lint
rule to warn when file names contain irregular characters.
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 file names contain regular characters.
Presets
This rule is included in the following presets:
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-irregular-characters
In Deno with Skypack:
import remarkLintNoFileNameIrregularCharacters from 'https://cdn.skypack.dev/remark-lint-no-file-name-irregular-characters@2?dts'
In browsers with Skypack:
<script type="module">
import remarkLintNoFileNameIrregularCharacters from 'https://cdn.skypack.dev/remark-lint-no-file-name-irregular-characters@2?min'
</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 remarkLintNoFileNameIrregularCharacters from 'remark-lint-no-file-name-irregular-characters'
main()
async function main() {
const file = await remark()
.use(remarkLint)
.use(remarkLintNoFileNameIrregularCharacters)
.process(await read('example.md'))
console.error(reporter(file))
}
On the CLI:
remark --use remark-lint --use remark-lint-no-file-name-irregular-characters example.md
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.
The default export is remarkLintNoFileNameIrregularCharacters
.
This rule supports standard configuration that all remark lint rules accept
(such as false
to turn it off or [1, options]
to configure it).
The following options (default: '\\.a-zA-Z0-9-'
) are accepted:
string
(example '\w\\.'
)
— allowed characters, wrapped in new RegExp('[^' + x + ']')
, make sure
to double escape regexp charactersRegExp
(example /[^\.a-zA-Z0-9-]/
)
— disallowed pattern
Examples
plug-ins.md
Out
No messages.
plugins.md
Out
No messages.
plug_ins.md
Out
1:1: Do not use `_` in a file name
plug ins.md
Out
1:1: Do not use ` ` in a file name
README.md
When configured with '\\.a-z0-9'
.
Out
1:1: Do not use `R` 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.
License
MIT © Titus Wormer