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

JavaScript linter of creedengo project

/*
 * creedengo JavaScript plugin - Provides rules to reduce the environmental footprint of your JavaScript programs
 * Copyright © 2023 Green Code Initiative (https://green-code-initiative.org)
 *
 * 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";

const PAGINATION_KEY_WORDS = ["page", "pagination", "paginated"];

const isPaginationName = (name) => {
  return PAGINATION_KEY_WORDS.some((keyWord) =>
    name.toLowerCase().includes(keyWord),
  );
};

const isPaginated = (objectType) => {
  if (objectType.type === "TSTypeReference") {
    // Pagination object should be an object, for example, it can't be an array

    if (isPaginationName(objectType.typeName.name)) {
      return true;
    }
  } else if (objectType.type === "TSTypeLiteral") {
    if (
      objectType.members?.some(
        (member) => member.key != null && isPaginationName(member.key.name),
      )
    ) {
      return true;
    }
  }

  return false;
};

const isNestGetDecorator = (decorator) =>
  decorator.expression.callee.name.toLowerCase() === "get" &&
  (decorator.expression.arguments.length === 0 ||
    !decorator.expression.arguments[0].value.includes(":"));

const isInNestControllerClass = (decorator) =>
  decorator.parent.parent.parent.type === "ClassDeclaration" &&
  decorator.parent.parent.parent.decorators.find(
    (decorator) =>
      decorator.expression.callee.name.toLowerCase() === "controller",
  );

const report = (context, node) =>
  context.report({ node, messageId: "PreferReturnCollectionsWithPagination" });

// Type: RuleModule<"uppercase", ...>
module.exports = {
  name: "prefer-collections-with-pagination",
  meta: {
    docs: {
      description: "Prefer API collections with pagination",
      category: "eco-design",
      recommended: "warn",
    },
    messages: {
      PreferReturnCollectionsWithPagination:
        "Prefer return collections with pagination in HTTP GET",
    },
    type: "suggestion",
    schema: [],
  },
  defaultOptions: [],
  create(context) {
    return {
      Decorator(node) {
        if (isNestGetDecorator(node) && isInNestControllerClass(node)) {
          const getMethod = node.parent;
          const returnType = getMethod.value.returnType?.typeAnnotation;

          if (returnType != null) {
            if (
              returnType.type === "TSTypeReference" &&
              returnType.typeName.name === "Promise"
            ) {
              if (
                returnType.typeParameters.params.length === 1 &&
                !isPaginated(returnType.typeParameters.params[0])
              ) {
                report(context, returnType);
              }
            } else if (
              returnType.type === "TSArrayType" ||
              !isPaginated(returnType)
            ) {
              report(context, returnType);
            }
          }
        }
      },
    };
  },
};