unified

Project:remarkjs/remark-lint

Package:remark-lint-no-file-name-irregular-characters@1.0.3

  1. Dependencies:1·Dependents:12
  2. remark-lint rule to warn when file names contain irregular characters
  1. remark 165
  2. lint 70
  3. rule 64
  4. file 14
  5. name 5
  6. character 2

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

Build Coverage Downloads Size Sponsors Backers Chat

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:

PresetSetting
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

npm:

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

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:

 var remark = require('remark');
 var report = require('vfile-reporter');

 remark()
   .use(require('remark-lint'))
+  .use(require('remark-lint-no-file-name-irregular-characters'))
   .process('_Emphasis_ and **importance**', function (err, file) {
     console.error(report(err || 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, organisation, or community you agree to abide by its terms.

License

MIT © Titus Wormer