@wistia/eslint-config 2.9.0 → 2.10.0

package/.github/workflows/release.yml

@@ -23,7 +23,7 @@ jobs:
     steps:
       - name: Generate GitHub App token
         id: app-token
-        uses: actions/create-github-app-token@1b10c78c7865c340bc4f6099eb2f838309f1e8c3 # v3.1.1
+        uses: actions/create-github-app-token@bcd2ba49218906704ab6c1aa796996da409d3eb1 # v3.2.0
         with:
           client-id: ${{ secrets.ACTIONS_BOT_GH_APP_CLIENT_ID }}
           private-key: ${{ secrets.ACTIONS_BOT_GH_APP_PRIVATE_KEY }}

package/.yarnrc.yml

@@ -1,6 +1,3 @@
-approvedGitRepositories:
-  - "**"
-
 enableGlobalCache: false
 
 enableScripts: true

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @wistia/eslint-config
 
+## 2.10.0
+
+### Minor Changes
+
+- [#495](https://github.com/wistia/eslint-config/pull/495) [`3f3b641`](https://github.com/wistia/eslint-config/commit/3f3b6413c1a83bf0266112b8561b37c02f1947f7) Thanks [@okize](https://github.com/okize)! - feat: disable some rules we do not find useful
+
 ## 2.9.0
 
 ### Minor Changes

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wistia/eslint-config",
-  "version": "2.9.0",
+  "version": "2.10.0",
   "description": "Wistia's ESLint configurations",
   "packageManager": "yarn@4.14.1",
   "type": "module",
@@ -38,12 +38,12 @@
     "test:export": "check-export-map"
   },
   "dependencies": {
-    "@eslint-react/eslint-plugin": "^5.7.7",
+    "@eslint-react/eslint-plugin": "^5.8.3",
     "@eslint/compat": "^2.1.0",
     "@eslint/js": "^10.0.1",
     "@stylistic/eslint-plugin": "^5.10.0",
-    "@typescript-eslint/eslint-plugin": "^8.59.3",
-    "@typescript-eslint/parser": "^8.59.3",
+    "@typescript-eslint/eslint-plugin": "^8.59.4",
+    "@typescript-eslint/parser": "^8.59.4",
     "@vitest/eslint-plugin": "^1.6.17",
     "confusing-browser-globals": "^1.0.11",
     "eslint-import-resolver-typescript": "^4.4.4",
@@ -56,10 +56,10 @@
     "eslint-plugin-jsx-a11y": "^6.10.2",
     "eslint-plugin-n": "^18.0.1",
     "eslint-plugin-no-only-tests": "^3.4.0",
-    "eslint-plugin-playwright": "^2.10.2",
+    "eslint-plugin-playwright": "^2.10.4",
     "eslint-plugin-prettier": "^5.5.5",
     "eslint-plugin-promise": "^7.3.0",
-    "eslint-plugin-storybook": "^10.3.6",
+    "eslint-plugin-storybook": "^10.4.0",
     "eslint-plugin-styled-components-a11y": "^2.2.1",
     "eslint-plugin-testing-library": "^7.16.2",
     "globals": "^17.6.0",
@@ -71,13 +71,13 @@
     "@commitlint/cli": "^21.0.1",
     "@commitlint/config-conventional": "^21.0.1",
     "check-export-map": "^1.3.1",
-    "eslint": "^10.3.0",
+    "eslint": "^10.4.0",
     "glob": "^13.0.6",
     "husky": "^9.1.7",
     "prettier": "^3.8.3",
-    "storybook": "^10.3.6",
+    "storybook": "^10.4.0",
     "typescript": "^6.0.3",
-    "vitest": "^4.1.6"
+    "vitest": "^4.1.7"
   },
   "peerDependencies": {
     "eslint": ">= 10",

package/src/configs/storybook.mjs

@@ -16,7 +16,6 @@ export default [
       // storybook >7 requires default exports in stories
       'import-x/no-anonymous-default-export': 'off',
       'import-x/no-default-export': 'off',
-      'import-x/no-extraneous-dependencies': ['error', { devDependencies: true }],
       'import-x/prefer-default-export': 'error',
 
       // the default export is always called `meta` so the filenames

package/src/rules/base.mjs

@@ -293,7 +293,9 @@ export default {
 
   // Enforce camelcase naming convention
   // https://eslint.org/docs/rules/camelcase
-  camelcase: ['error', { properties: 'never', ignoreDestructuring: false }],
+  // decision: turned off to allow flexibility in naming, especially when working with APIs
+  // that may not follow camelCase conventions
+  camelcase: 'off',
 
   // Enforce or disallow capitalization of the first letter of a comment
   // https://eslint.org/docs/rules/capitalized-comments
@@ -350,7 +352,7 @@ export default {
 
   // Require or disallow named function expressions
   // https://eslint.org/docs/rules/func-names
-  'func-names': ['error', 'always'],
+  'func-names': ['error', 'as-needed'],
 
   // Enforce the consistent use of either function declarations or expressions assigned to variables
   // https://eslint.org/docs/rules/func-style
@@ -460,7 +462,9 @@ export default {
 
   // Disallow the use of console
   // https://eslint.org/docs/rules/no-console
-  'no-console': 'error',
+  // decision: allow console methods that are commonly used for logging and error reporting,
+  // but disallow others that are often left in accidentally
+  'no-console': ['error', { allow: ['log', 'warn', 'error'] }],
 
   // Disallow continue statements
   // https://eslint.org/docs/rules/no-continue
@@ -636,7 +640,6 @@ export default {
         'request', // for Express requests
         'res', // for Express responses
         'response', // for Express responses
-        '$scope', // for Angular 1 scopes
         'staticContext', // for ReactRouter context
       ],
     },

package/src/rules/import.mjs

@@ -39,30 +39,8 @@ export default {
 
   // Forbid the use of extraneous packages
   // https://github.com/un-ts/eslint-plugin-import-x/blob/master/docs/rules/no-extraneous-dependencies.md
-  // paths are treated both as absolute paths, and relative to process.cwd()
-  'import-x/no-extraneous-dependencies': [
-    'error',
-    {
-      devDependencies: [
-        '**/*{.,_}{test,vitest,spec}.{js,jsx,ts,tsx}', // tests where the extension or filename suffix denotes that it is a test
-        '**/vite.config.{ts,js,cjs,mjs,mts}', // vite config
-        '**/vitest.config.{ts,js,cjs,mjs,mts}', // vitest config
-        '**/jest.config.{js,cjs,mjs,mts}', // jest config
-        '**/jest.setup.{js,cjs,mjs,mts}', // jest setup
-        '**/eslint.config.{js,cjs,mjs,mts}', // eslint config
-        '**/.eslintrc.{js,cjs}', // eslint config
-        '**/.stylelintrc.{cjs,js,json,yaml,yml}', // stylelint config
-        '**/stylelint.config.{cjs,mjs,mts,js}', // stylelint config
-        '**/esbuild.config.{js,cjs,mjs,mts}', // esbuild config
-        '**/tsup.config.{js,cjs,mjs,mts}', // tsup config
-        '**/webpack.config.{js,cjs,mjs,mts}', // webpack config
-        '**/webpack.config.*.{js,cjs,mjs,mts}', // webpack alt config
-        '**/rollup.config.{js,cjs,mjs,mts}', // rollup config
-        '**/rollup.config.*.{js,cjs,mjs,mts}', // rollup config
-      ],
-      optionalDependencies: false,
-    },
-  ],
+  // rely on knip to handle this check, since it can be very slow
+  'import-x/no-extraneous-dependencies': 'off',
 
   // Forbid mutable exports
   // https://github.com/un-ts/eslint-plugin-import-x/blob/master/docs/rules/no-mutable-exports.md

package/src/rules/typescript.mjs

@@ -331,18 +331,8 @@ export default {
 
   // Disallow magic numbers
   // https://typescript-eslint.io/rules/no-magic-numbers
-  '@typescript-eslint/no-magic-numbers': [
-    'error',
-    {
-      ignore: [-1, 0, 1, 2, 3, 4, 5, 100, 1024, 1000, 10000],
-      ignoreArrayIndexes: true,
-      ignoreDefaultValues: true,
-      ignoreTypeIndexes: true,
-      ignoreReadonlyClassProperties: true,
-      ignoreEnums: true,
-      ignoreNumericLiteralTypes: true,
-    },
-  ],
+  // decision: good intention but it's the most disabled rule
+  '@typescript-eslint/no-magic-numbers': 'off',
 
   // Disallow the void operator except when used to discard a value
   // https://typescript-eslint.io/rules/no-meaningless-void-operator

package/test/__snapshots__/javascript.mjs.snap

@@ -64,7 +64,7 @@
       "undefined": false,
       "unescape": false,
     },
-    "parser": "typescript-eslint/parser@8.59.3",
+    "parser": "typescript-eslint/parser@8.59.4",
     "parserOptions": {
       "requireConfigFile": false,
     },
@@ -698,17 +698,18 @@
       2,
     ],
     "camelcase": [
-      2,
+      0,
       {
         "allow": [],
         "ignoreDestructuring": false,
         "ignoreGlobals": false,
         "ignoreImports": false,
-        "properties": "never",
+        "properties": "always",
       },
     ],
     "capitalized-comments": [
       0,
+      "always",
     ],
     "class-methods-use-this": [
       2,
@@ -779,10 +780,11 @@
     ],
     "func-name-matching": [
       0,
+      "always",
     ],
     "func-names": [
       2,
-      "always",
+      "as-needed",
       {},
     ],
     "func-style": [
@@ -934,27 +936,7 @@
       2,
     ],
     "import-x/no-extraneous-dependencies": [
-      2,
-      {
-        "devDependencies": [
-          "**/*{.,_}{test,vitest,spec}.{js,jsx,ts,tsx}",
-          "**/vite.config.{ts,js,cjs,mjs,mts}",
-          "**/vitest.config.{ts,js,cjs,mjs,mts}",
-          "**/jest.config.{js,cjs,mjs,mts}",
-          "**/jest.setup.{js,cjs,mjs,mts}",
-          "**/eslint.config.{js,cjs,mjs,mts}",
-          "**/.eslintrc.{js,cjs}",
-          "**/.stylelintrc.{cjs,js,json,yaml,yml}",
-          "**/stylelint.config.{cjs,mjs,mts,js}",
-          "**/esbuild.config.{js,cjs,mjs,mts}",
-          "**/tsup.config.{js,cjs,mjs,mts}",
-          "**/webpack.config.{js,cjs,mjs,mts}",
-          "**/webpack.config.*.{js,cjs,mjs,mts}",
-          "**/rollup.config.{js,cjs,mjs,mts}",
-          "**/rollup.config.*.{js,cjs,mjs,mts}",
-        ],
-        "optionalDependencies": false,
-      },
+      0,
     ],
     "import-x/no-import-module-exports": [
       2,
@@ -1058,6 +1040,7 @@
     ],
     "init-declarations": [
       0,
+      "always",
     ],
     "logical-assignment-operators": [
       2,
@@ -1081,9 +1064,11 @@
     ],
     "max-lines-per-function": [
       0,
+      50,
     ],
     "max-nested-callbacks": [
       0,
+      10,
     ],
     "max-params": [
       0,
@@ -1144,7 +1129,13 @@
     ],
     "no-console": [
       2,
-      {},
+      {
+        "allow": [
+          "log",
+          "warn",
+          "error",
+        ],
+      },
     ],
     "no-const-assign": [
       2,
@@ -1356,6 +1347,18 @@
     ],
     "no-magic-numbers": [
       0,
+      {
+        "detectObjects": false,
+        "enforceConst": false,
+        "ignore": [],
+        "ignoreArrayIndexes": false,
+        "ignoreClassFieldInitialValues": false,
+        "ignoreDefaultValues": false,
+        "ignoreEnums": false,
+        "ignoreNumericLiteralTypes": false,
+        "ignoreReadonlyClassProperties": false,
+        "ignoreTypeIndexes": false,
+      },
     ],
     "no-misleading-character-class": [
       2,
@@ -1418,7 +1421,6 @@
           "request",
           "res",
           "response",
-          "$scope",
           "staticContext",
         ],
         "props": true,
@@ -1918,7 +1920,9 @@
         "caughtErrors": "all",
         "caughtErrorsIgnorePattern": "^_",
         "destructuredArrayIgnorePattern": "^_",
+        "ignoreClassWithStaticInitBlock": false,
         "ignoreRestSiblings": true,
+        "ignoreUsingDeclarations": false,
         "reportUsedIgnorePattern": false,
         "vars": "all",
         "varsIgnorePattern": "^_",

package/test/__snapshots__/react.mjs.snap

@@ -1204,7 +1204,7 @@
   },
   "plugins": [
     "@",
-    "@eslint-react:@eslint-react/eslint-plugin@5.7.7",
+    "@eslint-react:@eslint-react/eslint-plugin@5.8.3",
     "jsx-a11y:eslint-plugin-jsx-a11y@6.10.2",
   ],
   "rules": {

package/test/__snapshots__/storybook.mjs.snap

@@ -27,12 +27,6 @@
     "import-x/no-default-export": [
       0,
     ],
-    "import-x/no-extraneous-dependencies": [
-      2,
-      {
-        "devDependencies": true,
-      },
-    ],
     "import-x/prefer-default-export": [
       2,
     ],

package/test/__snapshots__/typescript.mjs.snap

@@ -64,7 +64,7 @@
       "undefined": false,
       "unescape": false,
     },
-    "parser": "typescript-eslint/parser@8.59.3",
+    "parser": "typescript-eslint/parser@8.59.4",
     "parserOptions": {
       "ecmaVersion": 2024,
       "project": "./tsconfig.json",
@@ -78,7 +78,7 @@
   "plugins": [
     "@",
     "@stylistic:@stylistic/eslint-plugin@5.10.0",
-    "@typescript-eslint:@typescript-eslint/eslint-plugin@8.59.3",
+    "@typescript-eslint:@typescript-eslint/eslint-plugin@8.59.4",
     "barrel-files:eslint-plugin-barrel-files@3.0.1",
     "filenames",
     "import-x:eslint-plugin-import-x@4.16.2",
@@ -831,30 +831,16 @@
       2,
     ],
     "@typescript-eslint/no-magic-numbers": [
-      2,
+      0,
       {
         "detectObjects": false,
         "enforceConst": false,
-        "ignore": [
-          -1,
-          0,
-          1,
-          2,
-          3,
-          4,
-          5,
-          100,
-          1024,
-          1000,
-          10000,
-        ],
-        "ignoreArrayIndexes": true,
-        "ignoreClassFieldInitialValues": false,
-        "ignoreDefaultValues": true,
-        "ignoreEnums": true,
-        "ignoreNumericLiteralTypes": true,
-        "ignoreReadonlyClassProperties": true,
-        "ignoreTypeIndexes": true,
+        "ignore": [],
+        "ignoreArrayIndexes": false,
+        "ignoreEnums": false,
+        "ignoreNumericLiteralTypes": false,
+        "ignoreReadonlyClassProperties": false,
+        "ignoreTypeIndexes": false,
       },
     ],
     "@typescript-eslint/no-meaningless-void-operator": [
@@ -1149,17 +1135,18 @@
       2,
     ],
     "camelcase": [
-      2,
+      0,
       {
         "allow": [],
         "ignoreDestructuring": false,
         "ignoreGlobals": false,
         "ignoreImports": false,
-        "properties": "never",
+        "properties": "always",
       },
     ],
     "capitalized-comments": [
       0,
+      "always",
     ],
     "class-methods-use-this": [
       0,
@@ -1230,10 +1217,11 @@
     ],
     "func-name-matching": [
       0,
+      "always",
     ],
     "func-names": [
       2,
-      "always",
+      "as-needed",
       {},
     ],
     "func-style": [
@@ -1385,27 +1373,7 @@
       2,
     ],
     "import-x/no-extraneous-dependencies": [
-      2,
-      {
-        "devDependencies": [
-          "**/*{.,_}{test,vitest,spec}.{js,jsx,ts,tsx}",
-          "**/vite.config.{ts,js,cjs,mjs,mts}",
-          "**/vitest.config.{ts,js,cjs,mjs,mts}",
-          "**/jest.config.{js,cjs,mjs,mts}",
-          "**/jest.setup.{js,cjs,mjs,mts}",
-          "**/eslint.config.{js,cjs,mjs,mts}",
-          "**/.eslintrc.{js,cjs}",
-          "**/.stylelintrc.{cjs,js,json,yaml,yml}",
-          "**/stylelint.config.{cjs,mjs,mts,js}",
-          "**/esbuild.config.{js,cjs,mjs,mts}",
-          "**/tsup.config.{js,cjs,mjs,mts}",
-          "**/webpack.config.{js,cjs,mjs,mts}",
-          "**/webpack.config.*.{js,cjs,mjs,mts}",
-          "**/rollup.config.{js,cjs,mjs,mts}",
-          "**/rollup.config.*.{js,cjs,mjs,mts}",
-        ],
-        "optionalDependencies": false,
-      },
+      0,
     ],
     "import-x/no-import-module-exports": [
       2,
@@ -1509,6 +1477,7 @@
     ],
     "init-declarations": [
       0,
+      "always",
     ],
     "logical-assignment-operators": [
       2,
@@ -1532,12 +1501,15 @@
     ],
     "max-lines-per-function": [
       0,
+      50,
     ],
     "max-nested-callbacks": [
       0,
+      10,
     ],
     "max-params": [
       0,
+      3,
     ],
     "max-statements": [
       0,
@@ -1594,7 +1566,13 @@
     ],
     "no-console": [
       2,
-      {},
+      {
+        "allow": [
+          "log",
+          "warn",
+          "error",
+        ],
+      },
     ],
     "no-const-assign": [
       2,
@@ -1802,6 +1780,18 @@
     ],
     "no-magic-numbers": [
       0,
+      {
+        "detectObjects": false,
+        "enforceConst": false,
+        "ignore": [],
+        "ignoreArrayIndexes": false,
+        "ignoreClassFieldInitialValues": false,
+        "ignoreDefaultValues": false,
+        "ignoreEnums": false,
+        "ignoreNumericLiteralTypes": false,
+        "ignoreReadonlyClassProperties": false,
+        "ignoreTypeIndexes": false,
+      },
     ],
     "no-misleading-character-class": [
       2,
@@ -1864,7 +1854,6 @@
           "request",
           "res",
           "response",
-          "$scope",
           "staticContext",
         ],
         "props": true,
@@ -2366,6 +2355,15 @@
     ],
     "no-unused-vars": [
       0,
+      {
+        "args": "after-used",
+        "caughtErrors": "all",
+        "ignoreClassWithStaticInitBlock": false,
+        "ignoreRestSiblings": false,
+        "ignoreUsingDeclarations": false,
+        "reportUsedIgnorePattern": false,
+        "vars": "all",
+      },
     ],
     "no-use-before-define": [
       0,