remark-lint-file-extension

remark-lint-file-extension

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:

Preset	Setting
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