@open-turo/eslint-config-typescript 17.0.0-pr-382.72.1.1 → 17.0.0

package/docs/breaking-changes/v17.md

@@ -1,3 +1,3 @@
 # Breaking changes in v17
 
-Adds `@typescript-eslint/consistent-type-assertions` configuration, which will raise errors in consumer repos. We have multiple years of relying on `as` casting as a TypeScript work-around (which is dangerous, compared to type-narrowing in runtime code) in our code, so this specific rule change will require a large amount of effort for compliance--even if adding `// eslint-disable` to all existing instances, or adding [eslint-seatbelt](https://www.notion.com/blog/how-we-evolved-our-code-notions-ratcheting-system-using-custom-eslint-rules)--and so we are marking it as a new major version.
+Sonar removed `sonarjs/no-invalid-await` between patch versions. We are cutting a major to reflect this rule is no longer in the config: any existing `// eslint-disable` directives for this rule should be removed for clarity.

package/index.cjs

@@ -1,3 +1,6 @@
+// @ts-check
+
+/** @import { ConfigWithExtends } from "typescript-eslint" */
 const eslint = require("@eslint/js");
 const tsParser = require("@typescript-eslint/parser");
 const importPlugin = require("eslint-plugin-import");
@@ -28,6 +31,13 @@ const typescriptLanguageOptions = () => ({
   },
 });
 
+/**
+ * @typedef {NonNullable<NonNullable<ConfigWithExtends['languageOptions']>['parserOptions']>['ecmaVersion']} EcmaVersion
+ */
+
+/**
+ * @param {EcmaVersion} [ecmaVersion]
+ */
 const javascriptConfig = (ecmaVersion = "latest") =>
   tseslint.config(eslint.configs.recommended, {
     files: [FILES_JS],
@@ -38,9 +48,19 @@ const javascriptConfig = (ecmaVersion = "latest") =>
     },
   });
 
