remark-lint-no-file-name-irregular-characters

remark-lint-no-file-name-irregular-characters

Warn when file names contain irregular characters: characters other than alphanumericals (a-zA-Z0-9), hyphen-minus (-), and dots (., full stops).

Options: RegExp or string, default: '\\.a-zA-Z0-9-'.

If a string is given, it will be wrapped in new RegExp('[^' + preferred + ']').

Any match by the wrapped or given expressions creates a message.

Presets

This rule is included in the following presets:

Preset	Setting
remark-preset-lint-markdown-style-guide

Example

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

Install

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-irregular-characters

This package exports no identifiers. The default export is remarkLintNoFileNameIrregularCharacters.

Use

You probably want to use it on the CLI through a config file:

 …
 "remarkConfig": {
   "plugins": [
     …
     "lint",
+    "lint-no-file-name-irregular-characters",
     …
   ]
 }
 …

Or use it on the CLI directly

remark -u lint -u lint-no-file-name-irregular-characters readme.md

Or use this on the API:

 import {remark} from 'remark'
 import {reporter} from 'vfile-reporter'
 import remarkLint from 'remark-lint'
 import remarkLintNoFileNameIrregularCharacters from 'remark-lint-no-file-name-irregular-characters'

 remark()
   .use(remarkLint)
+  .use(remarkLintNoFileNameIrregularCharacters)
   .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.

License

MIT © Titus Wormer