@metamask/eslint-config

This monorepo contains MetaMask's ESLint configurations as npm packages. The different configs are split up into individual packages so that we can correctly specify their peer dependencies.

Contributing

Setup

• Install the current LTS version of Node.js
  • If you are using nvm (recommended) running nvm install will install the latest version and running nvm use will automatically choose the right node version for you.
• Install Yarn v3
• Run yarn install to install dependencies and run any required post-install scripts

Testing and Linting

Run yarn lint to run the linter, or run yarn lint:fix to run the linter and fix any automatically fixable issues.

Updating or Adding Configs

Configs targeting an entirely new environment should be added in a new package. Our rule validation script (see ./scripts/validate-rules.js) forbids the following rules:

• Rules that override Prettier's recommended ESLint rules
• Uselessly configured rules, meaning:
  • Rules that are disabled but never enabled by an extended config.
  • Rules that are configured identically by the package's extended configs.
• For the purpose of determining the "usefulness" of rules, we include our base config (@metamask/eslint-config) in the set of extended configs, since it should always be extended by the consumer in practice.

Linting will fail in CI if any of the above conditions are violated in any config.

Finally, in order to understand the impact of changing rules or the set of extended configs, each package has a rules-snapshot.json fill which contains all rules of the particular config and its extended configs in a single dictionary. When editing a package, always check its rules snapshots after running yarn lint:fix to understand which rules changed.

Release & Publishing

The project follows the same release process as the other libraries in the MetaMask organization. The GitHub Actions action-create-release-pr and action-publish-release are used to automate the release process; see those repositories for more information about how they work.

1. Choose a release version.

2. The release version should be chosen according to SemVer. Analyze the changes to see whether they include any breaking changes, new features, or deprecations, then choose the appropriate SemVer version. See the SemVer specification for more information.

3. If this release is backporting changes onto a previous release, then ensure there is a major version branch for that version (e.g. 1.x for a v1 backport release).

4. The major version branch should be set to the most recent release with that major version. For example, when backporting a v1.0.2 release, you'd want to ensure there was a 1.x branch that was set to the v1.0.1 tag.

5. Trigger the workflow_dispatch event manually for the Create Release Pull Request action to create the release PR.

6. For a backport release, the base branch should be the major version branch that you ensured existed in step 2. For a normal release, the base branch should be the main branch for that repository (which should be the default value).

7. This should trigger the action-create-release-pr workflow to create the release PR.

8. Update the changelog to move each change entry into the appropriate change category (See here for the full list of change categories, and the correct ordering), and edit them to be more easily understood by users of the package.

9. Generally any changes that don't affect consumers of the package (e.g. lockfile changes or development environment changes) are omitted. Exceptions may be made for changes that might be of interest despite not having an effect upon the published package (e.g. major test improvements, security improvements, improved documentation, etc.).

10. Try to explain each change in terms that users of the package would understand (e.g. avoid referencing internal variables/concepts).
11. Consolidate related changes into one change entry if it makes it easier to explain.

12. Run yarn auto-changelog validate --rc to check that the changelog is correctly formatted.

13. Review and QA the release.

14. If changes are made to the base branch, the release branch will need to be updated with these changes and review/QA will need to restart again. As such, it's probably best to avoid merging other PRs into the base branch while review is underway.

15. Squash & Merge the release.

16. This should trigger the action-publish-release workflow to tag the final release commit and publish the release on GitHub.

17. Publish the release on npm.

18. Wait for the publish-release GitHub Action workflow to finish. This should trigger a second job (publish-npm), which will wait for a run approval by the npm publishers team.

19. Approve the publish-npm job (or ask somebody on the npm publishers team to approve it for you).
20. Once the publish-npm job has finished, check npm to verify that it has been published.

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

Unreleased

14.0.0

Added