+const getImportPluginFlatConfigs = () => {
+  if (!importPlugin.flatConfigs) {
+    throw new Error(
+      "Unexpected value from eslint-plugin-import. You will need to upgrade the plugin.",
+    );
+  }
+
+  return importPlugin.flatConfigs;
+};
+
 const importConfig = () =>
   tseslint.config({
-    extends: [importPlugin.flatConfigs.recommended],
+    extends: [getImportPluginFlatConfigs().recommended],
     rules: {
       "import/default": "off",
       "import/named": "off",
@@ -110,16 +130,12 @@ const typescriptConfig = () =>
   tseslint.config({
     extends: [
       tseslint.configs.recommendedTypeChecked,
-      importPlugin.flatConfigs.typescript,
+      // @ts-expect-error -- We are inferring the types of this import from runtime, but the rule values are inferred as `string` instead of `RuleEntry` ("off" | "warn" | "error")
+      getImportPluginFlatConfigs().typescript,
     ],
     files: [FILES_TS, FILES_TSX],
     languageOptions: typescriptLanguageOptions(),
     rules: {
-      /** Forbids `as` casting (that excludes `as const`) to prevent unsafe type casts */
-      "@typescript-eslint/consistent-type-assertions": [
-        "error",
-        { assertionStyle: "never" },
-      ],
       /**
        * {@link https://typescript-eslint.io/rules/consistent-type-imports | TypeScript ESLint: consistent-type-imports docs}
        */
@@ -159,17 +175,16 @@ const typescriptConfig = () =>
 
 /**
  *
- * @param options Configuration options
- * @param options.typescript Whether to include typescript rules
- * @returns {ConfigArray}
+ * @param {object} options Configuration options
+ * @param {boolean} options.typescript Whether to include typescript rules
  */
 const testConfig = (options) => {
   const typescriptRules = options.typescript
-    ? {
+    ? /** @type {const} */ ({
         // this turns the original rule off *only* for test files, for jestPlugin compatibility
         "@typescript-eslint/unbound-method": "off",
         "jest/unbound-method": "error",
-      }
+      })
     : {};
   return tseslint.config({
     extends: [jestPlugin.configs["flat/recommended"]],
@@ -191,6 +206,9 @@ const testConfig = (options) => {
   });
 };
 
+/**
+ * @param {string[]} ignores
+ */
 const ignoresConfig = (ignores = []) =>
   tseslint.config({
     ignores: ["**/.yalc", "**/dist", ...ignores],
@@ -198,16 +216,16 @@ const ignoresConfig = (ignores = []) =>
 
 /**
  * Turo eslint configuration for typescript
- * @param [options] - Eslint config options
- * @param [options.allowModules] - List of modules to allow in the n/no-unpublished-import rule
- * @param [options.ignores] - List of patterns to ignore
- * @param [options.typescript] - Whether to include typescript rules
- * @param [options.ecmaVersion] - The ECMAScript version to use
- * @returns {ConfigArray}
+ * @param {object} [options] - Eslint config options
+ * @param {string[]} [options.allowModules] - List of modules to allow in the n/no-unpublished-import rule
+ * @param {string[]} [options.ignores] - List of patterns to ignore
+ * @param {boolean} [options.typescript] - Whether to include typescript rules
+ * @param {EcmaVersion} [options.ecmaVersion] - The ECMAScript version to use
  */
 module.exports = function config(options = {}) {
   const useTypescript =
     options.typescript === undefined ? true : options.typescript;
+
   return tseslint.config(
     javascriptConfig(options.ecmaVersion),
     importConfig(),

package/package.json

@@ -4,19 +4,19 @@
   "type": "module",
   "dependencies": {
     "@eslint/js": "9.29.0",
-    "typescript-eslint": "8.34.0",
-    "@typescript-eslint/eslint-plugin": "8.34.0",
-    "@typescript-eslint/parser": "8.34.0",
+    "@typescript-eslint/eslint-plugin": "8.34.1",
+    "@typescript-eslint/parser": "8.34.1",
     "eslint-config-prettier": "10.1.5",
     "eslint-import-resolver-typescript": "4.4.3",
     "eslint-plugin-import": "2.31.0",
     "eslint-plugin-jest": "28.14.0",
     "eslint-plugin-json": "4.0.1",
     "eslint-plugin-n": "17.20.0",
-    "eslint-plugin-perfectionist": "4.14.0",
-    "eslint-plugin-prettier": "5.4.1",
-    "eslint-plugin-sonarjs": "3.0.2",
-    "eslint-plugin-unicorn": "56.0.1"
+    "eslint-plugin-perfectionist": "4.15.0",
+    "eslint-plugin-prettier": "5.5.0",
+    "eslint-plugin-sonarjs": "3.0.3",
+    "eslint-plugin-unicorn": "56.0.1",
+    "typescript-eslint": "8.34.1"
   },
   "devDependencies": {
     "eslint": "9.29.0",
@@ -54,6 +54,6 @@
     "access": "public"
   },
   "repository": "https://github.com/open-turo/eslint-config-typescript",
-  "version": "17.0.0-pr-382.72.1.1",
+  "version": "17.0.0",
   "packageManager": "npm@11.4.2+sha512.f90c1ec8b207b625d6edb6693aef23dacb39c38e4217fe8c46a973f119cab392ac0de23fe3f07e583188dae9fd9108b3845ad6f525b598742bd060ebad60bff3"
 }

package/recommended.cjs

@@ -48,11 +48,6 @@ module.exports = {
   ],
   root: true,
   rules: {
-    /** Forbids `as` casting (that excludes `as const`) to prevent unsafe type casts */
-    "@typescript-eslint/consistent-type-assertions": [
-      "error",
-      { assertionStyle: "never" },
-    ],
     /**
      * {@link https://typescript-eslint.io/rules/consistent-type-imports | TypeScript ESLint: consistent-type-imports docs}
      */

package/test/__snapshots__/test.spec.js.snap

@@ -566,12 +566,6 @@ exports[`validate config the flat config is correct for index.cjs 1`] = `
   "@typescript-eslint/comma-spacing": [
     0,
   ],
-  "@typescript-eslint/consistent-type-assertions": [
-    2,
-    {
-      "assertionStyle": "never",
-    },
-  ],
   "@typescript-eslint/consistent-type-imports": [
     2,
     {
@@ -1607,6 +1601,10 @@ exports[`validate config the flat config is correct for index.cjs 1`] = `
   ],
   "sonarjs/arrow-function-convention": [
     0,
+    {
+      "requireBodyBraces": false,
+      "requireParameterParentheses": false,
+    },
   ],
   "sonarjs/assertions-in-tests": [
     2,
@@ -1688,6 +1686,9 @@ exports[`validate config the flat config is correct for index.cjs 1`] = `
   ],
   "sonarjs/class-name": [
     2,
+    {
+      "format": "^[A-Z][a-zA-Z0-9]*$",
+    },
   ],
   "sonarjs/class-prototype": [
     0,
@@ -1697,12 +1698,18 @@ exports[`validate config the flat config is correct for index.cjs 1`] = `
   ],
   "sonarjs/cognitive-complexity": [
     2,
+    15,
   ],
   "sonarjs/comma-or-logical-or-case": [
     2,
   ],
   "sonarjs/comment-regex": [
     0,
+    {
+      "flags": "",
+      "message": "The regular expression matches this comment.",
+      "regularExpression": "",
+    },
   ],
   "sonarjs/concise-regex": [
     2,
@@ -1718,6 +1725,10 @@ exports[`validate config the flat config is correct for index.cjs 1`] = `
   ],
   "sonarjs/content-length": [
     2,
+    {
+      "fileUploadSizeLimit": 8000000,
+      "standardSizeLimit": 2000000,
+    },
   ],
   "sonarjs/content-security-policy": [
     2,
@@ -1736,6 +1747,9 @@ exports[`validate config the flat config is correct for index.cjs 1`] = `
   ],
   "sonarjs/cyclomatic-complexity": [
     0,
+    {
+      "threshold": 10,
+    },
   ],
   "sonarjs/declarations-in-global-scope": [
     0,
@@ -1778,15 +1792,23 @@ exports[`validate config the flat config is correct for index.cjs 1`] = `
   ],
   "sonarjs/enforce-trailing-comma": [
     0,
+    "always-multiline",
   ],
   "sonarjs/existing-groups": [
     2,
   ],
   "sonarjs/expression-complexity": [
     0,
+    {
+      "max": 3,
+    },
   ],
   "sonarjs/file-header": [
     0,
+    {
+      "headerFormat": "",
+      "isRegularExpression": false,
+    },
   ],
   "sonarjs/file-name-differ-from-class": [
     0,
@@ -1814,6 +1836,9 @@ exports[`validate config the flat config is correct for index.cjs 1`] = `
   ],
   "sonarjs/function-name": [
     0,
+    {
+      "format": "^[_a-z][a-zA-Z0-9]*$",
+    },
   ],
   "sonarjs/function-return-type": [
     0,
@@ -1859,24 +1884,40 @@ exports[`validate config the flat config is correct for index.cjs 1`] = `
   ],
   "sonarjs/max-lines": [
     0,
+    {
+      "maximum": 1000,
+    },
   ],
   "sonarjs/max-lines-per-function": [
     0,
+    {
+      "maximum": 200,
+    },
   ],
   "sonarjs/max-switch-cases": [
     2,
+    30,
   ],
   "sonarjs/max-union-size": [
     0,
+    {
+      "threshold": 3,
+    },
   ],
   "sonarjs/misplaced-loop-counter": [
     2,
   ],
   "sonarjs/nested-control-flow": [
     0,
+    {
+      "maximumNestingLevel": 3,
+    },
   ],
   "sonarjs/new-operator-misuse": [
     2,
+    {
+      "considerJSDoc": false,
+    },
   ],
   "sonarjs/no-all-duplicated-branches": [
     2,
@@ -1931,6 +1972,10 @@ exports[`validate config the flat config is correct for index.cjs 1`] = `
   ],
   "sonarjs/no-duplicate-string": [
     0,
+    {
+      "ignoreStrings": "application/json",
+      "threshold": 3,
+    },
   ],
   "sonarjs/no-duplicated-branches": [
     2,
@@ -1988,9 +2033,21 @@ exports[`validate config the flat config is correct for index.cjs 1`] = `
   ],
   "sonarjs/no-hardcoded-passwords": [
     2,
+    {
+      "passwordWords": [
+        "password",
+        "pwd",
+        "passwd",
+        "passphrase",
+      ],
+    },
   ],
   "sonarjs/no-hardcoded-secrets": [
     2,
+    {
+      "randomnessSensibility": 5,
+      "secretWords": "api[_.-]?key,auth,credential,secret,token",
+    },
   ],
   "sonarjs/no-hook-setter-in-body": [
     2,
@@ -2003,6 +2060,7 @@ exports[`validate config the flat config is correct for index.cjs 1`] = `
   ],
   "sonarjs/no-identical-functions": [
     2,
+    3,
   ],
   "sonarjs/no-ignored-exceptions": [
     0,
@@ -2012,6 +2070,9 @@ exports[`validate config the flat config is correct for index.cjs 1`] = `
   ],
   "sonarjs/no-implicit-dependencies": [
     0,
+    {
+      "whitelist": [],
+    },
   ],
   "sonarjs/no-implicit-global": [
     2,
@@ -2033,9 +2094,11 @@ exports[`validate config the flat config is correct for index.cjs 1`] = `
   ],
   "sonarjs/no-intrusive-permissions": [
     2,
-  ],
-  "sonarjs/no-invalid-await": [
-    2,
+    {
+      "permissions": [
+        "geolocation",
+      ],
+    },
   ],
   "sonarjs/no-invalid-regexp": [
     2,
@@ -2291,6 +2354,9 @@ exports[`validate config the flat config is correct for index.cjs 1`] = `
   ],
   "sonarjs/regex-complexity": [
     2,
+    {
+      "threshold": 20,
+    },
   ],
   "sonarjs/regular-expr": [
     0,
@@ -2381,6 +2447,9 @@ exports[`validate config the flat config is correct for index.cjs 1`] = `
   ],
   "sonarjs/variable-name": [
     0,
+    {
+      "format": "^[_$A-Za-z][$A-Za-z0-9]*$|^[_$A-Z][_$A-Z0-9]+$",
+    },
   ],
   "sonarjs/void-use": [
     2,
@@ -3541,12 +3610,6 @@ exports[`validate config the flat config is correct for index.mjs 1`] = `
   "@typescript-eslint/comma-spacing": [
     0,
   ],
-  "@typescript-eslint/consistent-type-assertions": [
-    2,
-    {
-      "assertionStyle": "never",
-    },
-  ],
   "@typescript-eslint/consistent-type-imports": [
     2,
     {
@@ -4582,6 +4645,10 @@ exports[`validate config the flat config is correct for index.mjs 1`] = `
   ],
   "sonarjs/arrow-function-convention": [
     0,
+    {
+      "requireBodyBraces": false,
+      "requireParameterParentheses": false,
+    },
   ],
   "sonarjs/assertions-in-tests": [
     2,
@@ -4663,6 +4730,9 @@ exports[`validate config the flat config is correct for index.mjs 1`] = `
   ],
   "sonarjs/class-name": [
     2,
+    {
+      "format": "^[A-Z][a-zA-Z0-9]*$",
+    },
   ],
   "sonarjs/class-prototype": [
     0,
@@ -4672,12 +4742,18 @@ exports[`validate config the flat config is correct for index.mjs 1`] = `
   ],
   "sonarjs/cognitive-complexity": [
     2,
+    15,
   ],
   "sonarjs/comma-or-logical-or-case": [
     2,
   ],
   "sonarjs/comment-regex": [
     0,
+    {
+      "flags": "",
+      "message": "The regular expression matches this comment.",
+      "regularExpression": "",
+    },
   ],
   "sonarjs/concise-regex": [
     2,
@@ -4693,6 +4769,10 @@ exports[`validate config the flat config is correct for index.mjs 1`] = `
   ],
   "sonarjs/content-length": [
     2,
+    {
+      "fileUploadSizeLimit": 8000000,
+      "standardSizeLimit": 2000000,
+    },
   ],
   "sonarjs/content-security-policy": [
     2,
@@ -4711,6 +4791,9 @@ exports[`validate config the flat config is correct for index.mjs 1`] = `
   ],
   "sonarjs/cyclomatic-complexity": [
     0,
+    {
+      "threshold": 10,
+    },
   ],
   "sonarjs/declarations-in-global-scope": [
     0,
@@ -4753,15 +4836,23 @@ exports[`validate config the flat config is correct for index.mjs 1`] = `
   ],
   "sonarjs/enforce-trailing-comma": [
     0,
+    "always-multiline",
   ],
   "sonarjs/existing-groups": [
     2,
   ],
   "sonarjs/expression-complexity": [
     0,
+    {
+      "max": 3,
+    },
   ],
   "sonarjs/file-header": [
     0,
+    {
+      "headerFormat": "",
+      "isRegularExpression": false,
+    },
   ],
   "sonarjs/file-name-differ-from-class": [
     0,
@@ -4789,6 +4880,9 @@ exports[`validate config the flat config is correct for index.mjs 1`] = `
   ],
   "sonarjs/function-name": [
     0,
+    {
+      "format": "^[_a-z][a-zA-Z0-9]*$",
+    },
   ],
   "sonarjs/function-return-type": [
     0,
@@ -4834,24 +4928,40 @@ exports[`validate config the flat config is correct for index.mjs 1`] = `
   ],
   "sonarjs/max-lines": [
     0,
+    {
+      "maximum": 1000,
+    },
   ],
   "sonarjs/max-lines-per-function": [
     0,
+    {
+      "maximum": 200,
+    },
   ],
   "sonarjs/max-switch-cases": [
     2,
+    30,
   ],
   "sonarjs/max-union-size": [
     0,
+    {
+      "threshold": 3,
+    },
   ],
   "sonarjs/misplaced-loop-counter": [
     2,
   ],
   "sonarjs/nested-control-flow": [
     0,
+    {
+      "maximumNestingLevel": 3,
+    },
   ],
   "sonarjs/new-operator-misuse": [
     2,
+    {
+      "considerJSDoc": false,
+    },
   ],
   "sonarjs/no-all-duplicated-branches": [
     2,
@@ -4906,6 +5016,10 @@ exports[`validate config the flat config is correct for index.mjs 1`] = `
   ],
   "sonarjs/no-duplicate-string": [
     0,
+    {
+      "ignoreStrings": "application/json",
+      "threshold": 3,
+    },
   ],
   "sonarjs/no-duplicated-branches": [
     2,
@@ -4963,9 +5077,21 @@ exports[`validate config the flat config is correct for index.mjs 1`] = `
   ],
   "sonarjs/no-hardcoded-passwords": [
     2,
+    {
+      "passwordWords": [
+        "password",
+        "pwd",
+        "passwd",
+        "passphrase",
+      ],
+    },
   ],
   "sonarjs/no-hardcoded-secrets": [
     2,
+    {
+      "randomnessSensibility": 5,
+      "secretWords": "api[_.-]?key,auth,credential,secret,token",
+    },
   ],
   "sonarjs/no-hook-setter-in-body": [
     2,
@@ -4978,6 +5104,7 @@ exports[`validate config the flat config is correct for index.mjs 1`] = `
   ],
   "sonarjs/no-identical-functions": [
     2,
+    3,
   ],
   "sonarjs/no-ignored-exceptions": [
     0,
@@ -4987,6 +5114,9 @@ exports[`validate config the flat config is correct for index.mjs 1`] = `
   ],
   "sonarjs/no-implicit-dependencies": [
     0,
+    {
+      "whitelist": [],
+    },
   ],
   "sonarjs/no-implicit-global": [
     2,
@@ -5008,9 +5138,11 @@ exports[`validate config the flat config is correct for index.mjs 1`] = `
   ],
   "sonarjs/no-intrusive-permissions": [
     2,
-  ],
-  "sonarjs/no-invalid-await": [
-    2,
+    {
+      "permissions": [
+        "geolocation",
+      ],
+    },
   ],
   "sonarjs/no-invalid-regexp": [
     2,
@@ -5266,6 +5398,9 @@ exports[`validate config the flat config is correct for index.mjs 1`] = `
   ],
   "sonarjs/regex-complexity": [
     2,
+    {
+      "threshold": 20,
+    },
   ],
   "sonarjs/regular-expr": [
     0,
@@ -5356,6 +5491,9 @@ exports[`validate config the flat config is correct for index.mjs 1`] = `
   ],
   "sonarjs/variable-name": [
     0,
+    {
+      "format": "^[_$A-Za-z][$A-Za-z0-9]*$|^[_$A-Z][_$A-Z0-9]+$",
+    },
   ],
   "sonarjs/void-use": [
     2,
@@ -6519,12 +6657,6 @@ exports[`validate config the legacy recommended config is correct 1`] = `
   "@typescript-eslint/comma-spacing": [
     "off",
   ],
-  "@typescript-eslint/consistent-type-assertions": [
-    "error",
-    {
-      "assertionStyle": "never",
-    },
-  ],
   "@typescript-eslint/consistent-type-imports": [
     "error",
     {
@@ -8051,9 +8183,6 @@ exports[`validate config the legacy recommended config is correct 1`] = `
   "sonarjs/no-intrusive-permissions": [
     "error",
   ],
-  "sonarjs/no-invalid-await": [
-    "error",
-  ],
   "sonarjs/no-invalid-regexp": [
     "error",
   ],