@wistia/eslint-config 1.3.0 → 1.4.0

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @wistia/eslint-config
 
+## 1.4.0
+
+### Minor Changes
+
+- [#412](https://github.com/wistia/eslint-config/pull/412) [`ab09493`](https://github.com/wistia/eslint-config/commit/ab094933364da1b9152b81a248c12bbaca733b5f) Thanks [@okize](https://github.com/okize)! - feat: add `preserve-caught-error` & `no-unassigned-vars` to base ruleset
+
+## 1.3.1
+
+### Patch Changes
+
+- [#410](https://github.com/wistia/eslint-config/pull/410) [`fc24518`](https://github.com/wistia/eslint-config/commit/fc245183490bca030eb167f5e982c7c273bb4851) Thanks [@okize](https://github.com/okize)! - fix: remove/hide deprecated rules
+
 ## 1.3.0
 
 ### Minor Changes

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wistia/eslint-config",
-  "version": "1.3.0",
+  "version": "1.4.0",
   "description": "Wistia's ESLint configurations",
   "packageManager": "yarn@4.12.0",
   "type": "module",
@@ -44,8 +44,8 @@
     "@eslint/compat": "^2.0.0",
     "@eslint/js": "^9.39.2",
     "@stylistic/eslint-plugin": "^5.6.1",
-    "@typescript-eslint/eslint-plugin": "^8.49.0",
-    "@typescript-eslint/parser": "^8.49.0",
+    "@typescript-eslint/eslint-plugin": "^8.50.0",
+    "@typescript-eslint/parser": "^8.50.0",
     "confusing-browser-globals": "^1.0.11",
     "eslint-import-resolver-typescript": "^4.4.4",
     "eslint-plugin-barrel-files": "^3.0.1",
@@ -85,7 +85,7 @@
     "prettier": "^3.7.4",
     "storybook": "^10.1.9",
     "typescript": "^5.9.3",
-    "vitest": "^4.0.15"
+    "vitest": "^4.0.16"
   },
   "peerDependencies": {
     "eslint": ">= 9",

package/src/rules/base.mjs

@@ -197,7 +197,11 @@ export default {
 
   // Disallow unmodified loop conditions
   // https://eslint.org/docs/rules/no-unmodified-loop-condition
-  'no-unmodified-loop-condition': 'off',
+  'no-unmodified-loop-condition': 'error',
+
+  // Disallow let or var variables that are read but never assigned
+  // https://eslint.org/docs/latest/rules/no-unassigned-vars
+  'no-unassigned-vars': 'error',
 
   // Disallow unreachable code after return, throw, continue, and break statements
   // https://eslint.org/docs/rules/no-unreachable
@@ -987,6 +991,12 @@ export default {
   // https://eslint.org/docs/rules/prefer-template
   'prefer-template': 'error',
 
+  // Disallow losing originally caught error when re-throwing custom errors
+  // https://eslint.org/docs/latest/rules/preserve-caught-error
+  'preserve-caught-error': ['error', {
+    'requireCatchParameter': false
+  }],
+
   // Enforce the consistent use of the radix argument when using parseInt()
   // https://eslint.org/docs/rules/radix
   radix: 'error',

package/src/rules/import.mjs

@@ -90,7 +90,7 @@ export default {
   // disallow non-import statements appearing before import statements
   // https://github.com/import-js/eslint-plugin-import/blob/master/docs/rules/imports-first.md
   // deprecated: use `import/first`
-  'import/imports-first': 'off',
+  // 'import/imports-first': 'off',
 
   // disallow duplicate imports
   // https://github.com/import-js/eslint-plugin-import/blob/master/docs/rules/no-duplicates.md

package/src/rules/node.mjs

@@ -88,9 +88,9 @@ export default {
   'n/process-exit-as-throw': 'error',
 
   // suggest correct usage of shebang
-  // decision: turned this off because it expects files to be listed under `bin` in package.json
   // https://github.com/eslint-community/eslint-plugin-n/blob/master/docs/rules/shebang.md
-  'n/shebang': 'off',
+  // decision: This rule is deprecated. It was replaced by n/hashbang.
+  // 'n/shebang': 'off',
 
   // disallow deprecated APIs
   // https://github.com/eslint-community/eslint-plugin-n/blob/master/docs/rules/no-deprecated-api.md
@@ -176,7 +176,8 @@ export default {
 
   // disallow third-party modules which are hiding core modules
   // https://github.com/eslint-community/eslint-plugin-n/blob/master/docs/rules/no-hide-core-modules.md
-  'n/no-hide-core-modules': 'error',
+  // decision: this rule is deprecated.
+  // 'n/no-hide-core-modules': 'error',
 
   // enforce using the node: protocol when importing Node.js builtin modules
   // https://github.com/eslint-community/eslint-plugin-n/blob/master/docs/rules/prefer-node-protocol.md

package/src/rules/react-a11y.mjs

@@ -5,7 +5,7 @@ export default {
   // ensure emoji are accessible
   // https://github.com/evcohen/eslint-plugin-jsx-a11y/blob/master/docs/rules/accessible-emoji.md
   // disabled; rule is deprecated
-  'jsx-a11y/accessible-emoji': 'off',
+  // 'jsx-a11y/accessible-emoji': 'off',
 
   // Enforce that all elements that require alternative text have meaningful information
   // https://github.com/evcohen/eslint-plugin-jsx-a11y/blob/master/docs/rules/alt-text.md
@@ -205,7 +205,10 @@ export default {
 
   // require onBlur instead of onChange
   // https://github.com/evcohen/eslint-plugin-jsx-a11y/blob/master/docs/rules/no-onchange.md
-  'jsx-a11y/no-onchange': 'off',
+  // decision: This rule is deprecated. This rule is based on reports of behavior of old
+  // browsers (eg. IE 10 and below). In the meantime, this behavior has been corrected,
+  // both in newer versions of browsers as well as in the DOM spec.
+  // 'jsx-a11y/no-onchange': 'off',
 
   // ensure HTML elements do not specify redundant ARIA roles
   // https://github.com/evcohen/eslint-plugin-jsx-a11y/blob/master/docs/rules/no-redundant-roles.md

package/src/rules/react.mjs

@@ -372,8 +372,8 @@ export default {
 
   // Enforce spaces before the closing bracket of self-closing JSX elements
   // https://github.com/jsx-eslint/eslint-plugin-react/blob/master/docs/rules/jsx-space-before-closing.md
-  // decision: disabled because this is a formatter concern
-  'react/jsx-space-before-closing': 'off',
+  // decision: this rule is deprecated. It was replaced by react/jsx-tag-spacing.
+  // 'react/jsx-space-before-closing': 'off',
 
   // Prevent usage of Array index in keys
   // https://github.com/jsx-eslint/eslint-plugin-react/blob/master/docs/rules/no-array-index-key.md
@@ -581,9 +581,11 @@ export default {
   // decision: there's an edge case issue this could prevent but it's not common enough to warrant the rule
   'react/no-object-type-as-default-prop': 'off',
 
-  // This rule is deprecated. It was replaced by `react/sort-default-props`
+  // Some developers prefer to sort defaultProps declarations alphabetically to be able to find necessary declarations easier at a later time.
+  // Others feel that it adds complexity and becomes a burden to maintain.
   // https://github.com/jsx-eslint/eslint-plugin-react/blob/master/docs/rules/jsx-sort-default-props.md
-  'react/jsx-sort-default-props': 'off',
+  // decision: this rule is deprecated. It was replaced by `react/sort-default-props`
+  // 'react/jsx-sort-default-props': 'off',
 
   // Require all forwardRef components include a ref parameter
   // https://github.com/jsx-eslint/eslint-plugin-react/blob/master/docs/rules/forward-ref-uses-ref.md

package/src/rules/styled-components.mjs

@@ -3,7 +3,6 @@
 
 export default {
   // plugin does not provide definitions
-  'styled-components-a11y/accessible-emoji': 'error',
   'styled-components-a11y/alt-text': 'error',
   'styled-components-a11y/anchor-has-content': 'error',
   'styled-components-a11y/anchor-is-valid': 'error',
@@ -70,7 +69,6 @@ export default {
   ],
   'styled-components-a11y/no-noninteractive-element-to-interactive-role': 'error',
   'styled-components-a11y/no-noninteractive-tabindex': 'error',
-  'styled-components-a11y/no-onchange': 'error',
   'styled-components-a11y/no-redundant-roles': 'error',
   'styled-components-a11y/no-static-element-interactions': 'error',
   'styled-components-a11y/role-has-required-aria-props': 'error',

package/src/rules/stylistic.mjs

@@ -419,7 +419,7 @@ export default {
   // Enforce JSX indentation
   // https://eslint.style/rules/default/jsx-indent
   // decision: disabled because this is a formatter concern
-  '@stylistic/jsx-indent': 'off',
+  // '@stylistic/jsx-indent': 'off',
 
   // Enforce props indentation in JSX
   // https://eslint.style/rules/default/jsx-indent-props
@@ -449,7 +449,7 @@ export default {
   // Disallow multiple spaces between inline JSX props
   // https://eslint.style/rules/default/jsx-props-no-multi-spaces
   // decision: disabled because this is a formatter concern
-  '@stylistic/jsx-props-no-multi-spaces': 'off',
+  // '@stylistic/jsx-props-no-multi-spaces': 'off',
 
   // Disallow extra closing tags for components without children
   // https://eslint.style/rules/default/jsx-self-closing-comp

package/src/rules/typescript.mjs

@@ -38,9 +38,6 @@ export default {
   // decision: prefer @typescript-eslint/no-loop-func
   'no-loop-func': 'off',
 
-  // decision: prefer @typescript-eslint/no-loss-of-precision
-  'no-loss-of-precision': 'off',
-
   // decision: prefer @typescript-eslint/no-magic-numbers
   'no-magic-numbers': 'off',
 
@@ -71,9 +68,6 @@ export default {
   // decision: prefer @typescript-eslint/require-await
   'require-await': 'off',
 
-  // decision: prefer @typescript-eslint/return-await
-  'no-return-await': 'off',
-
   // decision: prefer @typescript-eslint/prefer-destructuring
   'prefer-destructuring': 'off',
 
@@ -271,7 +265,7 @@ export default {
   // Disallow the declaration of empty interfaces
   // https://typescript-eslint.io/rules/no-empty-interface
   // decision: this rule has been deprecated in favour of the more comprehensive @typescript-eslint/no-empty-object-type rule
-  '@typescript-eslint/no-empty-interface': 'off',
+  // '@typescript-eslint/no-empty-interface': 'off',
 
   // Disallow accidentally using the "empty object" type
   // https://typescript-eslint.io/rules/no-empty-object-type
@@ -323,7 +317,8 @@ export default {
 
   // Disallow literal numbers that lose precision
   // https://typescript-eslint.io/rules/no-loss-of-precision
-  '@typescript-eslint/no-loss-of-precision': 'error',
+  // decision: this rule has been deprecated because the base eslint/no-loss-of-precision rule added support for numeric separators. There is no longer any need to use this extension rule.
+  // '@typescript-eslint/no-loss-of-precision': 'off',
 
   // Disallow magic numbers
   // https://typescript-eslint.io/rules/no-magic-numbers
@@ -403,7 +398,7 @@ export default {
   // Disallow type aliases
   // https://typescript-eslint.io/rules/no-type-alias
   // decision: this rule has been deprecated in favour of the @typescript-eslint/consistent-type-definitions rule
-  '@typescript-eslint/no-type-alias': 'off',
+  // '@typescript-eslint/no-type-alias': 'off',
 
   // Disallow unnecessary equality comparisons against boolean literals
   // https://typescript-eslint.io/rules/no-unnecessary-boolean-literal-compare
@@ -512,7 +507,7 @@ export default {
   // Disallow require statements except in import statements
   // https://typescript-eslint.io/rules/no-var-requires
   // decision: this rule has been deprecated in favour of the @typescript-eslint/no-require-imports rule.
-  '@typescript-eslint/no-var-requires': 'off',
+  // '@typescript-eslint/no-var-requires': 'off',
 
   // Disallow using confusing built-in primitive class wrappers
   // https://typescript-eslint.io/rules/no-wrapper-object-types
@@ -621,7 +616,7 @@ export default {
   // Enforce using @ts-expect-error over @ts-ignore
   // https://typescript-eslint.io/rules/prefer-ts-expect-error
   // decision: this rule has been deprecated in favor of @typescript-eslint/ban-ts-comment
-  '@typescript-eslint/prefer-ts-expect-error': 'off',
+  // '@typescript-eslint/prefer-ts-expect-error': 'off',
 
   // Require any function or method that returns a Promise to be marked async
   // https://typescript-eslint.io/rules/promise-function-async
@@ -649,7 +644,8 @@ export default {
 
   // Enforce constituents of a type union/intersection to be sorted alphabetically
   // https://typescript-eslint.io/rules/sort-type-constituents
-  '@typescript-eslint/sort-type-constituents': 'error',
+  // decision: this rule has been deprecated in favor of the perfectionist/sort-intersection-types and perfectionist/sort-union-types rules.
+  // '@typescript-eslint/sort-type-constituents': 'error',
 
   // Disallow certain types in boolean expressions
   // https://typescript-eslint.io/rules/strict-boolean-expressions
@@ -670,7 +666,10 @@ export default {
 
   // Require type annotations in certain places
   // https://typescript-eslint.io/rules/typedef
-  '@typescript-eslint/typedef': 'error',
+  // decision: deprecated because equiring type annotations unnecessarily can be cumbersome to maintain and
+  // generally reduces code readability. TypeScript is often better at inferring types than easily written
+  // type annotations would allow.
+  // '@typescript-eslint/typedef': 'error',
 
   // Enforce unbound methods are called with their expected scope
   // https://typescript-eslint.io/rules/unbound-method

package/src/rules/vitest.mjs

@@ -58,7 +58,8 @@ export default {
 
   // Disallow using a callback in asynchronous tests and hooks
   // https://github.com/veritem/eslint-plugin-vitest/blob/main/docs/rules/no-done-callback.md
-  'vitest/no-done-callback': 'error',
+  // decision: this rule is deprecated.
+  // 'vitest/no-done-callback': 'error',
 
   // Disallow duplicate hooks and teardown hooks
   // https://github.com/veritem/eslint-plugin-vitest/blob/main/docs/rules/no-duplicate-hooks.md

package/test/__snapshots__/javascript.mjs.snap

@@ -178,9 +178,6 @@
     "@stylistic/jsx-function-call-newline": [
       0,
     ],
-    "@stylistic/jsx-indent": [
-      0,
-    ],
     "@stylistic/jsx-indent-props": [
       0,
     ],
@@ -196,9 +193,6 @@
     "@stylistic/jsx-pascal-case": [
       0,
     ],
-    "@stylistic/jsx-props-no-multi-spaces": [
-      0,
-    ],
     "@stylistic/jsx-quotes": [
       0,
     ],
@@ -618,9 +612,6 @@
     "import/group-exports": [
       0,
     ],
-    "import/imports-first": [
-      0,
-    ],
     "import/max-dependencies": [
       0,
       {
@@ -1572,6 +1563,9 @@
     "no-throw-literal": [
       2,
     ],
+    "no-unassigned-vars": [
+      2,
+    ],
     "no-undef": [
       2,
       {
@@ -1602,7 +1596,7 @@
       0,
     ],
     "no-unmodified-loop-condition": [
-      0,
+      2,
     ],
     "no-unneeded-ternary": [
       2,
@@ -1821,6 +1815,12 @@
     "prefer-template": [
       2,
     ],
+    "preserve-caught-error": [
+      2,
+      {
+        "requireCatchParameter": false,
+      },
+    ],
     "prettier/prettier": [
       2,
     ],

package/test/__snapshots__/node.mjs.snap

@@ -144,9 +144,6 @@
     "n/no-extraneous-require": [
       0,
     ],
-    "n/no-hide-core-modules": [
-      2,
-    ],
     "n/no-missing-import": [
       0,
     ],
@@ -233,8 +230,5 @@
     "n/process-exit-as-throw": [
       2,
     ],
-    "n/shebang": [
-      0,
-    ],
   },
 }

package/test/__snapshots__/react.mjs.snap

@@ -1218,9 +1218,6 @@
         "ignoreOverrideMethods": false,
       },
     ],
-    "jsx-a11y/accessible-emoji": [
-      0,
-    ],
     "jsx-a11y/alt-text": [
       2,
       {
@@ -1451,9 +1448,6 @@
         "tags": [],
       },
     ],
-    "jsx-a11y/no-onchange": [
-      0,
-    ],
     "jsx-a11y/no-redundant-roles": [
       2,
     ],
@@ -1766,9 +1760,6 @@
     "react/jsx-props-no-spreading": [
       0,
     ],
-    "react/jsx-sort-default-props": [
-      0,
-    ],
     "react/jsx-sort-prop-types": [
       0,
     ],
@@ -1785,9 +1776,6 @@
         "shorthandLast": false,
       },
     ],
-    "react/jsx-space-before-closing": [
-      0,
-    ],
     "react/jsx-tag-spacing": [
       0,
     ],

package/test/__snapshots__/styled-components.mjs.snap

@@ -19,9 +19,6 @@
     "styled-components-a11y:eslint-plugin-styled-components-a11y@2.2.1",
   ],
   "rules": {
-    "styled-components-a11y/accessible-emoji": [
-      2,
-    ],
     "styled-components-a11y/alt-text": [
       2,
     ],
@@ -154,9 +151,6 @@
     "styled-components-a11y/no-noninteractive-tabindex": [
       2,
     ],
-    "styled-components-a11y/no-onchange": [
-      2,
-    ],
     "styled-components-a11y/no-redundant-roles": [
       2,
     ],

package/test/__snapshots__/typescript.mjs.snap

@@ -64,7 +64,7 @@
       "undefined": false,
       "unescape": false,
     },
-    "parser": "typescript-eslint/parser@8.49.0",
+    "parser": "typescript-eslint/parser@8.50.0",
     "parserOptions": {
       "ecmaVersion": 2024,
       "project": "./tsconfig.json",
@@ -78,7 +78,7 @@
   "plugins": [
     "@",
     "@stylistic",
-    "@typescript-eslint:@typescript-eslint/eslint-plugin@8.49.0",
+    "@typescript-eslint:@typescript-eslint/eslint-plugin@8.50.0",
     "barrel-files:eslint-plugin-barrel-files@3.0.1",
     "filenames",
     "import",
@@ -180,9 +180,6 @@
     "@stylistic/jsx-function-call-newline": [
       0,
     ],
-    "@stylistic/jsx-indent": [
-      0,
-    ],
     "@stylistic/jsx-indent-props": [
       0,
     ],
@@ -198,9 +195,6 @@
     "@stylistic/jsx-pascal-case": [
       0,
     ],
-    "@stylistic/jsx-props-no-multi-spaces": [
-      0,
-    ],
     "@stylistic/jsx-quotes": [
       0,
     ],
@@ -531,9 +525,6 @@
         "allow": [],
       },
     ],
-    "@typescript-eslint/no-empty-interface": [
-      0,
-    ],
     "@typescript-eslint/no-empty-object-type": [
       2,
     ],
@@ -573,9 +564,6 @@
     "@typescript-eslint/no-loop-func": [
       2,
     ],
-    "@typescript-eslint/no-loss-of-precision": [
-      2,
-    ],
     "@typescript-eslint/no-magic-numbers": [
       2,
       {
@@ -651,9 +639,6 @@
     "@typescript-eslint/no-this-alias": [
       2,
     ],
-    "@typescript-eslint/no-type-alias": [
-      0,
-    ],
     "@typescript-eslint/no-unnecessary-boolean-literal-compare": [
       2,
     ],
@@ -740,9 +725,6 @@
     "@typescript-eslint/no-useless-empty-export": [
       2,
     ],
-    "@typescript-eslint/no-var-requires": [
-      0,
-    ],
     "@typescript-eslint/no-wrapper-object-types": [
       2,
     ],
@@ -822,9 +804,6 @@
     "@typescript-eslint/prefer-string-starts-ends-with": [
       2,
     ],
-    "@typescript-eslint/prefer-ts-expect-error": [
-      0,
-    ],
     "@typescript-eslint/promise-function-async": [
       2,
     ],
@@ -846,9 +825,6 @@
     "@typescript-eslint/return-await": [
       2,
     ],
-    "@typescript-eslint/sort-type-constituents": [
-      2,
-    ],
     "@typescript-eslint/strict-boolean-expressions": [
       2,
       {
@@ -861,9 +837,6 @@
     "@typescript-eslint/triple-slash-reference": [
       2,
     ],
-    "@typescript-eslint/typedef": [
-      2,
-    ],
     "@typescript-eslint/unbound-method": [
       2,
     ],
@@ -1090,9 +1063,6 @@
     "import/group-exports": [
       0,
     ],
-    "import/imports-first": [
-      0,
-    ],
     "import/max-dependencies": [
       0,
       {
@@ -1562,7 +1532,7 @@
       0,
     ],
     "no-loss-of-precision": [
-      0,
+      2,
     ],
     "no-magic-numbers": [
       0,
@@ -1994,9 +1964,6 @@
       2,
       "always",
     ],
-    "no-return-await": [
-      0,
-    ],
     "no-script-url": [
       2,
     ],
@@ -2050,6 +2017,9 @@
     "no-throw-literal": [
       0,
     ],
+    "no-unassigned-vars": [
+      2,
+    ],
     "no-undef": [
       0,
       {
@@ -2080,7 +2050,7 @@
       0,
     ],
     "no-unmodified-loop-condition": [
-      0,
+      2,
     ],
     "no-unneeded-ternary": [
       2,
@@ -2275,6 +2245,12 @@
     "prefer-template": [
       2,
     ],
+    "preserve-caught-error": [
+      2,
+      {
+        "requireCatchParameter": false,
+      },
+    ],
     "prettier/prettier": [
       2,
     ],

package/test/__snapshots__/vitest.mjs.snap

@@ -101,9 +101,6 @@
     "vitest/no-disabled-tests": [
       0,
     ],
-    "vitest/no-done-callback": [
-      2,
-    ],
     "vitest/no-duplicate-hooks": [
       2,
     ],