remark-lint
rule to warn for unexpected file extensions.
- What is this?
- When should I use this?
- Presets
- Install
- Use
- API
- Recommendation
- Examples
- Compatibility
- Contribute
- License
This package checks the file extension.
You can use this package to check that file extensions are consistent.
This plugin is included in the following presets:
Preset | Options |
---|---|
remark-preset-lint-markdown-style-guide |
'md' |
This package is ESM only. In Node.js (version 16+), install with npm:
npm install remark-lint-file-extension
In Deno with esm.sh
:
import remarkLintFileExtension from 'https://esm.sh/remark-lint-file-extension@3'
In browsers with esm.sh
:
<script type="module">
import remarkLintFileExtension from 'https://esm.sh/remark-lint-file-extension@3?bundle'
</script>
On the API:
import remarkLint from 'remark-lint'
import remarkLintFileExtension from 'remark-lint-file-extension'
import remarkParse from 'remark-parse'
import remarkStringify from 'remark-stringify'
import {read} from 'to-vfile'
import {unified} from 'unified'
import {reporter} from 'vfile-reporter'
const file = await read('example.md')
await unified()
.use(remarkParse)
.use(remarkLint)
.use(remarkLintFileExtension)
.use(remarkStringify)
.process(file)
console.error(reporter(file))
On the CLI:
remark --frail --use remark-lint --use remark-lint-file-extension .
On the CLI in a config file (here a package.json
):
…
"remarkConfig": {
"plugins": [
…
"remark-lint",
+ "remark-lint-file-extension",
…
]
}
…
This package exports no identifiers.
It exports the TypeScript types
Extensions
and
Options
.
The default export is
remarkLintFileExtension
.
Warn for unexpected extensions.
-
options
(Extensions
orOptions
, optional) — configuration
Transform (Transformer
from unified
).
File extension(s) (TypeScript type).
type Extensions = Array<string> | string
Configuration (TypeScript type).
-
allowExtensionless
(boolean
, default:true
) — allow no file extension such asAUTHORS
orLICENSE
-
extensions
(Extensions
, default:['mdx', 'md']
) — allowed file extension(s)
Use md
as it’s the most common.
Also use md
when your markdown contains common syntax extensions (such as
GFM, frontmatter, or math).
Do not use md
for MDX: use mdx
instead.
No messages.
No messages.
No messages.
When configured with { allowExtensionless: false }
.
1:1: Unexpected missing file extension, expected `mdx` or `md`
1:1: Unexpected file extension `mkd`, expected `mdx` or `md`
When configured with 'mkd'
.
No messages.
When configured with [ 'markdown', 'md', 'mdown', 'mdwn', 'mdx', 'mkd', 'mkdn', 'mkdown', 'ron' ]
.
1:1: Unexpected file extension `css`, expected `markdown`, `md`, `mdown`, …
Projects maintained by the unified collective are compatible with maintained versions of Node.js.
When we cut a new major release, we drop support for unmaintained versions of
Node.
This means we try to keep the current release line,
remark-lint-file-extension@3
,
compatible with Node.js 16.
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.