• BREAKING: Add peer dependency on typescript-eslint@^8.6.0. (#370)
• BREAKING: Add peer dependency on eslint-import-resolver-typescript@^3.6.3 (#370)
• BREAKING: Add peer dependency on eslint-plugin-import-x@^4.3.0 (#370)
• BREAKING: Add peer dependency on eslint-plugin-jsdoc@^50.2.4 (#370)

Changed

• BREAKING: Bump minimum Node.js version from 16 to 18.18 (#371)
• BREAKING: Bump peer dependency on ESLint from ^8.57.0 to ^9.11.0 (#370)
  • ESLint 9 requires flat configs, so this change also rewrites the configs to use flat configs. The legacy config format is no longer supported.
• BREAKING: Bump peer dependency on @metamask/eslint-config from ^13.0.0 to ^14.0.0 (#377)
• BREAKING: Change package to be pure ESM (#370)
  • ESLint 9 supports ESM out-of-the-box, so this change updates the package to be pure ESM. This means that the package can no longer be used with CommonJS require syntax.

Removed

• Remove peer dependency on @typescript-eslint/eslint-plugin and @typescript-eslint/parser (#370)

13.0.0

Changed

• BREAKING: Bump TypeScript to v5.5 (#364)
  • Also bump relevant @typescript-eslint packages.
• BREAKING: Replace eslint-plugin-import with eslint-plugin-import-x (#366)
• BREAKING: Bump all ESLint dependencies (#351)
  • Bumps all ESLint dependencies to the latest version compatible with Node.js 16.
• BREAKING: Bump minimum Node.js version from 14 to 16 (#332, #339)

12.1.0

Changed

• Add support for typescript 5.0.x, 5.1.x (#288)

12.0.0

Added

• BREAKING: Add rule to enforce generic parameters have a length of at least 3 characters (#292)
• BREAKING: Enable @typescript-eslint/consistent-type-imports rule (#284)
• BREAKING: Enable @typescript-eslint/prefer-enum-initializers rule (#269)

Changed

• BREAKING: Update peer dependency @metamask/eslint-config to v12
• Disable naming convention for properties that require quotes (#293)

11.1.0

Changed

• Exclude test files from package (#266)

11.0.2

Changed

• Allow async functions without any 'await' (#262)
• Allow parameters to use PascalCase (#264)

11.0.0

Added

• BREAKING: Add rules that require type information (#250)
  • This requires setting some parser options. See the README for more details.
• BREAKING: Bump all ESLint dependencies to the latest version (#252)
  • This includes peer dependencies.
• BREAKING: Forbid TypeScript's private modifier in favour of hash names (#244)

10.0.0

Changed

• BREAKING: Update ESLint from v7 to v8 (#233)
  • This is breaking because eslint is a peerDependency.
  • Four new rules have been added:
    • no-loss-of-precision
    • no-nonoctal-decimal-escape
    • no-unsafe-optional-chaining
    • no-useless-backreference
• BREAKING: Update @typescript-eslint parser and plugin (#230)
  • This is breaking because these two packages are peerDependencies
  • There are two new rules:
    • @typescript-eslint/no-loss-of-precision
    • @typescript-eslint/no-unnecessary-type-constraint.
• BREAKING: Update minimum Node.js version to v14 (#225)
• BREAKING: Forbid TypeScript interfaces (#216)
• Ignore rest siblings for no-unused-vars (#213)
  • This makes the no-unused-vars rule more permissive

9.0.1

Changed

• Disable @typescript-eslint/no-throw-literal (#210)
  • The introduction of this rule was one of the two breaking changes in the previous release. It was included unintentionally, and has now been removed to make updating to v9 easier.

9.0.0

Added

• BREAKING: Add JSDoc ESLint rules (#203)

Changed

• BREAKING: Disable no-throw-literal and enable @typescript-eslint/no-throw-literal (#201)
  • This rule requires type information, which requires additional project setup.
  • Note: This change has been undone in v9.0.1. You can ignore this change if you're updating to v9.0.1 or greater.

8.0.0

Changed

• BREAKING: The peer dependency @metamask/eslint-config has been updated from v7 to v8.

7.0.1

Fixed

• Restore default parserOptions.ecmaVersion (#193)
  • In some cases, parserOptions.ecmaVersion could be set to an incorrect version. The ecmaVersion is now explicitly set to 2020, matching the corresponding setting in env.

7.0.0

Changed

• BREAKING: Update @typescript/no-shadow config (#168)
• Use recommended eslint-plugin-import rule sets (#184)
  • This only removed or disabled rules, and is not breaking.
• Update install instructions in readme (#185)

Fixed

• Add @metamask/eslint-config as a peer dependency (#186)
  • This package is designed to be used in conjunction with the MetaMask base ESLint config, so this should always have been a peer dependency.

6.0.0 - 2021-04-08

Changed

• BREAKING: Set minimum Node.js version to ^12.0.0 (#144)
• BREAKING: Set ECMAScript version to es2020/11 (#150)
• BREAKING: Enable all rules recommended by the @typescript-eslint plugin (#156)
  • This amounted to setting the following core ESLint rules to error:
    • no-var
    • prefer-const
    • prefer-rest-params
    • prefer-spread
• Publish this config as its own package (#141)
  • The contents of this package were previously published as part of @metamask/eslint-config. For changes prior to version 6.0.0, please refer to the changelog of that package.
  • To continue extending this config, install this package and update your .eslintrc.js extends array to include @metamask/eslint-config-typescript instead of @metamask/eslint-config/typescript.
• Update eslint and other ESLint peer dependencies (#151)