ESLint Plugin
ESLint plugin including configurations and custom rules for WordPress development.
Installation
Install the module
npm install @wordpress/eslint-plugin --save-dev
Usage
To opt-in to the default configuration, extend your own project's .eslintrc
file:
{
"extends": [ "plugin:@wordpress/eslint-plugin/recommended" ]
}
Refer to the ESLint documentation on Shareable Configs for more information.
The recommended
preset will include rules governing an ES2015+ environment, and includes rules from the eslint-plugin-jsx-a11y
and eslint-plugin-react
projects.
Rulesets
Alternatively, you can opt-in to only the more granular rulesets offered by the plugin. These include:
For example, if your project does not use React, you could consider extending including only the ESNext rules in your project using the following extends
definition:
{
"extends": [ "plugin:@wordpress/eslint-plugin/esnext" ]
}
These rules can be used additively, so you could extend both esnext
and custom
rulesets, but omit the react
and jsx-a11y
configurations.
The granular rulesets will not define any environment globals. As such, if they are required for your project, you will need to define them yourself.
Rules
Legacy
If you are using WordPress' .jshintrc
JSHint configuration and you would like to take the first step to migrate to an ESLint equivalent it is also possible to define your own project's .eslintrc
file as:
{
"extends": [ "plugin:@wordpress/eslint-plugin/jshint" ]
}