@metamask/eslint-config-typescript 8.0.0 → 10.0.0

package/CHANGELOG.md

@@ -6,7 +6,42 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [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:
+    - [`no-loss-of-precision`](https://eslint.org/docs/latest/rules/no-loss-of-precision)
+    - [`no-nonoctal-decimal-escape`](https://eslint.org/docs/latest/rules/no-nonoctal-decimal-escape)
+    - [`no-unsafe-optional-chaining`](https://eslint.org/docs/latest/rules/no-unsafe-optional-chaining)
+    - [`no-useless-backreference`](https://eslint.org/docs/latest/rules/no-useless-backreference)
+- **(BREAKING)** Update `@typescript-eslint` parser and plugin ([#230](https://github.com/MetaMask/eslint-config/pull/230))
+  - This is breaking because these two packages are `peerDependencies`
+  - There are two new rules:
+    - [`@typescript-eslint/no-loss-of-precision`](https://typescript-eslint.io/rules/no-loss-of-precision)
+    - [`@typescript-eslint/no-unnecessary-type-constraint`](https://typescript-eslint.io/rules/no-unnecessary-type-constraint).
+- **(BREAKING)** Update minimium Node.js version to v14 ([#225](https://github.com/MetaMask/eslint-config/pull/225))
+- **(BREAKING)** Forbid TypeScript interfaces ([#216](https://github.com/MetaMask/eslint-config/pull/216))
+- Ignore rest siblings for `no-unused-vars` ([#213](https://github.com/MetaMask/eslint-config/pull/213))
+  - 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
@@ -41,7 +76,10 @@ 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/v8.0.0...HEAD
+[Unreleased]: https://github.com/MetaMask/eslint-config/compare/v10.0.0...HEAD
+[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

package/README.md

@@ -6,13 +6,14 @@ MetaMask's [TypeScript](https://www.typescriptlang.org) ESLint configuration.
 
 ```bash
 yarn add --dev \
-    @metamask/eslint-config@^7.0.0 \
-    @metamask/eslint-config-typescript@^7.0.0 \
-    @typescript-eslint/eslint-plugin@^4.20.0 \
-    @typescript-eslint/parser@^4.20.0 \
+    @metamask/eslint-config@^9.0.0 \
+    @metamask/eslint-config-typescript@^9.0.1 \
+    @typescript-eslint/eslint-plugin@^5.33.0 \
+    @typescript-eslint/parser@^5.33.0 \
     eslint@^7.23.0 \
     eslint-config-prettier@^8.1.0 \
     eslint-plugin-import@^2.22.1 \
+    eslint-plugin-jsdoc@^39.2.9 \
     eslint-plugin-prettier@^3.3.1 \
     prettier@^2.2.1
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@metamask/eslint-config-typescript",
-  "version": "8.0.0",
+  "version": "10.0.0",
   "description": "Shareable MetaMask ESLint config for TypeScript.",
   "main": "src/index.js",
   "publishConfig": {
@@ -11,7 +11,7 @@
     "src/"
   ],
   "engines": {
-    "node": ">=12.0.0"
+    "node": ">=14.0.0"
   },
   "scripts": {
     "test": "eslint .",
@@ -27,17 +27,22 @@
   },
   "homepage": "https://github.com/MetaMask/eslint-config#readme",
   "devDependencies": {
-    "@metamask/eslint-config": "^8.0.0",
-    "@typescript-eslint/eslint-plugin": "^4.20.0",
-    "@typescript-eslint/parser": "^4.20.0",
-    "eslint": "^7.23.0",
+    "@metamask/eslint-config": "^10.0.0",
+    "@typescript-eslint/eslint-plugin": "^5.33.0",
+    "@typescript-eslint/parser": "^5.33.0",
+    "eslint": "^8.21.0",
+    "eslint-config-prettier": "^8.1.0",
+    "eslint-plugin-import": "^2.26.0",
+    "eslint-plugin-jsdoc": "^39.2.9",
+    "eslint-plugin-prettier": "^4.2.1",
+    "prettier": "^2.2.1",
     "typescript": "^4.0.7"
   },
   "peerDependencies": {
-    "@metamask/eslint-config": "^8.0.0",
-    "@typescript-eslint/eslint-plugin": "^4.20.0",
-    "@typescript-eslint/parser": "^4.20.0",
-    "eslint": "^7.23.0",
+    "@metamask/eslint-config": "^10.0.0",
+    "@typescript-eslint/eslint-plugin": "^5.33.0",
+    "@typescript-eslint/parser": "^5.33.0",
+    "eslint": "^8.21.0",
     "typescript": "^4.0.7"
   }
 }

package/src/index.js

@@ -17,7 +17,7 @@ module.exports = {
     sourceType: 'module',
   },
 
-  plugins: ['@typescript-eslint'],
+  plugins: ['@typescript-eslint', 'jsdoc'],
 
   extends: [
     'plugin:@typescript-eslint/recommended',
@@ -34,8 +34,7 @@ module.exports = {
     // Our rules
     '@typescript-eslint/array-type': 'error',
     '@typescript-eslint/consistent-type-assertions': 'error',
-    '@typescript-eslint/consistent-type-definitions': 'error',
-    '@typescript-eslint/explicit-module-boundary-types': 'off',
+    '@typescript-eslint/consistent-type-definitions': ['error', 'type'],
     '@typescript-eslint/no-explicit-any': 'off',
     '@typescript-eslint/no-namespace': [
       'error',
@@ -51,7 +50,12 @@ module.exports = {
     '@typescript-eslint/no-dupe-class-members': 'error',
     '@typescript-eslint/no-unused-vars': [
       'error',
-      { vars: 'all', args: 'all', argsIgnorePattern: '[_]+' },
+      {
+        vars: 'all',
+        args: 'all',
+        argsIgnorePattern: '[_]+',
+        ignoreRestSiblings: true,
+      },
     ],
 
     'default-param-last': 'off',
@@ -60,6 +64,9 @@ module.exports = {
     'no-shadow': 'off',
     '@typescript-eslint/no-shadow': ['error', { builtinGlobals: true }],
 
+    'no-throw-literal': 'off',
+    // '@typescript-eslint/no-throw-literal' is left disabled because it requires type information
+
     'no-unused-expressions': 'off',
     '@typescript-eslint/no-unused-expressions': [
       'error',
@@ -71,5 +78,22 @@ module.exports = {
 
     'no-useless-constructor': 'off',
     '@typescript-eslint/no-useless-constructor': 'error',
+
+    /* 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',
+
+    // Use TypeScript types rather than JSDoc types.
+    'jsdoc/no-types': 'error',
+
+    // These all conflict with `jsdoc/no-types`.
+    'jsdoc/require-param-type': 'off',
+    'jsdoc/require-property-type': 'off',
+    'jsdoc/require-returns-type': 'off',
+    'jsdoc/valid-types': 'off',
   },
 };