Package Exports

remark-lint-file-extension

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-file-extension) 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-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

This package is ESM only: Node 12+ is needed to use it and it must be importeded instead of requiredd.

npm:

npm install remark-lint-file-extension

This package exports no identifiers. The default export is remarkLintFileExtension.

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:

 import {remark} from 'remark'
 import {reporter} from 'vfile-reporter'
 import remarkLint from 'remark-lint'
 import remarkLintFileExtension from 'remark-lint-file-extension'

 remark()
   .use(remarkLint)
+  .use(remarkLintFileExtension)
   .process('_Emphasis_ and **importance**')
   .then((file) => {
     console.error(reporter(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.