eslint-plugin-md weekly downloads statistics

eslint-plugin-md

An ESLint plugin to lint and fix markdown files. It uses amazing remark-lint under the hood. Also enables using prettier to automatically format your markdown files right from eslint!

Motivation

ESLint is a tool for linting Javascript. There is another plugin called eslint-plugin-markdown, however it is still only linting Javascript parts inside *.md files, and leaves Markdown itself untouched.

Wouldn't it be cool, if we could use ESLint to enforce style of Markdown itself? That is what this plugin is for!

Installation

You'll first need to install ESLint:

Next, install eslint-plugin-md:

Note: If you installed ESLint globally (using the npm -g or yarn global) then you must also install eslint-plugin-md globally.

Usage

Add plugin:md/recommended config to extends section of your your .eslintrc configuration file

And this is it! By default it will apply all rules from Markdown style guide.

Note: By default ESLint won't lint \*.md files. So:

• If you use ESLint from CLI, use --ext parameter (e.g. eslint . --ext js,md) • If you use VSCode with ESLint plugin, add "eslint.validate": ["markdown"] in your VSCode preferences

Usage with eslint-plugin-prettier

Prettier is an amazing code formatter that supports many languages, including markdown. It is common to use prettier as a rule in ESLint via amazing eslint-plugin-prettier.

This plugin can play nicely together with eslint-plugin-prettier (meaning that first code will be formatted via prettier, and then remark rules will be applied). Typical eslint configuration will look like this:

Modifying eslint setup for js code inside \*.md files

By default, code inside fenced code block marked as js language (` js // .eslintrc.js module.exports = { extends: ['plugin:md/recommended'], overrides: [ { files: ['*.md'], parser: 'markdown-eslint-parser', }, { files: ['*.md.js'], // Will match js code inside *.md files rules: { // Example - disable 2 core eslint rules 'no-unused-vars' and 'no-undef' 'no-unused-vars': 'off', 'no-undef': 'off', }, }, ], } js // .eslintrc.js module.exports = { extends: ['plugin:md/recommended'], rules: { 'md/remark': [ 'error', { // This object corresponds to object you would export in .remarkrc file plugins: ['preset-lint-markdown-style-guide', 'frontmatter', ['lint-maximum-line-length', false]], }, ], }, overrides: [ { files: ['*.md'], parser: 'markdown-eslint-parser', }, ], } bash yarn add -D remark-lint-alphabetize-lists js // .eslintrc.js module.exports = { extends: ['plugin:md/recommended'], rules: { 'md/remark': [ 'error', { // This object corresponds to object you would export in .remarkrc file plugins: ['preset-lint-markdown-style-guide', 'frontmatter', 'remark-lint-alphabetize-lists'], }, ], }, overrides: [ { files: ['*.md'], parser: 'markdown-eslint-parser', }, ], } ```

Description from the npm listing.