README.md

@metamask/eslint-config-commonjs

MetaMask's ESLint configuration for projects using CommonJS.

Usage

yarn add --dev \
    @metamask/eslint-config@^12.0.0 \
    @metamask/eslint-config-commonjs@^12.0.0 \
    eslint@^8.45.0 \
    eslint-config-prettier@^8.5.0 \
    eslint-plugin-import@~2.26.0 \
    eslint-plugin-jsdoc@^41.1.2 \
    eslint-plugin-prettier@^4.2.1 \
    eslint-plugin-promise@^6.1.1 \
    prettier@^2.7.1

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

module.exports = {
  extends: [
    // This should be added last unless you know what you're doing.
    '@metamask/eslint-config',
    '@metamask/eslint-config-commonjs',
  ],
};