feat(eslint): override controller files for eslint rules (#34)

.eslintrc.js

@@ -1,6 +1,7 @@
 const { importRules } = require("./config/eslint/rules/import");
 const { configFilesOverride } = require("./config/eslint/rules/overrides/config-files");
 const { constantFilesOverride } = require("./config/eslint/rules/overrides/constant-files");
+const { controllerFilesOverride } = require("./config/eslint/rules/overrides/controller-files");
 const { decoratorFilesOverride } = require("./config/eslint/rules/overrides/decorator-files");
 const { dtoFilesOverride } = require("./config/eslint/rules/overrides/dto-files");
 const { eslintConfigFilesOverride } = require("./config/eslint/rules/overrides/eslint-config-files");
@@ -42,5 +43,6 @@ module.exports = {
     schemaFilesOverride,
     constantFilesOverride,
     pipeFilesOverride,
+    controllerFilesOverride,
   ],
 };

config/eslint/rules/overrides/controller-files.js

@@ -0,0 +1,11 @@
+const { OFF } = require("../../constants");
+
+const controllerFilesOverride = Object.freeze({
+  files: ["*.controller.ts"],
+  rules: {
+    "class-methods-use-this": OFF,
+    "@typescript-eslint/no-empty-function": OFF,
+  },
+});
+
+module.exports = { controllerFilesOverride };

src/app.controller.ts

@@ -4,10 +4,8 @@ import { ApiNoContentResponse, ApiTags } from "@nestjs/swagger";
 @ApiTags("🐺 Root")
 @Controller()
 export class AppController {
-  // eslint-disable-next-line class-methods-use-this
   @Get("/")
   @HttpCode(HttpStatus.NO_CONTENT)
   @ApiNoContentResponse()
-  // eslint-disable-next-line @typescript-eslint/no-empty-function
   public root(): void {}
 }

src/modules/health/health.controller.ts

@@ -2,9 +2,10 @@ import { Controller, Get } from "@nestjs/common";
 import { ApiTags } from "@nestjs/swagger";
 import type { HealthCheckResult, HealthIndicatorResult } from "@nestjs/terminus";
 import { HealthCheck, HealthCheckService, MongooseHealthIndicator } from "@nestjs/terminus";
+import { API_RESOURCES } from "../../shared/api/enums/api.enum";
 
 @ApiTags("❤️ Health")
-@Controller("health")
+@Controller(API_RESOURCES.HEALTH)
 export class HealthController {
   public constructor(
     private readonly health: HealthCheckService,

src/modules/role/role.controller.ts

@@ -1,15 +1,15 @@
 import { Controller, Get, HttpStatus } from "@nestjs/common";
 import { ApiResponse, ApiTags } from "@nestjs/swagger";
+import { API_RESOURCES } from "../../shared/api/enums/api.enum";
+import { roles } from "./constants/role.constant";
 import { Role } from "./role.entity";
-import { RoleService } from "./role.service";
 
 @ApiTags("🃏 Roles")
-@Controller("roles")
+@Controller(API_RESOURCES.ROLES)
 export class RoleController {
-  public constructor(private readonly roleService: RoleService) {}
   @Get()
   @ApiResponse({ status: HttpStatus.OK, type: Role, isArray: true })
   public getRoles(): readonly Role[] {
-    return this.roleService.getRoles();
+    return roles;
   }
 }

src/modules/role/role.module.ts

@@ -1,9 +1,5 @@
 import { Module } from "@nestjs/common";
 import { RoleController } from "./role.controller";
-import { RoleService } from "./role.service";
 
-@Module({
-  controllers: [RoleController],
-  providers: [RoleService],
-})
+@Module({ controllers: [RoleController] })
 export class RoleModule {}

src/shared/api/enums/api.enum.ts

@@ -1,5 +1,7 @@
 enum API_RESOURCES {
   GAMES = "games",
+  ROLES = "roles",
+  HEALTH = "health",
 }
 
 export { API_RESOURCES };

src/shared/api/helpers/api.helper.ts

@@ -1,7 +1,11 @@
 import { API_RESOURCES } from "../enums/api.enum";
 
 function getResourceSingularForm(resource: API_RESOURCES): string {
-  const resourceSingularForms: Record<API_RESOURCES, string> = { [API_RESOURCES.GAMES]: "game" };
+  const resourceSingularForms: Record<API_RESOURCES, string> = {
+    [API_RESOURCES.GAMES]: "game",
+    [API_RESOURCES.ROLES]: "role",
+    [API_RESOURCES.HEALTH]: "health",
+  };
   return resourceSingularForms[resource];
 }
 

tests/unit/specs/shared/api/helpers/api.helper.spec.ts

@@ -3,7 +3,11 @@ import { getResourceSingularForm } from "../../../../../../src/shared/api/helper
 
 describe("API Helper", () => {
   describe("getResourceSingularForm", () => {
-    it.each<{ resource: API_RESOURCES; singular: string }>([{ resource: API_RESOURCES.GAMES, singular: "game" }])("should return $singular when called with $resource [#$#].", ({ resource, singular }) => {
+    it.each<{ resource: API_RESOURCES; singular: string }>([
+      { resource: API_RESOURCES.GAMES, singular: "game" },
+      { resource: API_RESOURCES.ROLES, singular: "role" },
+      { resource: API_RESOURCES.HEALTH, singular: "health" },
+    ])("should return $singular when called with $resource [#$#].", ({ resource, singular }) => {
       expect(getResourceSingularForm(resource)).toBe(singular);
     });
   });