fix(collection-of): add Enum decorator support when it's a prop array

tsedio · Apr 3, 2024 · 4a55387 · 4a55387
1 parent 8755af6
commit 4a55387
Show file tree

Hide file tree

Showing 3 changed files with 78 additions and 8 deletions.
diff --git a/src/rules/explicit-collection-of-decorator/explicitCollectionOfDecorator.spec.ts b/src/rules/explicit-collection-of-decorator/explicitCollectionOfDecorator.spec.ts
@@ -53,7 +53,21 @@ describe("explicitCollectionOfDecorator", () => {
           @Property()
           thisIsABooleanProp = false
         }`,
-      }
+      },
+      {
+        code: `
+        import {Default, Enum} from "@tsed/schema";
+        
+        enum GrantTypes {
+          AUTHORIZATION_CODE = "authorization_code"
+        }
+        
+        class TestClass {
+          @Default(GrantTypes.AUTHORIZATION_CODE)
+          @Enum(GrantTypes)
+          grantTypes: GrantTypes[] = [GrantTypes.AUTHORIZATION_CODE]
+        }`
+      },
     ],
     invalid: [
       {
@@ -297,6 +311,61 @@ describe("explicitCollectionOfDecorator", () => {
             thisIsAStringProp?: string[];
           }`
       },
+      {
+        code: `
+          import {Default} from "@tsed/schema";
+          class Nested {}
+          class TestClass {
+            @Default([])
+            thisIsAStringProp?: Nested[] = [];
+          }`,
+        errors: [
+          {
+            messageId: "missing-collection-of-decorator",
+          },
+        ],
+        output: `
+          import {Default, ArrayOf} from "@tsed/schema";
+          class Nested {}
+          class TestClass {
+            @ArrayOf(Nested)
+            @Default([])
+            thisIsAStringProp?: Nested[] = [];
+          }`
+      },
+      {
+        code: `
+        import {Default, Enum, ArrayOf} from "@tsed/schema";
+        
+        enum GrantTypes {
+          AUTHORIZATION_CODE = "authorization_code"
+        }
+        
+        class TestClass {
+          @Default(GrantTypes.AUTHORIZATION_CODE)
+          @Enum(GrantTypes)
+          @ArrayOf(GrantTypes)
+          grantTypes: GrantTypes[] = [GrantTypes.AUTHORIZATION_CODE]
+        }`,
+        errors: [
+          {
+            messageId: "unnecessary-array-of-decorator",
+          },
+        ],
+        output: `
+        import {Default, Enum, ArrayOf} from "@tsed/schema";
+        
+        enum GrantTypes {
+          AUTHORIZATION_CODE = "authorization_code"
+        }
+        
+        class TestClass {
+          @Default(GrantTypes.AUTHORIZATION_CODE)
+          @Enum(GrantTypes)
+          
+          grantTypes: GrantTypes[] = [GrantTypes.AUTHORIZATION_CODE]
+        }`,
+      },
     ],
   });
 });
diff --git a/src/rules/explicit-collection-of-decorator/explicitCollectionOfDecorator.ts b/src/rules/explicit-collection-of-decorator/explicitCollectionOfDecorator.ts
@@ -15,8 +15,8 @@ type RULES =
   | "unnecessary-collection-of-decorator"
   | "unexpected-map-of-decorator";
 
-type DECORATORS_TYPES = "Property" | "CollectionOf" | "MapOf" | "ArrayOf";
-const DECORATORS: DECORATORS_TYPES[] = ["Property", "CollectionOf", "MapOf", "ArrayOf"];
+type DECORATORS_TYPES = "Property" | "CollectionOf" | "MapOf" | "ArrayOf" | "Enum";
+const DECORATORS: DECORATORS_TYPES[] = ["Property", "CollectionOf", "MapOf", "ArrayOf", "Enum"];
 
 const TYPES_TO_DECORATORS: Record<string, DECORATORS_TYPES> = {
   Array: "ArrayOf",
@@ -50,8 +50,8 @@ const RULES_CHECK: RuleOptions<RULES, CollectionOfDecoratorsStatus>[] = [
     messageId: "missing-collection-of-decorator",
     message: "Property returning Array, Set or Map must set CollectionOf decorator",
     test: ({decorators, isCollection}) =>
-      isCollection && !(decorators.has("CollectionOf") || decorators.has("MapOf") || decorators.has("ArrayOf")),
-    * fix({fixer, node}) {
+      isCollection && !(decorators.has("CollectionOf") || decorators.has("MapOf") || decorators.has("ArrayOf") || decorators.has("Enum")),
+    * fix({fixer, node, decoratorsStatus}) {
       const {itemType, collectionType} = getTypes(node);
       const decoratorName = TYPES_TO_DECORATORS[collectionType as string];
 
@@ -75,8 +75,8 @@ const RULES_CHECK: RuleOptions<RULES, CollectionOfDecoratorsStatus>[] = [
     messageId: "unnecessary-array-of-decorator",
     message: "Unnecessary ArrayOf decorator over a Property not returning Array",
     test: ({decorators, isCollection}) =>
-      !isCollection
-      && decorators.has("ArrayOf"),
+      decorators.has("ArrayOf") &&
+      (!isCollection || (isCollection && decorators.has("Enum"))),
     fix({fixer, node}) {
       const collectionOfDecorator = findPropertyDecorator(node, "ArrayOf");
 

diff --git a/src/utils/getTypes.ts b/src/utils/getTypes.ts
@@ -8,7 +8,8 @@ export function getTypes(
 ) {
 
   const collectionType = (node.typeAnnotation as any)?.typeAnnotation?.typeName?.name;
-  const itemType = extractType((node.typeAnnotation?.typeAnnotation as any )?.elementType?.type) ;
+  const elementType = (node.typeAnnotation?.typeAnnotation as any )?.elementType
+  const itemType = elementType?.typeName?.name || extractType(elementType?.type) ;
 
   if (!itemType) {
     if (["Map", "Set"].includes(collectionType)) {