Improve prefer-collections-with-pagination rule

Author: utarwyn

README.md

@@ -53,9 +53,9 @@ Plugins are working nicely on their own! Follow instructions in the dedicated RE
 SonarQube plugins can be downloaded from _ecoCode_ repository.\
 Linters are available as dedicated NPM packages.
 
-| SonarQube plugin                     | Linter name                                       | Latest version                                                                                                                    |
-|:-------------------------------------|:--------------------------------------------------|:----------------------------------------------------------------------------------------------------------------------------------|
-| [JavaScript][ecoCode-latest-release] | [@ecocode/eslint-plugin](eslint-plugin/README.md) | [![eslint-plugin version](https://img.shields.io/npm/v/@ecocode/eslint-plugin)](https://npmjs.com/package/@ecocode/eslint-plugin) |
+| SonarQube plugin                                | Linter name                                       | Latest version                                                                                                                    |
+|:------------------------------------------------|:--------------------------------------------------|:----------------------------------------------------------------------------------------------------------------------------------|
+| [JavaScript/TypeScript][ecoCode-latest-release] | [@ecocode/eslint-plugin](eslint-plugin/README.md) | [![eslint-plugin version](https://img.shields.io/npm/v/@ecocode/eslint-plugin)](https://npmjs.com/package/@ecocode/eslint-plugin) |
 
 You can follow changelogs on [GitHub Releases page](https://github.com/green-code-initiative/ecoCode-linter/releases).
 

eslint-plugin/CHANGELOG.md

@@ -9,8 +9,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Added
 
+- Add support for TypeScript rules with **typescript-eslint**
 - Add rule `@ecocode/avoid-high-accuracy-geolocation`
 - Add rule `@ecocode/no-import-all-from-library`
+- Add rule `@ecocode/prefer-collections-with-pagination`
 
 ## [0.1.0] - 2023-03-24
 

eslint-plugin/README.md

@@ -1,7 +1,7 @@
 ![Logo](https://github.com/green-code-initiative/ecoCode/blob/main/docs/resources/logo-large.png?raw=true)
 ======================================
 
-An ESLint plugin which provides JavaScript rules of the ecoCode project.
+An ESLint plugin which provides JavaScript and TypeScript rules of the ecoCode project.
 
 👉 See [ecoCode-linter README](https://github.com/green-code-initiative/ecoCode-linter#readme) to have more information.
 
@@ -21,6 +21,9 @@ yarn add -D eslint @ecocode/eslint-plugin
 npm install -D eslint @ecocode/eslint-plugin
 ```
 
+> You are using TypeScript? You will also need to install [typescript-eslint](https://typescript-eslint.io/) to enable our rules.\
+> Follow [this official guide](https://typescript-eslint.io/getting-started) to install it in a few steps.
+
 ### Enable whole plugin
 
 Add `@ecocode` recommended configuration to `extends` section of your `.eslintrc`:

eslint-plugin/docs/rules/prefer-collections-with-pagination.md

@@ -7,34 +7,32 @@
 ## Rule details
 
 This rule aims to reduce the size and thus the network weight of API returns that may contain many elements. This rule
-is built for the NestJS framework but can work with a controller @Controller() and a decorated method @Get().
+is built for the [NestJS framework](https://nestjs.com) but can work with a controller @Controller() and a decorated method @Get().
 
 ## Examples
 
-Examples of **incorrect** code for this rule:
+Examples of **non-compliant** code for this rule:
 
 ```ts
 @Controller()
 class Test {
-    @Get()
-    public find(): Promise<string[]> {
-    }
+  @Get()
+  public find(): Promise<string[]> {}
 }
 ```
 
-Examples of **correct** code for this rule:
+Examples of **compliant** code for this rule:
 
 ```ts
 interface Pagination {
-    items: string[];
-    currentPage: number;
-    totalPages: number;
+  items: string[];
+  currentPage: number;
+  totalPages: number;
 }
 
 @Controller()
 class Test {
-    @Get()
-    public find(): Promise<Pagination> {
-    }
+  @Get()
+  public find(): Promise<Pagination> {}
 }
 ```

eslint-plugin/lib/index.js

@@ -24,35 +24,13 @@
 const fs = require("fs");
 const path = require("path");
 
-const resolveRule = (rulePath) => {
-  try {
-    return require(rulePath);
-  } catch (e) {
-    return null;
-  }
-};
-
-const hasTypescriptParser = () => {
-  try {
-    // eslint-disable-next-line node/no-unpublished-require
-    require("@typescript-eslint/parser");
-    return true;
-  } catch (e) {
-    return false;
-  }
-};
-
 const ruleModules = {};
+const configs = { recommended: { plugins: ["@ecocode"], rules: {} } };
 
-const configs = {
-  recommended: { plugins: ["@ecocode"], rules: {} },
-  ...(hasTypescriptParser() ? { parser: "@typescript-eslint/parser" } : {}),
-};
-
-const rulesDirectory = "./rules";
-fs.readdirSync(path.resolve(__dirname, rulesDirectory)).forEach((file) => {
+const rulesDirectory = path.resolve(__dirname, "rules");
+fs.readdirSync(rulesDirectory).forEach((file) => {
   const ruleName = path.parse(file).name;
-  const resolvedRule = resolveRule(`./${path.join(rulesDirectory, ruleName)}`);
+  const resolvedRule = require(path.join(rulesDirectory, ruleName));
 
   if (resolvedRule != null) {
     ruleModules[ruleName] = resolvedRule;

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

@@ -16,13 +16,7 @@
  */
 "use strict";
 
-const { ESLintUtils } = require("@typescript-eslint/utils");
-
-const createRule = ESLintUtils.RuleCreator(
-  (name) => `https://example.com/rule/${name}`
-);
-
-const PAGINATION_KEY_WORDS = ["page", "pagination"];
+const PAGINATION_KEY_WORDS = ["page", "pagination", "paginated"];
 
 const isPaginationName = (name) => {
   return PAGINATION_KEY_WORDS.some((keyWord) =>
@@ -51,15 +45,11 @@ const isPaginated = (objectType) => {
   return false;
 };
 
-const report = (context, node) => {
-  context.report({
-    node,
-    messageId: "PreferReturnCollectionsWithPagination",
-  });
-};
+const report = (context, node) =>
+  context.report({ node, messageId: "PreferReturnCollectionsWithPagination" });
 
 // Type: RuleModule<"uppercase", ...>
-const rule = createRule({
+module.exports = {
   name: "prefer-collections-with-pagination",
   meta: {
     docs: {
@@ -76,10 +66,18 @@ const rule = createRule({
   },
   defaultOptions: [],
   create(context) {
+    const isValidDecorator = (decorator) => {
+      return (
+        decorator.expression.callee.name.toLowerCase() === "get" &&
+        (decorator.expression.arguments.length === 0 ||
+          !decorator.expression.arguments[0].value.includes(":"))
+      );
+    };
+
     return {
       Decorator(node) {
         if (
-          node.expression.callee.name.toLowerCase() === "get" &&
+          isValidDecorator(node) &&
           node.parent.parent.parent.type === "ClassDeclaration" &&
           node.parent.parent.parent.decorators.find(
             (decorator) =>
@@ -101,19 +99,17 @@ const rule = createRule({
                 returnType.typeParameters.params.length === 1 &&
                 !isPaginated(returnType.typeParameters.params[0])
               ) {
-                report(context, node);
+                report(context, returnType);
               }
             } else if (
               returnType.type === "TSArrayType" ||
               !isPaginated(returnType)
             ) {
-              report(context, node);
+              report(context, returnType);
             }
           }
         }
       },
     };
   },
-});
-
-module.exports = rule;
+};

eslint-plugin/package.json

@@ -28,9 +28,8 @@
     "update:eslint-docs": "eslint-doc-generator"
   },
   "devDependencies": {
-    "@typescript-eslint/eslint-plugin": "^5.57.1",
-    "@typescript-eslint/parser": "^5.57.1",
-    "@typescript-eslint/utils": "^5.57.1",
+    "@typescript-eslint/eslint-plugin": "^5.59.6",
+    "@typescript-eslint/parser": "^5.59.6",
     "eslint": "^8.19.0",
     "eslint-config-prettier": "^8.6.0",
     "eslint-doc-generator": "^1.0.0",

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

@@ -1,13 +1,43 @@
-const { ESLintUtils } = require("@typescript-eslint/utils");
+/**
+ * Copyright (C) 2023 Green Code Initiative
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+"use strict";
+
+//------------------------------------------------------------------------------
+// Requirements
+//------------------------------------------------------------------------------
+
 const rule = require("../../../lib/rules/prefer-collections-with-pagination");
+const RuleTester = require("eslint").RuleTester;
+
+//------------------------------------------------------------------------------
+// Tests
+//------------------------------------------------------------------------------
 
-const ruleTester = new ESLintUtils.RuleTester({
-  parser: "@typescript-eslint/parser",
+const ruleTester = new RuleTester({
+  parser: require.resolve("@typescript-eslint/parser"),
 });
 
-const expectedError = {
+const expectedArrayError = {
   messageId: "PreferReturnCollectionsWithPagination",
-  type: "Decorator",
+  type: "TSArrayType",
+};
+const expectedReferenceError = {
+  messageId: "PreferReturnCollectionsWithPagination",
+  type: "TSTypeReference",
 };
 
 ruleTester.run("prefer-collections-with-pagination", rule, {
@@ -28,6 +58,20 @@ ruleTester.run("prefer-collections-with-pagination", rule, {
     `,
     `
     @Controller()
+    public class Test {
+        @Get()
+        public find() {}
+    }
+    `,
+    `
+    @Controller()
+    public class Test {
+        @Get(':id')
+        public findOne(): Promise<string> {}
+    }
+    `,
+    `
+    @Controller()
     public class Test {
         @Get()
         public find(): Promise<{items: string[], currentPage: number, totalPages: number}> {}
@@ -43,7 +87,17 @@ ruleTester.run("prefer-collections-with-pagination", rule, {
         public find(): Promise<string[]> {}
     }
     `,
-      errors: [expectedError],
+      errors: [expectedReferenceError],
+    },
+    {
+      code: `
+    @Controller()
+    public class Test {
+        @Get()
+        public find(): Promise<ClassicList> {}
+    }
+    `,
+      errors: [expectedReferenceError],
     },
     {
       code: `
@@ -53,7 +107,7 @@ ruleTester.run("prefer-collections-with-pagination", rule, {
         public find(): string[] {}
     }
     `,
-      errors: [expectedError],
+      errors: [expectedArrayError],
     },
     {
       code: `
@@ -63,7 +117,7 @@ ruleTester.run("prefer-collections-with-pagination", rule, {
         public find(): Promise<{items: string[]}> {}
     }
     `,
-      errors: [expectedError],
+      errors: [expectedReferenceError],
     },
   ],
 });