@metamask/eslint-config-typescript 13.0.0 → 14.0.0

package/CHANGELOG.md

@@ -1,4 +1,5 @@
 # Changelog
+
 All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
@@ -6,40 +7,78 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [14.0.0]
+
+### Added
+
+- **BREAKING:** Add peer dependency on `typescript-eslint@^8.6.0`. ([#370](https://github.com/MetaMask/eslint-config/pull/370))
+- **BREAKING:** Add peer dependency on `eslint-import-resolver-typescript@^3.6.3` ([#370](https://github.com/MetaMask/eslint-config/pull/370))
+- **BREAKING:** Add peer dependency on `eslint-plugin-import-x@^4.3.0` ([#370](https://github.com/MetaMask/eslint-config/pull/370))
+- **BREAKING:** Add peer dependency on `eslint-plugin-jsdoc@^50.2.4` ([#370](https://github.com/MetaMask/eslint-config/pull/370))
+
+### Changed
+
+- **BREAKING:** Bump minimum Node.js version from 16 to 18.18 ([#371](https://github.com/MetaMask/eslint-config/pull/371))
+- **BREAKING:** Bump peer dependency on ESLint from `^8.57.0` to `^9.11.0` ([#370](https://github.com/MetaMask/eslint-config/pull/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](https://github.com/MetaMask/eslint-config/pull/377))
+- **BREAKING:** Change package to be pure ESM ([#370](https://github.com/MetaMask/eslint-config/pull/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](https://github.com/MetaMask/eslint-config/pull/370))
+
 ## [13.0.0]
+
 ### Changed
-- **BREAKING**: Bump TypeScript to v5.5 ([#364](https://github.com/MetaMask/eslint-config/pull/364))
+
+- **BREAKING:** Bump TypeScript to v5.5 ([#364](https://github.com/MetaMask/eslint-config/pull/364))
   - Also bump relevant `@typescript-eslint` packages.
-- **BREAKING**: Replace `eslint-plugin-import` with `eslint-plugin-import-x` ([#366](https://github.com/MetaMask/eslint-config/pull/366))
-- **BREAKING**: Bump all ESLint dependencies ([#351](https://github.com/MetaMask/eslint-config/pull/351))
+- **BREAKING:** Replace `eslint-plugin-import` with `eslint-plugin-import-x` ([#366](https://github.com/MetaMask/eslint-config/pull/366))
+- **BREAKING:** Bump all ESLint dependencies ([#351](https://github.com/MetaMask/eslint-config/pull/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](https://github.com/MetaMask/eslint-config/pull/332), [#339](https://github.com/MetaMask/eslint-config/pull/339))
+- **BREAKING:** Bump minimum Node.js version from 14 to 16 ([#332](https://github.com/MetaMask/eslint-config/pull/332), [#339](https://github.com/MetaMask/eslint-config/pull/339))
 
 ## [12.1.0]
+
 ### Changed
+
 - Add support for typescript 5.0.x, 5.1.x ([#288](https://github.com/MetaMask/eslint-config/pull/288))
 
 ## [12.0.0]
+
 ### Added
+
 - **BREAKING:** Add rule to enforce generic parameters have a length of at least 3 characters ([#292](https://github.com/MetaMask/eslint-config/pull/292))
 - **BREAKING:** Enable `@typescript-eslint/consistent-type-imports` rule ([#284](https://github.com/MetaMask/eslint-config/pull/284))
 - **BREAKING:** Enable `@typescript-eslint/prefer-enum-initializers` rule ([#269](https://github.com/MetaMask/eslint-config/pull/269))
 
 ### Changed
+
 - **BREAKING:** Update peer dependency `@metamask/eslint-config` to v12
 - Disable naming convention for properties that require quotes ([#293](https://github.com/MetaMask/eslint-config/pull/293))
 
 ## [11.1.0]
+
 ### Changed
+
 - Exclude test files from package ([#266](https://github.com/MetaMask/eslint-config/pull/266))
 
 ## [11.0.2]
+
 ### Changed
+
 - Allow async functions without any 'await' ([#262](https://github.com/MetaMask/eslint-config/pull/262))
 - Allow parameters to use PascalCase ([#264](https://github.com/MetaMask/eslint-config/pull/264))
 
 ## [11.0.0]
+
 ### Added
+
 - **BREAKING:** Add rules that require type information ([#250](https://github.com/MetaMask/eslint-config/pull/250))
   - This requires setting some parser options. See the README for more details.
 - **BREAKING:** Bump all ESLint dependencies to the latest version ([#252](https://github.com/MetaMask/eslint-config/pull/252))
@@ -47,7 +86,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - **BREAKING:** Forbid TypeScript's private modifier in favour of hash names ([#244](https://github.com/MetaMask/eslint-config/pull/244))
 
 ## [10.0.0]
+
 ### Changed
+
 - **BREAKING:** Update ESLint from v7 to v8 ([#233](https://github.com/MetaMask/eslint-config/pull/233))
   - This is breaking because `eslint` is a `peerDependency`.
   - Four new rules have been added:
@@ -66,42 +107,56 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
   - This makes the `no-unused-vars` rule more permissive
 
 ## [9.0.1]
+
 ### Changed
+
 - Disable `@typescript-eslint/no-throw-literal` ([#210](https://github.com/MetaMask/eslint-config/pull/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](https://github.com/MetaMask/eslint-config/pull/203))
 
 ### Changed
+
 - **BREAKING:** Disable `no-throw-literal` and enable `@typescript-eslint/no-throw-literal` ([#201](https://github.com/MetaMask/eslint-config/pull/201))
   - This rule requires type information, which requires [additional project setup](https://github.com/typescript-eslint/typescript-eslint/blob/master/docs/getting-started/linting/TYPED_LINTING.md).
   - 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](https://github.com/MetaMask/eslint-config/pull/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`.
+    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](https://github.com/MetaMask/eslint-config/pull/168))
 - Use recommended `eslint-plugin-import` rule sets ([#184](https://github.com/MetaMask/eslint-config/pull/184))
   - This only removed or disabled rules, and is not breaking.
 - Update install instructions in readme ([#185](https://github.com/MetaMask/eslint-config/pull/185))
 
 ### Fixed
+
 - Add `@metamask/eslint-config` as a peer dependency ([#186](https://github.com/MetaMask/eslint-config/pull/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](https://github.com/MetaMask/eslint-config/pull/144))
 - **BREAKING:** Set ECMAScript version to `es2020`/`11` ([#150](https://github.com/MetaMask/eslint-config/pull/150))
 - **BREAKING:** Enable all rules recommended by the `@typescript-eslint` plugin ([#156](https://github.com/MetaMask/eslint-config/pull/156))
@@ -112,21 +167,22 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
     - [prefer-spread](https://eslint.org/docs/7.0.0/rules/prefer-spread)
 - Publish this config as its own package ([#141](https://github.com/MetaMask/eslint-config/pull/141))
   - The contents of this package were previously published as part of [`@metamask/eslint-config`](https://npmjs.com/package/@metamask/eslint-config).
-  For changes prior to version `6.0.0`, please refer to the changelog of that package.
+    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](https://github.com/MetaMask/eslint-config/pull/151))
 
-[Unreleased]: https://github.com/MetaMask/eslint-config/compare/v13.0.0...HEAD
-[13.0.0]: https://github.com/MetaMask/eslint-config/compare/v12.1.0...v13.0.0
-[12.1.0]: https://github.com/MetaMask/eslint-config/compare/v12.0.0...v12.1.0
-[12.0.0]: https://github.com/MetaMask/eslint-config/compare/v11.1.0...v12.0.0
-[11.1.0]: https://github.com/MetaMask/eslint-config/compare/v11.0.2...v11.1.0
-[11.0.2]: https://github.com/MetaMask/eslint-config/compare/v11.0.0...v11.0.2
-[11.0.0]: https://github.com/MetaMask/eslint-config/compare/v10.0.0...v11.0.0
-[10.0.0]: https://github.com/MetaMask/eslint-config/compare/v9.0.1...v10.0.0
-[9.0.1]: https://github.com/MetaMask/eslint-config/compare/v9.0.0...v9.0.1
-[9.0.0]: https://github.com/MetaMask/eslint-config/compare/v8.0.0...v9.0.0
-[8.0.0]: https://github.com/MetaMask/eslint-config/compare/v7.0.1...v8.0.0
-[7.0.1]: https://github.com/MetaMask/eslint-config/compare/v7.0.0...v7.0.1
-[7.0.0]: https://github.com/MetaMask/eslint-config/compare/v6.0.0...v7.0.0
-[6.0.0]: https://github.com/MetaMask/eslint-config/releases/tag/v6.0.0
+[Unreleased]: https://github.com/MetaMask/eslint-config/compare/@metamask/eslint-config-typescript@14.0.0...HEAD
+[14.0.0]: https://github.com/MetaMask/eslint-config/compare/@metamask/eslint-config-typescript@13.0.0...@metamask/eslint-config-typescript@14.0.0
+[13.0.0]: https://github.com/MetaMask/eslint-config/compare/@metamask/eslint-config-typescript@12.1.0...@metamask/eslint-config-typescript@13.0.0
+[12.1.0]: https://github.com/MetaMask/eslint-config/compare/@metamask/eslint-config-typescript@12.0.0...@metamask/eslint-config-typescript@12.1.0
+[12.0.0]: https://github.com/MetaMask/eslint-config/compare/@metamask/eslint-config-typescript@11.1.0...@metamask/eslint-config-typescript@12.0.0
+[11.1.0]: https://github.com/MetaMask/eslint-config/compare/@metamask/eslint-config-typescript@11.0.2...@metamask/eslint-config-typescript@11.1.0
+[11.0.2]: https://github.com/MetaMask/eslint-config/compare/@metamask/eslint-config-typescript@11.0.0...@metamask/eslint-config-typescript@11.0.2
+[11.0.0]: https://github.com/MetaMask/eslint-config/compare/@metamask/eslint-config-typescript@10.0.0...@metamask/eslint-config-typescript@11.0.0
+[10.0.0]: https://github.com/MetaMask/eslint-config/compare/@metamask/eslint-config-typescript@9.0.1...@metamask/eslint-config-typescript@10.0.0
+[9.0.1]: https://github.com/MetaMask/eslint-config/compare/@metamask/eslint-config-typescript@9.0.0...@metamask/eslint-config-typescript@9.0.1
+[9.0.0]: https://github.com/MetaMask/eslint-config/compare/@metamask/eslint-config-typescript@8.0.0...@metamask/eslint-config-typescript@9.0.0
+[8.0.0]: https://github.com/MetaMask/eslint-config/compare/@metamask/eslint-config-typescript@7.0.1...@metamask/eslint-config-typescript@8.0.0
+[7.0.1]: https://github.com/MetaMask/eslint-config/compare/@metamask/eslint-config-typescript@7.0.0...@metamask/eslint-config-typescript@7.0.1
+[7.0.0]: https://github.com/MetaMask/eslint-config/compare/@metamask/eslint-config-typescript@6.0.0...@metamask/eslint-config-typescript@7.0.0
+[6.0.0]: https://github.com/MetaMask/eslint-config/releases/tag/@metamask/eslint-config-typescript@6.0.0

package/README.md

@@ -6,46 +6,49 @@ MetaMask's [TypeScript](https://www.typescriptlang.org) ESLint configuration.
 
 ```bash
 yarn add --dev \
-    @metamask/eslint-config@^12.2.0 \
-    @metamask/eslint-config-typescript@^12.1.0 \
-    @typescript-eslint/eslint-plugin@^6.21.0 \
-    @typescript-eslint/parser@^6.21.0 \
-    eslint@^8.57.0 \
-    eslint-config-prettier@^8.5.0 \
-    eslint-plugin-import-x@^0.5.1 \
-    eslint-plugin-jsdoc@^47.0.2 \
-    eslint-plugin-prettier@^4.2.1 \
-    eslint-plugin-promise@^6.1.1 \
-    prettier@^2.7.1
+    @metamask/eslint-config@^14.0.0 \
+    @metamask/eslint-config-typescript@^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
+    typescript-eslint@^8.6.0
 ```
 
 The order in which you extend ESLint rules matters.
-The `@metamask/*` eslint configs should be added to the `extends` array _last_,
+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.
 
 ```js
-module.exports = {
-  root: true,
+import base, { createConfig } from '@metamask/eslint-config';
+import typescript from '@metamask/eslint-config-typescript';
 
-  extends: [
-    // This should be added last unless you know what you're doing.
-    '@metamask/eslint-config',
-  ],
-
-  overrides: [
+const config = createConfig({
+  {
     // The TypeScript config disables certain rules that you want to keep for
     // non-TypeScript files, so it should be added in an override.
-    {
-      files: ['*.ts'],
-      extends: ['@metamask/eslint-config-typescript'],
+    files: ['**/*.ts', '**/*.mts', '**/*.cts'],
+
+    extends: [
+      // Any custom shared config should be added here.
+      // ...
+
+      // This should be added last unless you know what you're doing.
+      ...base,
+      ...typescript,
+    ],
+
+    languageOptions: {
+      parserOptions: {
+        // This is required for rules that use type information.
+        // See here for more information: https://typescript-eslint.io/getting-started/typed-linting
+        tsconfigRootDir: import.meta.dirname,
+      },
     },
-  ],
-
-  // This is required for rules that use type information.
-  // See here for more information: https://github.com/typescript-eslint/typescript-eslint/blob/master/docs/getting-started/linting/TYPED_LINTING.md
-  parserOptions: {
-    tsconfigRootDir: __dirname,
-  },
-};
+  }
+});
 ```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@metamask/eslint-config-typescript",
-  "version": "13.0.0",
+  "version": "14.0.0",
   "description": "Shareable MetaMask ESLint config for TypeScript.",
   "homepage": "https://github.com/MetaMask/eslint-config#readme",
   "bugs": {
@@ -11,39 +11,58 @@
     "url": "https://github.com/MetaMask/eslint-config.git"
   },
   "license": "MIT",
-  "main": "src/index.js",
+  "type": "module",
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./src/index.d.mts",
+        "default": "./src/index.mjs"
+      }
+    }
+  },
+  "main": "./src/index.mjs",
+  "types": "./src/index.d.mts",
   "files": [
     "src/",
-    "!src/**/*.test.js",
+    "!src/**/*.test.mjs",
     "!src/**/__test__"
   ],
   "scripts": {
-    "lint:changelog": "auto-changelog validate",
+    "changelog:update": "../../scripts/update-changelog.sh @metamask/eslint-config-typescript",
+    "changelog:validate": "../../scripts/validate-changelog.sh @metamask/eslint-config-typescript",
     "publish": "npm publish",
     "test": "eslint ."
   },
+  "dependencies": {
+    "@eslint/js": "^9.11.0"
+  },
   "devDependencies": {
+    "@jest/globals": "^29.7.0",
     "@metamask/auto-changelog": "^3.4.4",
-    "@metamask/eslint-config": "^13.0.0",
-    "@typescript-eslint/eslint-plugin": "^8.1.0",
-    "@typescript-eslint/parser": "^8.1.0",
-    "eslint": "^8.57.0",
-    "eslint-config-prettier": "^8.5.0",
-    "eslint-plugin-import-x": "^0.5.1",
-    "eslint-plugin-jsdoc": "^47.0.2",
-    "eslint-plugin-prettier": "^4.2.1",
-    "prettier": "^2.7.1",
-    "typescript": "~5.5.4"
+    "@metamask/eslint-config": "^14.0.0",
+    "eslint": "^9.11.0",
+    "eslint-config-prettier": "^9.1.0",
+    "eslint-import-resolver-typescript": "^3.6.3",
+    "eslint-plugin-import-x": "^4.3.0",
+    "eslint-plugin-jsdoc": "^50.2.4",
+    "eslint-plugin-prettier": "^5.2.1",
+    "globals": "^15.9.0",
+    "prettier": "^3.3.3",
+    "typescript": "~5.5.4",
+    "typescript-eslint": "^8.6.0",
+    "vitest": "^2.1.1"
   },
   "peerDependencies": {
-    "@metamask/eslint-config": "^13.0.0",
-    "@typescript-eslint/eslint-plugin": "^8.1.0",
-    "@typescript-eslint/parser": "^8.1.0",
-    "eslint": "^8.57.0",
-    "typescript": ">=4.8.4 <5.6"
+    "@metamask/eslint-config": "^14.0.0",
+    "eslint": "^9.11.0",
+    "eslint-import-resolver-typescript": "^3.6.3",
+    "eslint-plugin-import-x": "^4.3.0",
+    "eslint-plugin-jsdoc": "^50.2.4",
+    "typescript": ">=4.8.4 <5.6",
+    "typescript-eslint": "^8.6.0"
   },
   "engines": {
-    "node": "^16.20 || ^18.18 || >=20"
+    "node": "^18.18 || >=20"
   },
   "publishConfig": {
     "access": "public",

package/src/index.d.mts

@@ -0,0 +1,6 @@
+declare module '@metamask/eslint-config-typescript' {
+  import type { Linter } from 'eslint';
+
+  const config: Linter.Config[];
+  export default config;
+}

package/src/{index.js → index.mjs}

@@ -1,35 +1,41 @@
-module.exports = {
-  parser: '@typescript-eslint/parser',
-
-  env: {
-    // See comment under `parserOptions` below.
-    es2020: true,
+import { createConfig } from '@metamask/eslint-config';
+import * as resolver from 'eslint-import-resolver-typescript';
+import importX from 'eslint-plugin-import-x';
+import jsdoc from 'eslint-plugin-jsdoc';
+// TODO: Look into why this doesn't resolve.
+// eslint-disable-next-line import-x/no-unresolved
+import typescript from 'typescript-eslint';
+
+const config = createConfig({
+  name: '@metamask/eslint-config-typescript',
+
+  plugins: {
+    '@typescript-eslint': typescript.plugin,
   },
 
-  parserOptions: {
-    // The `esXXXX` option under `env` is supposed to set the correct
-    // `ecmaVersion` option here, but we've had issues with it being
-    // overridden in the past and therefore set it explicitly.
-    //
-    // For TypeScript, the EcmaScript version always be the latest release
-    // (not pre-release) here: https://github.com/tc39/ecma262/releases
-    ecmaVersion: 2020,
-    sourceType: 'module',
+  extends: [
+    typescript.configs.recommended,
+    typescript.configs.recommendedTypeChecked,
+    importX.flatConfigs.typescript,
+    jsdoc.configs['flat/recommended-typescript-error'],
+  ],
 
-    // This enables support for linting rules that require type information. We
-    // assume that the project has a `tsconfig.json` file in the directory where
-    // ESLint is being run.
-    tsconfigRootDir: process.cwd(),
-    project: ['./tsconfig.json'],
+  languageOptions: {
+    sourceType: 'module',
+    parserOptions: {
+      // This option requires `tsconfigRootDir` to be set, but this needs to
+      // be set on a per-project basis.
+      projectService: true,
+      ecmaVersion: 2022,
+    },
   },
 
-  plugins: ['@typescript-eslint', 'jsdoc'],
-
-  extends: [
-    'plugin:@typescript-eslint/recommended',
-    'plugin:@typescript-eslint/recommended-type-checked',
-    'plugin:import-x/typescript',
-  ],
+  settings: {
+    'import-x/resolver': {
+      name: 'typescript',
+      resolver,
+    },
+  },
 
   rules: {
     // Handled by TypeScript
@@ -71,6 +77,8 @@ module.exports = {
     '@typescript-eslint/no-unsafe-return': 'off',
 
     // Recommended rules that we do not want to use
+    '@typescript-eslint/no-duplicate-type-constituents': 'off',
+    '@typescript-eslint/no-redundant-type-constituents': 'off',
     '@typescript-eslint/require-await': 'off',
 
     // Our rules that require type information
@@ -204,4 +212,6 @@ module.exports = {
       },
     ],
   },
-};
+});
+
+export default config;