fix(eslint-plugin): delete [] in message if ReadOnly<string[]> is detected (typescript-eslint#9513)

YutongZhuu · web-flow · commit 8e0125487c69 · 2024-08-19T07:14:50.000-04:00
* delete [] in meesage if ReadOnly&lt;string[]&gt; is detected

* issue fix

* added unit testing for this change
diff --git a/packages/eslint-plugin/src/rules/array-type.ts b/packages/eslint-plugin/src/rules/array-type.ts
@@ -83,7 +83,8 @@ type MessageIds =
   | 'errorStringArraySimple'
   | 'errorStringGeneric'
   | 'errorStringGenericSimple'
-  | 'errorStringArrayReadonly';
+  | 'errorStringArrayReadonly'
+  | 'errorStringArraySimpleReadonly';
 
 export default createRule<Options, MessageIds>({
   name: 'array-type',
@@ -106,6 +107,8 @@ export default createRule<Options, MessageIds>({
         "Array type using '{{className}}<{{type}}>' is forbidden for simple types. Use '{{readonlyPrefix}}{{type}}[]' instead.",
       errorStringGenericSimple:
         "Array type using '{{readonlyPrefix}}{{type}}[]' is forbidden for non-simple types. Use '{{className}}<{{type}}>' instead.",
+      errorStringArraySimpleReadonly:
+        "Array type using '{{className}}<{{type}}>' is forbidden for simple types. Use '{{readonlyPrefix}}{{type}}' instead.",
     },
     schema: [
       {
@@ -233,7 +236,9 @@ export default createRule<Options, MessageIds>({
             ? isReadonlyWithGenericArrayType
               ? 'errorStringArrayReadonly'
               : 'errorStringArray'
-            : 'errorStringArraySimple';
+            : isReadonlyArrayType && node.typeName.name !== 'ReadonlyArray'
+              ? 'errorStringArraySimpleReadonly'
+              : 'errorStringArraySimple';
 
         if (!typeParams || typeParams.length === 0) {
           // Create an 'any' array
@@ -271,7 +276,6 @@ export default createRule<Options, MessageIds>({
           typeParens ? '(' : ''
         }`;
         const end = `${typeParens ? ')' : ''}${isReadonlyWithGenericArrayType ? '' : `[]`}${parentParens ? ')' : ''}`;
-
         context.report({
           node,
           messageId,
diff --git a/packages/eslint-plugin/tests/rules/array-type.test.ts b/packages/eslint-plugin/tests/rules/array-type.test.ts
@@ -1939,6 +1939,21 @@ interface FooInterface {
         },
       ],
     },
+    {
+      code: 'declare function foo<E extends Readonly<string[]>>(extra: E): E;',
+      output: 'declare function foo<E extends readonly string[]>(extra: E): E;',
+      options: [{ default: 'array-simple' }],
+      errors: [
+        {
+          messageId: 'errorStringArraySimpleReadonly',
+          data: {
+            className: 'Readonly',
+            readonlyPrefix: 'readonly ',
+            type: 'string[]',
+          },
+        },
+      ],
+    },
   ],
 });
 
