@metamask/eslint-config

@metamask/eslint-config

MetaMask's base ESLint configuration.

Usage

Our default export contains a base set of ESLint rules for ES6+:

yarn add --dev \
    @metamask/eslint-config@^14.0.0 \
    eslint@^9.11.0 \
    eslint-config-prettier@^9.1.0 \
    eslint-plugin-import-x@^4.3.0 \
    eslint-plugin-jsdoc@^50.2.4 \
    eslint-plugin-prettier@^5.2.1 \
    eslint-plugin-promise@^7.1.0 \
    prettier@^3.3.3

The order in which you extend ESLint rules matters. The @metamask/* eslint configs should be added to the config array last, with @metamask/eslint-config first, and @metamask/eslint-config-* in any order thereafter.

import base, { createConfig } from '@metamask/eslint-config';

const config = createConfig({
  {
    extends: [
      // Any custom shared config should be added here.
      // ...

      // This should be added last unless you know what you're doing.
      base,
    ],
  }
});