All rules must be documented so they can be searched in GitHub Pages. Documentation is auto-generated using the generate-docs script. Most ESLint plugins provide individual rules' documentation with the file structure of docs/<rule-name>.md in their source. Some plugins will ship the docs directory within their package, others exclude them by not providing the docs directory within their package configuration.

• When docs are shipped with the NPM module, use the writeFromModules method.
• When docs exist, but are not available within node_modules, use the writeFromGitHub method.
• When no docs are provided, create individual markdown files, following docs/static/<plugin-name>/<rule-name>.md, and use the writeFromStatic method.

Adding plugins is fairly straightforward.

Step 1

• To simply use a recommended configuration, add the plugin as a dependency and add config to the config directory that imports the recommended rules and the plugin itself. Then add the config to the exported array in index.js.
• To configure custom rules for a plugin, add a new file, rules/<plugin-name>.js, and export the rules object. Then add the config by following the details in the previous step, however, use the custom rules by themselves or with the exported recommended rules of the plugin.
• If the new plugin lints a new file type, add a index.<filetype> file to the filetypes directory and update the lint:eslint script in package.json to include the new extension.

Step 2

Add your new plugin to the docs-config helper, specifiying the necessary properties required to generate the documentation.

Step 3

Verify everything builds as expected.

npm install
npm run lint
npm run test
npm run docs:dev
# navigate to the URL provided by Vuepress