* add directory (directory 추가)

 * setting path alias (path alias 설정)
 * add health api (health api 추가)

jest.config.ts

@@ -0,0 +1,60 @@
+/**
+ * For a detailed explanation regarding each configuration property, visit:
+ * https://jestjs.io/docs/configuration
+ */
+import type { Config } from 'jest';
+import { pathsToModuleNameMapper } from 'ts-jest';
+import { compilerOptions } from './tsconfig.json';
+
+
+const config: Config = {
+  // An array of file extensions your modules use
+  moduleFileExtensions: [
+    "js",
+    "ts",
+    "json",
+  ],
+
+  // modulePaths: [compilerOptions.baseUrl],
+
+  // @see https://kulshekhar.github.io/ts-jest/docs/getting-started/paths-mapping/
+  // A map from regular expressions to module names or to arrays of module names that allow to stub out resources with a single module
+  moduleNameMapper: pathsToModuleNameMapper(compilerOptions.paths , { prefix: '<rootDir>/' } ),
+
+  // The root directory that Jest should scan for tests and modules within
+  rootDir: "src",
+
+
+  // A list of paths to modules that run some code to configure or set up the testing framework before each test
+  setupFilesAfterEnv: [],
+
+
+  // The test environment that will be used for testing
+  "testEnvironment": "node",
+
+  // The glob patterns Jest uses to detect test files
+  testMatch: [
+    "**/__tests__/**/*.[jt]s?(x)",
+    "**/?(*.)+(spec|test).[tj]s?(x)"
+  ],
+
+  // An array of regexp pattern strings that are matched against all test paths, matched tests are skipped
+  testPathIgnorePatterns: [
+    "/node_modules/", "example/", "dist/"
+  ],
+
+  // The regexp pattern or array of patterns that Jest uses to detect test files
+  "testRegex": ".*\\.spec\\.ts$",
+
+  // A map from regular expressions to paths to transformers
+  transform: {
+    "^.+\\.(t|j)s$": "ts-jest"
+  },
+
+  // Indicates whether each individual test should be reported during the run
+  verbose: false,
+
+  silent: false,
+};
+
+export default config;

package.json

@@ -13,7 +13,7 @@
     "start:debug": "nest start --debug --watch",
     "start:prod": "node dist/main",
     "lint": "eslint \"{src,apps,libs,test}/**/*.ts\" --fix",
-    "test": "jest",
+    "test": "jest --config ./jest.config.js",
     "test:watch": "jest --watch",
     "test:cov": "jest --coverage",
     "test:debug": "node --inspect-brk -r tsconfig-paths/register -r ts-node/register node_modules/.bin/jest --runInBand",
@@ -51,22 +51,5 @@
     "ts-node": "^10.9.2",
     "tsconfig-paths": "^4.2.0",
     "typescript": "^5.3.3"
-  },
-  "jest": {
-    "moduleFileExtensions": [
-      "js",
-      "json",
-      "ts"
-    ],
-    "rootDir": "src",
-    "testRegex": ".*\\.spec\\.ts$",
-    "transform": {
-      "^.+\\.(t|j)s$": "ts-jest"
-    },
-    "collectCoverageFrom": [
-      "**/*.(t|j)s"
-    ],
-    "coverageDirectory": "../coverage",
-    "testEnvironment": "node"
   }
 }

src/app.module.ts

@@ -1,10 +1,8 @@
+import { ControllerModule } from '#controllers/controller.module';
+import { ProviderModule } from '#providers/provider.module';
 import { Module } from '@nestjs/common';
-import { AppController } from './app.controller';
-import { AppService } from './app.service';
 
 @Module({
-  imports: [],
-  controllers: [AppController],
-  providers: [AppService],
+  imports: [ControllerModule, ProviderModule],
 })
 export class AppModule {}

src/controllers/controller.module.ts

@@ -0,0 +1,7 @@
+import { HealthControllerModule } from '#controllers/healths/health.controller.module';
+import { Module } from '@nestjs/common';
+
+@Module({
+  imports: [HealthControllerModule],
+})
+export class ControllerModule {}

src/controllers/healths/health.controller.module.ts

@@ -0,0 +1,10 @@
+import { HealthController } from '#controllers/healths/health.controller';
+import { HealthService } from '#providers/healths/health.service';
+import { Module } from '@nestjs/common';
+
+@Module({
+  imports: [],
+  controllers: [HealthController],
+  providers: [HealthService],
+})
+export class HealthControllerModule {}

src/controllers/healths/health.controller.spec.ts

