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

package/docs/breaking-changes/v17.md

@@ -0,0 +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.

package/index.cjs

@@ -1,6 +1,3 @@
-// @ts-check
-
-/** @import { ConfigWithExtends } from "typescript-eslint" */
 const eslint = require("@eslint/js");
 const tsParser = require("@typescript-eslint/parser");
 const importPlugin = require("eslint-plugin-import");
@@ -31,13 +28,6 @@ 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],
@@ -48,19 +38,9 @@ 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: [getImportPluginFlatConfigs().recommended],
+    extends: [importPlugin.flatConfigs.recommended],
     rules: {
       "import/default": "off",
       "import/named": "off",
@@ -130,12 +110,16 @@ const typescriptConfig = () =>
   tseslint.config({
     extends: [
       tseslint.configs.recommendedTypeChecked,
-      // @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,
+      importPlugin.flatConfigs.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}
        */
@@ -175,16 +159,17 @@ const typescriptConfig = () =>
 
 /**
  *
- * @param {object} options Configuration options
- * @param {boolean} options.typescript Whether to include typescript rules
+ * @param options Configuration options
+ * @param options.typescript Whether to include typescript rules
+ * @returns {ConfigArray}
  */
 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"]],
@@ -206,9 +191,6 @@ const testConfig = (options) => {
   });
 };
 
-/**
- * @param {string[]} ignores
- */
 const ignoresConfig = (ignores = []) =>
   tseslint.config({
     ignores: ["**/.yalc", "**/dist", ...ignores],
@@ -216,16 +198,16 @@ const ignoresConfig = (ignores = []) =>
 
 /**
  * Turo eslint configuration for typescript
- * @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
+ * @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}
  */
 module.exports = function config(options = {}) {
   const useTypescript =
     options.typescript === undefined ? true : options.typescript;
-
   return tseslint.config(
     javascriptConfig(options.ecmaVersion),
     importConfig(),

package/package.json

@@ -4,8 +4,9 @@
   "type": "module",
   "dependencies": {
     "@eslint/js": "9.29.0",
-    "@typescript-eslint/eslint-plugin": "8.34.1",
-    "@typescript-eslint/parser": "8.34.1",
+    "typescript-eslint": "8.34.0",
+    "@typescript-eslint/eslint-plugin": "8.34.0",
+    "@typescript-eslint/parser": "8.34.0",
     "eslint-config-prettier": "10.1.5",
     "eslint-import-resolver-typescript": "4.4.3",
     "eslint-plugin-import": "2.31.0",
@@ -15,8 +16,7 @@
     "eslint-plugin-perfectionist": "4.14.0",
     "eslint-plugin-prettier": "5.4.1",
     "eslint-plugin-sonarjs": "3.0.2",
-    "eslint-plugin-unicorn": "56.0.1",
-    "typescript-eslint": "8.34.1"
+    "eslint-plugin-unicorn": "56.0.1"
   },
   "devDependencies": {
     "eslint": "9.29.0",
@@ -54,6 +54,6 @@
     "access": "public"
   },
   "repository": "https://github.com/open-turo/eslint-config-typescript",
-  "version": "16.0.8",
+  "version": "17.0.0-pr-382.72.1.1",
   "packageManager": "npm@11.4.2+sha512.f90c1ec8b207b625d6edb6693aef23dacb39c38e4217fe8c46a973f119cab392ac0de23fe3f07e583188dae9fd9108b3845ad6f525b598742bd060ebad60bff3"
 }

package/recommended.cjs

@@ -48,6 +48,11 @@ 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

@@ -1,4 +1,4 @@
-// Jest Snapshot v1, https://goo.gl/fbAQLP
+// Jest Snapshot v1, https://jestjs.io/docs/snapshot-testing
 
 exports[`validate config the flat config is correct for index.cjs 1`] = `
 {
@@ -566,6 +566,12 @@ 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,
     {
@@ -3535,6 +3541,12 @@ 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,
     {
@@ -6507,6 +6519,12 @@ 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",
     {