@wagtail/eslint-config-wagtail

@wagtail/eslint-config-wagtail

Shareable ESLint config for Wagtail, based on airbnb/javascript.

The package provides Wagtail's .eslintrc as an extensible shared config.

Usage

Our default export contains all of our ESLint rules, including Airbnb's config (which has ECMAScript 6 and React). It requires eslint, as well as the configuration’s peer dependencies.

# npm v7:
npm install --save-dev @wagtail/eslint-config-wagtail@latest
# npm v6 and below:
npx install-peerdeps --dev @wagtail/eslint-config-wagtail@latest

Links

• ESLint
• eslint-config-airbnb

Contribution Guidelines

Install

• Required Node
• We recommend using nvm
• Clone the project on to your computer
• Run nvm install to ensure you have the correct Node version
• Run npm install to install project dependencies
• Ensure your editor is set up to use editorconfig, Prettier and Eslint

Development

• Run nvm use to set Node to the correct version
• Run tests via npm run test
• Run linting via npm run lint
• Run preflight checks before commiting final code via npm run preflight
• Note: When working with the rule set, only modify the index.js file, not the .eslintrc file as it is for local linting only

Changelog

v0.4.0 - 2021-12-23)

• Update to ESLint v8 and eslint-config-airbnb v19.0.2, changing rules that are applied with this config.

There are a number of existing rules that are now enforced:

• default-case-last
• default-param-last
• grouped-accessor-pairs
• no-constructor-return
• no-dupe-else-if
• no-import-assign
• no-loss-of-precision
• no-promise-executor-return
• no-restricted-exports (restricted: default, then)
• no-setter-return
• no-unreachable-loop
• no-useless-backreference
• prefer-exponentiation-operator (** over Math.pow)
• prefer-regex-literals
• react/jsx-no-script-url
• react/jsx-no-useless-fragment

And brand new rules introduced with this release:

• no-nonoctal-decimal-escape
• no-unsafe-optional-chaining
• import/no-import-module-exports
• import/no-relative-packages
• react/no-arrow-function-lifecycle
• react/no-invalid-html-attribute
• react/no-namespace
• react/no-unstable-nested-components
• react/no-unused-class-component-methods
• react/jsx-no-constructed-context-values

BREAKING CHANGES

This release updates most of the dependencies of the config:

| package | from | to | | ------------------------- | ------- | ------- | | eslint | ^7.2.0 | ^8.2.0 | | eslint-config-airbnb | ^18.2.1 | ^19.0.2 | | eslint-config-prettier | | ^8.3.0 | | eslint-plugin-react | ^7.24.0 | ^7.27.1 | | eslint-plugin-react-hooks | ^4.2.0 | ^4.3.0 | | eslint-plugin-jsx-a11y | ^6.4.1 | ^6.5.1 | | eslint-plugin-import | ^2.23.4 | ^2.25.3 |

Users of npm v7 can npm install --save-dev @wagtail/eslint-config-wagtail@latest and this will automatically install all required peer dependencies.

For older versions of npm, use npx install-peerdeps --dev @wagtail/eslint-config-wagtail@latest so all other peerDependencies are updated as well.