unified

Project: remarkjs/remark-lint

Package: remark-lint-file-extension@1.0.5

  1. Dependencies: 1·Dependents: 17
  2. remark-lint rule to warn when the file’s extension violates the given style
  1. remark 182
  2. lint 68
  3. rule 64
  4. remark-lint-rule 63
  5. file 31

remark-lint-file-extension

Build Coverage Downloads Size Sponsors Backers Chat

Warn when the file extension differ from the preferred extension.

Does not warn when given documents have no file extensions (such as AUTHORS or LICENSE).

Options: string, default: 'md' — Expected file extension.

Presets

This rule is included in the following presets:

PresetSetting
remark-preset-lint-markdown-style-guide'md'

Example

readme.md
Out

No messages.

readme
Out

No messages.

readme.mkd
Out
1:1: Incorrect extension: use `md`
readme.mkd

When configured with 'mkd'.

Out

No messages.

Install

npm:

npm install remark-lint-file-extension

Use

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

 …
 "remarkConfig": {
   "plugins": [
     …
     "lint",
+    "lint-file-extension",
     …
   ]
 }
 …

Or use it on the CLI directly

remark -u lint -u lint-file-extension 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-file-extension'))
   .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