feature/prefer-collections-with-pagination

- Fix tests

Author: poulainpi

eslint-plugin/lib/rules/prefer-collections-with-pagination.js

@@ -37,11 +37,11 @@ const isPaginated = (objectType) => {
     if (isPaginationName(objectType.typeName.name)) {
       return true;
     }
-
+  } else if (objectType.type === "TSTypeLiteral") {
     if (
       objectType.members != null &&
       objectType.members.some(
-        (member) => member.key != null && isPaginationName(member.key)
+        (member) => member.key != null && isPaginationName(member.key.name)
       )
     ) {
       return true;
@@ -93,15 +93,21 @@ const rule = createRule({
               : null;
 
           if (returnType != null) {
-            if (returnType.typeName.name === "Promise") {
+            if (
+              returnType.type === "TSTypeReference" &&
+              returnType.typeName.name === "Promise"
+            ) {
               if (
                 returnType.typeParameters.params.length === 1 &&
                 !isPaginated(returnType.typeParameters.params[0])
               ) {
-                report(context, returnType);
-              } else if (!isPaginated(returnType)) {
-                report(context, returnType);
+                report(context, node);
               }
+            } else if (
+              returnType.type === "TSArrayType" ||
+              !isPaginated(returnType)
+            ) {
+              report(context, node);
             }
           }
         }

eslint-plugin/tests/lib/rules/prefer-collections-with-pagination.js

@@ -5,51 +5,65 @@ const ruleTester = new ESLintUtils.RuleTester({
   parser: "@typescript-eslint/parser",
 });
 
+const expectedError = {
+  messageId: "PreferReturnCollectionsWithPagination",
+  type: "Decorator",
+};
+
 ruleTester.run("prefer-collections-with-pagination", rule, {
   valid: [
-    // `
-    // @Controller()
-    // public class Test {
-    //     @Get()
-    //     public find(): Page {}
-    // }
-    // `,
+    `
+    @Controller()
+    public class Test {
+        @Get()
+        public find(): Page {}
+    }
+    `,
     `
     @Controller()
     public class Test {
         @Get()
         public find(): Promise<Pagination> {}
     }
     `,
-    // `
-    // @Controller()
-    // public class Test {
-    //     @Get()
-    //     public find(): Promise<{items: string[], currentPage: number, totalPages: number}> {}
-    // }
-    // `,
+    `
+    @Controller()
+    public class Test {
+        @Get()
+        public find(): Promise<{items: string[], currentPage: number, totalPages: number}> {}
+    }
+    `,
   ],
   invalid: [
-    // `
-    // @Controller()
-    // public class Test {
-    //     @Get()
-    //     public find(): Promise<string[]> {}
-    // }
-    // `,
-    // `
-    // @Controller()
-    // public class Test {
-    //     @Get()
-    //     public find(): string[] {}
-    // }
-    // `,
-    // `
-    // @Controller()
-    // public class Test {
-    //     @Get()
-    //     public find(): Promise<{items: string[]}> {}
-    // }
-    // `,
+    {
+      code: `
+    @Controller()
+    public class Test {
+        @Get()
+        public find(): Promise<string[]> {}
+    }
+    `,
+      errors: [expectedError],
+    },
+    {
+      code: `
+    @Controller()
+    public class Test {
+        @Get()
+        public find(): string[] {}
+    }
+    `,
+      errors: [expectedError],
+    },
+    {
+      code: `
+    @Controller()
+    public class Test {
+        @Get()
+        public find(): Promise<{items: string[]}> {}
+    }
+    `,
+      errors: [expectedError],
+    },
   ],
 });