unified

Project:remarkjs/remark-lint

Package:remark-lint-no-file-name-outer-dashes@1.0.4

  1. Dependencies:1·Dependents:14
  2. remark-lint rule to warn when file names contain initial or final dashes
  1. remark 165
  2. lint 70
  3. rule 64
  4. file 14
  5. name 5
  6. dash 2
  7. hyphen 2

remark-lint-no-file-name-outer-dashes

Build Coverage Downloads Size Sponsors Backers Chat

Warn when file names contain initial or final dashes (hyphen-minus, -).

Presets

This rule is included in the following presets:

PresetSetting
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

npm:

npm install remark-lint-no-file-name-outer-dashes

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:

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

 remark()
   .use(require('remark-lint'))
+  .use(require('remark-lint-no-file-name-outer-dashes'))
   .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