JSPM

remark-lint-no-file-name-consecutive-dashes

1.0.5
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 94486
  • Score
    100M100P100Q199614F
  • License MIT

remark-lint rule to warn when file names contain consecutive dashes

Package Exports

  • remark-lint-no-file-name-consecutive-dashes

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (remark-lint-no-file-name-consecutive-dashes) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

remark-lint-no-file-name-consecutive-dashes

Build Coverage Downloads Size Sponsors Backers Chat

Warn when file names contain consecutive dashes.

Presets

This rule is included in the following presets:

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

Example

plug-ins.md
Out

No messages.

plug--ins.md
Out
1:1: Do not use consecutive dashes in a file name

Install

npm:

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

Use

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

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

Or use it on the CLI directly

remark -u lint -u lint-no-file-name-consecutive-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-consecutive-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, organization, or community you agree to abide by its terms.

License

MIT © Titus Wormer