fix(prefer-readonly-types): replace readonly-array and readonly-keyword with prefer-readonly-types

Author: Rebecca Stevens

.eslintrc

@@ -33,8 +33,10 @@
     // Our rules.
     "ts-immutable/immutable-data": "error",
     "ts-immutable/no-let": "error",
-    "ts-immutable/readonly-array": ["error", { "ignoreReturnType": true }],
-    "ts-immutable/readonly-keyword": "error",
+    "ts-immutable/prefer-readonly-types": [
+      "error",
+      { "ignoreReturnType": true }
+    ],
     "ts-immutable/no-method-signature": "error",
     "ts-immutable/no-this": "error",
     "ts-immutable/no-class": "error",

src/configs/all.ts

@@ -17,8 +17,7 @@ const config = {
       rules: {
         "ts-immutable/no-method-signature": "error",
         "ts-immutable/no-mixed-interface": "error",
-        "ts-immutable/readonly-array": "error",
-        "ts-immutable/readonly-keyword": "error"
+        "ts-immutable/prefer-readonly-types": "error"
       }
     }
   ]

src/configs/immutable.ts

@@ -14,8 +14,7 @@ const config = deepMerge([
         files: ["*.ts", "*.tsx"],
         rules: {
           "ts-immutable/no-method-signature": "warn",
-          "ts-immutable/readonly-array": "error",
-          "ts-immutable/readonly-keyword": "error"
+          "ts-immutable/prefer-readonly-types": "error"
         }
       }
     ]

tests/rules/_work.test.ts

@@ -9,7 +9,7 @@ import { RuleTester } from "eslint";
  * Step 1.
  * Import the rule to test.
  */
-import { rule } from "../../src/rules/readonly-array";
+import { rule } from "../../src/rules/prefer-readonly-types";
 
 import { typescript } from "../configs";
 

tests/util.ts

@@ -61,7 +61,7 @@ export function processInvalidTestCase(
       ];
     },
     []
-    /* eslint-disable ts-immutable/readonly-array */
+    /* eslint-disable-next-line ts-immutable/prefer-readonly-types */
   ) as Array<ESLintRuleTester.InvalidTestCase>;
 }
 
@@ -89,5 +89,5 @@ export function createDummyRule(
   };
 
   /* eslint-disable-next-line @typescript-eslint/no-explicit-any */
-  return createRule<"generic", Array<any>>("dummy", meta, [], create);
+  return createRule<"generic", ReadonlyArray<any>>("dummy", meta, [], create);
 }