@@ -0,0 +1,24 @@
+import { HealthController } from '#controllers/healths/health.controller';
+import { ResHealthDto } from '#dtos/healths/ResHealthDto';
+import { Test, TestingModule } from '@nestjs/testing';
+
+
+
+describe('HealthController', () => {
+  let controller: HealthController;
+  const now = new Date();
+
+  beforeEach(async () => {
+    const module: TestingModule = await Test.createTestingModule({
+      controllers: [HealthController],
+    }).compile();
+
+    jest.setSystemTime(now);
+
+    controller = module.get<HealthController>(HealthController);
+  });
+
+  it('should be "ResHealthDto"', () => {
+    expect(controller.getHealth()).toBe(new ResHealthDto({runMode: 'local', 'timestamp': now.toISOString()}));
+  });
+});

src/controllers/healths/health.controller.ts

@@ -0,0 +1,13 @@
+import { ResHealthDto } from '#dtos/healths/ResHealthDto';
+import { HealthService } from '#providers/healths/health.service';
+import { Controller, Get } from '@nestjs/common';
+
+@Controller(['/', 'healths'])
+export class HealthController {
+  constructor(private readonly healthService: HealthService) {}
+
+  @Get('/')
+  getHealth(): ResHealthDto {
+    return this.healthService.read();
+  }
+}

src/dtos/healths/ResHealthDto.ts

@@ -0,0 +1,15 @@
+import { IResHealthDto } from '#dtos/healths/interfaces/IResHealthDto';
+import { IsISO8601, IsString } from 'class-validator';
+
+export class ResHealthDto implements IResHealthDto {
+  @IsString()
+  runMode: string;
+
+  @IsISO8601()
+  timestamp: string;
+
+  constructor(args: IResHealthDto) {
+    this.runMode = args.runMode;
+    this.timestamp = new Date(args.timestamp).toISOString();
+  }
+}

src/dtos/healths/interfaces/IResHealthDto.ts

@@ -0,0 +1,4 @@
+export interface IResHealthDto {
+  runMode: string;
+  timestamp: string;
+}

src/main.ts

@@ -1,7 +1,7 @@
+import { AppModule } from '#app.module';
 import { ValidationPipe } from '@nestjs/common';
 import { NestFactory } from '@nestjs/core';
 import { FastifyAdapter, NestFastifyApplication } from '@nestjs/platform-fastify';
-import { AppModule } from './app.module';
 
 /**
  * 포트 번호를 가져오는 함수

src/providers/healths/health.service.module.ts

@@ -0,0 +1,7 @@
+import { HealthService } from '#providers/healths/health.service';
+import { Module } from '@nestjs/common';
+
+@Module({
+  providers: [HealthService],
+})
+export class HealthServiceModule {}

src/providers/healths/health.service.spec.ts

@@ -0,0 +1,25 @@
+import { IResHealthDto } from '#dtos/healths/interfaces/IResHealthDto';
+import { Test, TestingModule } from '@nestjs/testing';
+import { HealthService } from './health.service';
+
+describe('HealthService', () => {
+  let service: HealthService;
+  const now = new Date();
+
+  beforeEach(async () => {
+    const module: TestingModule = await Test.createTestingModule({
+      providers: [HealthService],
+    }).compile();
+
+    jest.setSystemTime(now);
+
+    service = module.get<HealthService>(HealthService);
+  });
+
+  it('should be "IResHealthDto"', () => {
+    expect(service.read()).toBe({
+      runMode: 'local',
+      timestamp: now.toISOString(),
+    } satisfies IResHealthDto);
+  });
+});

src/providers/healths/health.service.ts

@@ -0,0 +1,12 @@
+import { IResHealthDto } from '#dtos/healths/interfaces/IResHealthDto';
+import { Injectable } from '@nestjs/common';
+
+@Injectable()
+export class HealthService {
+  read() {
+    return {
+      runMode: 'local',
+      timestamp: new Date().toISOString(),
+    } satisfies IResHealthDto;
+  }
+}

src/providers/provider.module.ts

@@ -0,0 +1,7 @@
+import { Module } from '@nestjs/common';
+import { HealthServiceModule } from './healths/health.service.module';
+
+@Module({
+  imports: [HealthServiceModule],
+})
+export class ProviderModule {}

tsconfig.json

@@ -17,7 +17,7 @@
   "compilerOptions": {
     // "module": "commonjs",
     // 사용할 라이브러리 추가
-    "lib": ["dom.iterable"],
+    "lib": ["ES2022"],
     // 선언 파일 생성
     "declaration": true,
     // 주석 제거
@@ -59,8 +59,16 @@
     "noImplicitReturns": true,
     // JSON 모듈 해석 활성화
     "resolveJsonModule": true,
-    // 경로 별칭 설정
-    "paths": {},
+    // path alias 설정
+    // #을 prefix 로 설정한 이유는 아래 내용을 참조하였습니다
+    // NOTE: https://github.com/nodejs/node/issues/49182
+    "paths": {
+      "#app.module": ["src/app.module"],
+      //
+      "#controllers/*": ["src/controllers/*"],
+      "#dtos/*": ["src/dtos/*"],
+      "#providers/*": ["src/providers/*"],
+    },
   },
   // 포함할 파일 경로 설정
   "include": ["src/**/*"],