@open-turo/eslint-config-typescript 17.0.13 → 18.0.0

package/docs/breaking-changes/v18.md

@@ -0,0 +1,3 @@
+# Breaking changes in v18
+
+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

@@ -136,6 +136,11 @@ const typescriptConfig = () =>
     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}
        */

package/package.json

@@ -55,6 +55,6 @@
     "access": "public"
   },
   "repository": "https://github.com/open-turo/eslint-config-typescript",
-  "version": "17.0.13",
+  "version": "18.0.0",
   "packageManager": "npm@11.5.1+sha512.232e6f5d9e799bcb486920b3e9ba907fdf96e576cf7e8c9446c8162e33a416096a1d37a9e910d9a918f6b1f606791c99bc6bb61ee2569b496ec74af13d0dbd95"
 }

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

@@ -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,
     {
@@ -3610,6 +3616,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,
     {
@@ -6657,6 +6669,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",
     {