Registry / testing / eslint-plugin-markdownlint

eslint-plugin-markdownlint

JSON →
library0.9.0jsnpmunverified

ESLint plugin that integrates markdownlint (v0.9.0) as ESLint rules for linting Markdown files. It uses a custom parser to parse Markdown and applies markdownlint rules (mdXXX codes) within ESLint. The plugin supports both flat configs (ESLint >=9) and legacy .eslintrc overrides. It is actively maintained with monthly releases, but has known limitations: no support for .mdlrc config files or rule aliases (only mdXXX codes), and no plans for tag-based rule selection. It requires ESLint >=7.5.0 as a peer dependency.

npm install eslint-plugin-markdownlint
INSTALL
IMPORT
SIG · ESLINT-PLUGIN-MARK
E
eslint-plugin-markdownlint
testingjavascriptv0.9.0
Install
Import
Disk
Pass rate
0/ 6
Env Coverage0 / 6
glibc
1822
musl
1822
Install & Compatibility
Where this runs
tested against v? · npm install
Install × environment matrix
Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux
musl
node 18226 runs
build_error
glibc
node 18226 runs
build_error
Code
Verified usage

Verified import paths — ran on the pinned version, not inferred.

markdownlintPlugin
import markdownlintPlugin from 'eslint-plugin-markdownlint'
const markdownlintPlugin = require('eslint-plugin-markdownlint')
ESM import is required for flat configs. CommonJS require works in legacy configs but not recommended.
markdownlintParser
import markdownlintParser from 'eslint-plugin-markdownlint/parser'
import markdownlintParser from 'eslint-plugin-markdownlint'
The parser is a separate export at the /parser subpath. Do not import it from the main entry.
plugin:markdownlint/recommended
extends: ['plugin:markdownlint/recommended']
extends: ['eslint-plugin-markdownlint/recommended']
In legacy .eslintrc, use the plugin prefix 'plugin:markdownlint/recommended', not the full npm package name.

Shows how to set up eslint-plugin-markdownlint with flat config (ESLint >=9) and legacy .eslintrc.

// Install: npm install eslint-plugin-markdownlint --save-dev // eslint.config.js (flat config, ESLint >=9) import markdownlintPlugin from 'eslint-plugin-markdownlint'; import markdownlintParser from 'eslint-plugin-markdownlint/parser'; export default [ { files: ['**/*.md'], plugins: { markdownlint: markdownlintPlugin }, languageOptions: { parser: markdownlintParser }, rules: { ...markdownlintPlugin.configs.recommended.rules } } ]; // Legacy .eslintrc.json { "overrides": [{ "files": ["*.md"], "parser": "eslint-plugin-markdownlint/parser", "extends": ["plugin:markdownlint/recommended"] }] }
Debug
Known issues
breakingFlat config (ESLint >=9) requires ES module imports; CommonJS require will not work in eslint.config.js.
fix
Use `import` syntax and ensure package.json has \"type\": \"module\" or use .mjs extension.
affects: >=0.5.0
deprecatedLegacy .eslintrc config format is deprecated in ESLint >=9. Future versions may drop support.
fix
Migrate to eslint.config.js flat config.
affects: >=0.5.0
gotchaRule aliases (e.g., 'no-hard-tabs' for md010) are not supported. Only mdXXX codes work.
fix
Use rule codes like \"md010\" instead of descriptive names.
affects: >=0.0.0
gotchaExternal config files (.mdlrc, .markdownlintrc) are not supported. All configuration must be done via ESLint rules.
fix
Configure all markdownlint rules in ESLint's rules section.
affects: >=0.0.0
Errors
Common errors & fixes
ESLint: Error: Failed to load parser 'eslint-plugin-markdownlint/parser' declared in 'parser' field: Module not found
Missing required peer dependency or incorrect installation.
fix
Run `npm install eslint-plugin-markdownlint --save-dev` to install the plugin and its parser.
Error: Cannot find module 'eslint-plugin-markdownlint/parser'
Import path for parser is incorrect or module is not installed.
fix
Ensure the package is installed and import path is correct: import from 'eslint-plugin-markdownlint/parser'.
Configuration for rule 'markdownlint/md001' is invalid: Expected object with optional properties 'level', 'arguments', ...
Rule configuration format is incorrect; markdownlint rules expect specific options.
fix
Check markdownlint rule documentation for the correct option structure, e.g., \"md001\": [\"error\", { properties... }].
Upgrade
Version history
0.9.0latest on npm
Audit
Dependencies

No dependency data recorded yet.

Agent activity
2 hits · last 30 days
node
2
Resources
eslint-plugin-markdownlint — npm install eslint-plugin-markdownlint · libregistry