17.10.0 • Published 13 days ago

@wordpress/eslint-plugin v17.10.0

Weekly downloads
22,207
License
GPL-2.0-or-later
Repository
github
Last release
13 days ago

ESLint Plugin

ESLint plugin including configurations and custom rules for WordPress development.

Installation

Install the module

npm install @wordpress/eslint-plugin --save-dev

Note: This package requires node 14.0.0 or later, and npm 6.14.4 or later. It is not compatible with older versions.

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-jsdoc, eslint-plugin-jsx-a11y, eslint-plugin-react, and other similar plugins.

This preset offers an optional integration with the eslint-plugin-prettier package that runs Prettier code formatter and reports differences as individual ESLint issues. You can activate it by installing the prettier package separately with:

npm install prettier --save-dev

Finally, this ruleset also includes an optional integration with the @typescript-eslint/eslint-plugin package that enables ESLint to support TypeScript language. You can activate it by installing the typescript package separately with:

npm install typescript --save-dev

There is also recommended-with-formatting ruleset for projects that want to ensure that Prettier and TypeScript integration is never activated. This preset has the native ESLint code formatting rules enabled instead.

Rulesets

Alternatively, you can opt-in to only the more granular rulesets offered by the plugin. These include:

  • custom – custom rules for WordPress development.
  • es5 – rules for legacy ES5 environments.
  • esnext – rules for ES2015+ environments.
  • i18n – rules for internationalization.
  • jsdoc – rules for JSDoc comments.
  • jsx-a11y – rules for accessibility in JSX.
  • react – rules for React components.
  • test-e2e – rules for end-to-end tests written in Puppeteer.
  • test-unit– rules for unit tests written in Jest.
  • test-playwright – rules for end-to-end tests written in Playwright.

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

RuleDescriptionRecommended
data-no-store-string-literalsDiscourage passing string literals to reference data stores
dependency-groupEnforce dependencies docblocks formatting
is-gutenberg-pluginGoverns the use of the process.env.IS_GUTENBERG_PLUGIN constant
no-base-control-with-label-without-idDisallow the usage of BaseControl component with a label prop set but omitting the id property
no-unguarded-get-range-atDisallow the usage of unguarded getRangeAt calls
no-unsafe-wp-apisDisallow the usage of unsafe APIs from @wordpress/* packages
no-unused-vars-before-returnDisallow assigning variable values if unused before a return
react-no-unsafe-timeoutDisallow unsafe setTimeout in component
valid-sprintfEnforce valid sprintf usage
i18n-ellipsisDisallow using three dots in translatable strings
i18n-no-collapsible-whitespaceDisallow collapsible whitespace in translatable strings
i18n-no-placeholders-onlyPrevent using only placeholders in translatable strings
i18n-no-variablesEnforce string literals as translation function arguments
i18n-text-domainEnforce passing valid text domains
i18n-translator-commentsEnforce adding translator comments
i18n-no-flanking-whitespaceDisallow leading or trailing whitespace in translatable strings
i18n-hyphenated-rangeDisallow hyphenated numerical ranges in translatable strings

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" ]
}

Contributing to this package

This is an individual package that's part of the Gutenberg project. The project is organized as a monorepo. It's made up of multiple self-contained software packages, each with a specific purpose. The packages in this monorepo are published to npm and used by WordPress as well as other software projects.

To find out more about contributing to this package or Gutenberg as a whole, please read the project's main contributor guide.

17.10.0

13 days ago

17.9.0

27 days ago

17.8.1

28 days ago

17.8.0

1 month ago

17.7.0

2 months ago

17.6.0

2 months ago

17.5.0

3 months ago

14.12.0

7 months ago

14.9.0

9 months ago

17.3.0

4 months ago

13.10.4

5 months ago

15.0.0

7 months ago

15.0.1

7 months ago

14.11.0

8 months ago

17.4.0

4 months ago

17.0.0

6 months ago

15.1.0

7 months ago

14.10.0

9 months ago

17.1.0

5 months ago

14.8.2

5 months ago

16.0.9

5 months ago

16.0.12

4 months ago

16.0.8

5 months ago

16.0.13

4 months ago

16.0.7

5 months ago

17.2.0

5 months ago

16.0.10

5 months ago

16.0.11

5 months ago

16.0.2

6 months ago

16.0.1

6 months ago

16.0.0

6 months ago

16.0.6

5 months ago

16.0.5

5 months ago

16.0.4

5 months ago

16.0.3

6 months ago

14.6.0

10 months ago

14.7.0

10 months ago

14.8.1

9 months ago

14.8.0

10 months ago

14.1.0

1 year ago

14.5.0

11 months ago

14.2.0

1 year ago

14.3.0

12 months ago

14.4.0

11 months ago

13.9.0

1 year ago

13.7.0

1 year ago

13.5.0

1 year ago

13.1.1

1 year ago

13.3.0

1 year ago

13.1.0

2 years ago

12.8.0

2 years ago

13.10.0

1 year ago

12.4.0

2 years ago

13.10.1

1 year ago

13.10.2

1 year ago

12.6.0

2 years ago

12.0.0

2 years ago

12.0.1

2 years ago

12.2.0

2 years ago

13.10.3

1 year ago

11.0.0

2 years ago

11.0.1

2 years ago

13.8.0

1 year ago

13.6.0

1 year ago

13.4.0

1 year ago

13.2.0

1 year ago

14.0.0

1 year ago

13.0.0

2 years ago

12.7.0

2 years ago

12.9.0

2 years ago

12.3.0

2 years ago

12.5.0

2 years ago

12.1.0

2 years ago

11.1.0

2 years ago

10.0.0

2 years ago

10.0.1

2 years ago

10.0.2

2 years ago

9.3.0

2 years ago

9.2.0

2 years ago

9.1.2

3 years ago

9.1.1

3 years ago

9.1.0

3 years ago

9.0.6

3 years ago

9.0.5

3 years ago

9.0.4

3 years ago

9.0.3

3 years ago

9.0.2

3 years ago

9.0.1

3 years ago

9.0.0

3 years ago

8.0.0-next.1

3 years ago

8.0.2

3 years ago

8.0.1

3 years ago

8.0.0

3 years ago

8.0.0-next.0

3 years ago

7.4.0

3 years ago

7.3.0

3 years ago

7.2.1

4 years ago

7.2.0

4 years ago

7.1.0

4 years ago

7.1.0-rc.0

4 years ago

7.0.0

4 years ago

6.1.0

4 years ago

6.0.0

4 years ago

5.1.0

4 years ago

5.0.1

4 years ago

5.0.0

4 years ago

4.1.0

4 years ago

4.0.0

4 years ago

3.4.0

4 years ago

3.4.1

4 years ago

3.3.0

4 years ago

3.2.0

4 years ago

3.1.0

5 years ago

3.0.0

5 years ago

2.4.0

5 years ago

2.3.0

5 years ago

2.2.0

5 years ago

2.1.0

5 years ago

2.0.0

5 years ago

1.0.1

5 years ago

1.0.0

5 years ago