@10up/eslint-config

10up Eslint Config

ESLint shareable config

@10up/eslint-config is a shareable configuration package for eslint built on top of eslint-airbnb-config and modified to meet 10up's own standards.

Installation

1. Install all peer dependencies

npx install-peerdeps --dev @10up/eslint-config@next

1. Install @10up/eslint-config as a development dependecy of your project:

npm install @10up/eslint-config --save-dev

Avaliable ESLint configs

@10up/eslint-config

The default export and contains common rules that are not specific to any framework or environment.

@10up/eslint-config/react

Extends @10up/eslint-config adding specific rules to react.

This rule requires installing babel-eslint

npm install --save-dev 'babel-eslint

@10up/eslint-config/gutenberg

Extends @10up/eslint-config/react adding the custom gutenberg rules from @wordpress/eslint-plugin.

This rule requires installing the @wordpress/eslint-plugin package.

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

@10up/eslint-config/node

Extends @10up/eslint-config adding specific rules to Node.js.

@10up/eslint-config/jest

Adds specic rules for the jest testing framework.

This rule requires installing eslint-plugin-jest

npm install --save-dev eslint-plugin-jest

Usage

In order to use this config, choose the one you want and add this configuration to your package.json:

{
    "eslintConfig": {
        "extends": "@10up/eslint-config"
    }
}

Or add a .eslintrc.js file to your project root containing:

module.exports = {
	extends: '@10up/eslint-config',
};

Support Level

Active: 10up is actively working on this, and we expect to continue work for the foreseeable future including keeping tested up to the most recent version of WordPress. Bug reports, feature requests, questions, and pull requests are welcome.

Like what you see?