@metamask/eslint-config-typescript 14.0.0 → 15.0.0

package/CHANGELOG.md

@@ -7,6 +7,46 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [15.0.0]
+
+### Changed
+
+- **BREAKING:** Bump peer dependency on `@metamask/eslint-config` from `^14.0.0` to `^15.0.0` ([#431](https://github.com/MetaMask/eslint-config/pull/431))
+- **BREAKING:** Update `typescript-eslint` peer dependency to have a minimum version of v8.39.0 ([#423](https://github.com/MetaMask/eslint-config/pull/423))
+  - This version has a matching supported `typescript` range, and includes some bug fixes for problems we ran into.
+- **BREAKING:** Update type import specifier rules ([#381](https://github.com/MetaMask/eslint-config/pull/381))
+  - `@typescript-eslint/consistent-type-imports` has been replaced with `import-x/consistent-type-specifier-style`
+  - The rule now prefers "top-level" type imports over inline. e.g. `import type { a } from 'x'` over `import { type a } from 'x'`
+- Disable `@typescript-eslint/no-unnecessary-type-arguments` ([#426](https://github.com/MetaMask/eslint-config/pull/426))
+  - We decided that "unnecessary" type arguments make types easier to read sometimes, so we should allow them.
+- Disable `promise/valid-params` because it's redundant in type-checked projects ([#425](https://github.com/MetaMask/eslint-config/pull/425))
+- Disable `import-x/no-duplicates` ([#427](https://github.com/MetaMask/eslint-config/pull/427))
+  - It was a style preference that we may not want, and the auto-fix was broken.
+- Loosen `@typescript-eslint/naming-convention` by not enforcing naming conventions for object literal properties ([#428](https://github.com/MetaMask/eslint-config/pull/428))
+  - Object literals are too often used as parameters for 3rd party libraries/services.
+- Disable `jsdoc/check-indentation` ([#430](https://github.com/MetaMask/eslint-config/pull/430))
+  - Disabled due to a problem with indended sections in TSDoc blocks.
+- Widen `typescript` peer dependency to allow all 5.x versions ([#422](https://github.com/MetaMask/eslint-config/pull/422))
+
+### Fixed
+
+- Prevent non-type imports from being grouped under a type import upon auto-fix ([#427](https://github.com/MetaMask/eslint-config/pull/427))
+  - This was caused by `import-x/no-duplicates`, which is now disabled.
+- Fix false positive lint error on TSDoc blocks with indended sections (e.g. bullet lists) ([#430](https://github.com/MetaMask/eslint-config/pull/430))
+
+## [14.1.0]
+
+### Added
+
+- Add support for TypeScript 5.6.x-5.8.x ([#395](https://github.com/MetaMask/eslint-config/pull/395))
+
+### Changed
+
+- Disable `@typescript-eslint/no-unsafe-enum-comparison` rule ([#387](https://github.com/MetaMask/eslint-config/pull/387))
+- Loosen `@typescript-eslint/prefer-promise-reject-errors` rule to allow rejecting with `unknown` ([#389](https://github.com/MetaMask/eslint-config/pull/389))
+- Loosen `@typescript-eslint/naming-convention` rule to allow more formats for import names ([#388](https://github.com/MetaMask/eslint-config/pull/388))
+- Loosen `@typescript-eslint/switch-exhaustiveness-check` rule to allow `default` case ([#390](https://github.com/MetaMask/eslint-config/pull/390))
+
 ## [14.0.0]
 
 ### Added
@@ -171,7 +211,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
   - 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/@metamask/eslint-config-typescript@14.0.0...HEAD
+[Unreleased]: https://github.com/MetaMask/eslint-config/compare/@metamask/eslint-config-typescript@15.0.0...HEAD
+[15.0.0]: https://github.com/MetaMask/eslint-config/compare/@metamask/eslint-config-typescript@14.1.0...@metamask/eslint-config-typescript@15.0.0
+[14.1.0]: https://github.com/MetaMask/eslint-config/compare/@metamask/eslint-config-typescript@14.0.0...@metamask/eslint-config-typescript@14.1.0
 [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

package/README.md

@@ -14,8 +14,9 @@ yarn add --dev \
     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
+    prettier@^3.3.3 \
+    typescript@~5.8.0 \
+    typescript-eslint@^8.28.0
 ```
 
 The order in which you extend ESLint rules matters.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@metamask/eslint-config-typescript",
-  "version": "14.0.0",
+  "version": "15.0.0",
   "description": "Shareable MetaMask ESLint config for TypeScript.",
   "homepage": "https://github.com/MetaMask/eslint-config#readme",
   "bugs": {
@@ -39,7 +39,7 @@
   "devDependencies": {
     "@jest/globals": "^29.7.0",
     "@metamask/auto-changelog": "^3.4.4",
-    "@metamask/eslint-config": "^14.0.0",
+    "@metamask/eslint-config": "^15.0.0",
     "eslint": "^9.11.0",
     "eslint-config-prettier": "^9.1.0",
     "eslint-import-resolver-typescript": "^3.6.3",
@@ -48,18 +48,18 @@
     "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"
+    "typescript": "^5.9.3",
+    "typescript-eslint": "^8.47.0",
+    "vitest": "^2.1.9"
   },
   "peerDependencies": {
-    "@metamask/eslint-config": "^14.0.0",
+    "@metamask/eslint-config": "^15.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"
+    "typescript": ">=4.8.4 <6",
+    "typescript-eslint": "^8.39.0"
   },
   "engines": {
     "node": "^18.18 || >=20"

package/src/index.mjs

@@ -38,14 +38,10 @@ const config = createConfig({
   },
 
   rules: {
-    // Handled by TypeScript
-    'import-x/no-unresolved': 'off',
-
     // Our rules
     '@typescript-eslint/array-type': 'error',
     '@typescript-eslint/consistent-type-assertions': 'error',
     '@typescript-eslint/consistent-type-definitions': ['error', 'type'],
-    '@typescript-eslint/consistent-type-imports': 'error',
     '@typescript-eslint/explicit-function-return-type': 'error',
     '@typescript-eslint/no-explicit-any': 'off',
     '@typescript-eslint/no-namespace': [
@@ -79,8 +75,12 @@ const config = createConfig({
     // 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/no-unsafe-enum-comparison': 'off',
     '@typescript-eslint/require-await': 'off',
 
+    // Disabled because unnecessary type arguments are sometimes helpful for readability
+    '@typescript-eslint/no-unnecessary-type-arguments': 'off',
+
     // Our rules that require type information
     '@typescript-eslint/consistent-type-exports': 'error',
     '@typescript-eslint/naming-convention': [
@@ -95,6 +95,10 @@ const config = createConfig({
         selector: 'enumMember',
         format: ['PascalCase'],
       },
+      {
+        selector: 'import',
+        format: ['camelCase', 'PascalCase', 'snake_case', 'UPPER_CASE'],
+      },
       {
         selector: 'interface',
         format: ['PascalCase'],
@@ -109,7 +113,9 @@ const config = createConfig({
       },
       {
         selector: 'objectLiteralProperty',
-        format: ['camelCase', 'PascalCase', 'UPPER_CASE'],
+        // Disabled because object literals are often parameters to 3rd party libraries/services,
+        // which we don't set the naming conventions for
+        format: null,
       },
       {
         selector: 'typeLike',
@@ -151,10 +157,13 @@ const config = createConfig({
     '@typescript-eslint/no-meaningless-void-operator': 'error',
     '@typescript-eslint/no-unnecessary-boolean-literal-compare': 'error',
     '@typescript-eslint/no-unnecessary-qualifier': 'error',
-    '@typescript-eslint/no-unnecessary-type-arguments': 'error',
     '@typescript-eslint/prefer-enum-initializers': 'error',
     '@typescript-eslint/prefer-includes': 'error',
     '@typescript-eslint/prefer-nullish-coalescing': 'error',
+    '@typescript-eslint/prefer-promise-reject-errors': [
+      'error',
+      { allowThrowingUnknown: true },
+    ],
     '@typescript-eslint/prefer-readonly': 'error',
     '@typescript-eslint/prefer-reduce-type-parameter': 'error',
     '@typescript-eslint/prefer-string-starts-ends-with': 'error',
@@ -166,7 +175,12 @@ const config = createConfig({
         allowNumber: true,
       },
     ],
-    '@typescript-eslint/switch-exhaustiveness-check': 'error',
+    '@typescript-eslint/switch-exhaustiveness-check': [
+      'error',
+      {
+        considerDefaultExhaustiveForUnions: true,
+      },
+    ],
 
     'default-param-last': 'off',
     '@typescript-eslint/default-param-last': 'error',
@@ -185,13 +199,28 @@ const config = createConfig({
     'no-useless-constructor': 'off',
     '@typescript-eslint/no-useless-constructor': 'error',
 
+    /* import-x plugin rules */
+
+    // This rule is to aggresive about combining type and non-type imports, which I'm not sure that we want.
+    // But more importantly, the auto-fixer is broken.
+    // See here for details on that bug: https://github.com/un-ts/eslint-plugin-import-x/issues/231
+    'import-x/no-duplicates': 'off',
+
+    // Handled by TypeScript
+    'import-x/no-unresolved': 'off',
+
+    // Combined with the "verbatimModuleSyntax" tsconfig option, a better option than
+    // @typescript-eslint/consistent-type-imports
+    'import-x/consistent-type-specifier-style': ['error', 'prefer-top-level'],
+
     /* jsdoc plugin rules */
 
     'jsdoc/check-syntax': 'error',
 
-    // This is enabled here rather than in the base config because it doesn't play nicely with
-    // multi-line JSDoc types.
-    'jsdoc/check-indentation': 'error',
+    // This is disabled because it doesn't work with bullet lists, and other types of indented
+    // sections. This issue is fixed in later versions, we can re-enable it after updating.
+    // See https://github.com/gajus/eslint-plugin-jsdoc/issues/541 for details
+    'jsdoc/check-indentation': 'off',
 
     // Use TypeScript types rather than JSDoc types.
     'jsdoc/no-types': 'error',
@@ -211,6 +240,11 @@ const config = createConfig({
         message: 'Use a hash name instead.',
       },
     ],
+
+    /* promise plugin rules */
+
+    // TypeScript already validates Promise params, no need to validate them twice
+    'promise/valid-params': 'off',
   },
 });