feat(eslint-plugin): array-type distinguish whether readonly or not (…

…#4066) * feat(eslint-plugin): distinguish whether readonly or not Signed-off-by: koooge <koooooge@gmail.com> * refactor: template messages Signed-off-by: koooge <koooooge@gmail.com>
typescript-eslint · Nov 23, 2021 · 314af44 · 314af44
1 parent 3c89e42
commit 314af44
Show file tree

Hide file tree

Showing 2 changed files with 209 additions and 99 deletions.
diff --git a/packages/eslint-plugin/src/rules/array-type.ts b/packages/eslint-plugin/src/rules/array-type.ts
@@ -80,9 +80,9 @@ type Options = [
 ];
 type MessageIds =
   | 'errorStringGeneric'
-  | 'errorStringGenericSimple'
   | 'errorStringArray'
-  | 'errorStringArraySimple';
+  | 'errorStringArraySimple'
+  | 'errorStringGenericSimple';
 
 const arrayOption = { enum: ['array', 'generic', 'array-simple'] };
 
@@ -98,13 +98,13 @@ export default util.createRule<Options, MessageIds>({
     fixable: 'code',
     messages: {
       errorStringGeneric:
-        "Array type using '{{type}}[]' is forbidden. Use 'Array<{{type}}>' instead.",
-      errorStringGenericSimple:
-        "Array type using '{{type}}[]' is forbidden for non-simple types. Use 'Array<{{type}}>' instead.",
+        "Array type using '{{readonlyPrefix}}{{type}}[]' is forbidden. Use '{{className}}<{{type}}>' instead.",
       errorStringArray:
-        "Array type using 'Array<{{type}}>' is forbidden. Use '{{type}}[]' instead.",
+        "Array type using '{{className}}<{{type}}>' is forbidden. Use '{{readonlyPrefix}}{{type}}[]' instead.",
       errorStringArraySimple:
-        "Array type using 'Array<{{type}}>' is forbidden for simple types. Use '{{type}}[]' instead.",
+        "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.",
     },
     schema: [
       {
@@ -163,6 +163,8 @@ export default util.createRule<Options, MessageIds>({
           node: errorNode,
           messageId,
           data: {
+            className: isReadonly ? 'ReadonlyArray' : 'Array',
+            readonlyPrefix: isReadonly ? 'readonly ' : '',
             type: getMessageType(node.elementType),
           },
           fix(fixer) {
@@ -216,6 +218,8 @@ export default util.createRule<Options, MessageIds>({
             node,
             messageId,
             data: {
+              className: isReadonlyArrayType ? 'ReadonlyArray' : 'Array',
+              readonlyPrefix,
               type: 'any',
             },
             fix(fixer) {
@@ -250,6 +254,8 @@ export default util.createRule<Options, MessageIds>({
           node,
           messageId,
           data: {
+            className: isReadonlyArrayType ? 'ReadonlyArray' : 'Array',
+            readonlyPrefix,
             type: getMessageType(type),
           },
           fix(fixer) {