VSCode에서 NestJS 디버깅을 위한 launch.json 설정

 

VSCode에서 NestJS 디버깅을 위한 launch.json 설정법

NestJS 프로젝트를 위한 VSCode 디버깅 설정 (launch.json)

다음은 NestJS 프로젝트를 Visual Studio Code(VSCode)에서 효과적으로 디버깅하기 위한 launch.json 파일의 예제 설정입니다. PNPM 패키지 매니저를 사용하는 환경에서도 사용할 수 있습니다.

launch.json 코드 예제

{
  "version": "0.2.0",
  "configurations": [
    {
      "type": "node",
      "request": "launch",
      "name": "Debug Nest Framework",
      "runtimeExecutable": "pnpm",
      "runtimeArgs": [
        "run",
        "start:debug",
        "--",
        "--inspect-brk"
      ],
      "autoAttachChildProcesses": true,
      "restart": true,
      "sourceMaps": true,
      "stopOnEntry": false,
      "console": "integratedTerminal"
    }
  ]
}
        

주요 옵션 설명

• type: Node.js 애플리케이션을 디버그하기 위해 사용하는 설정입니다.
• request: 디버거가 실행될 때 애플리케이션을 시작하는 옵션입니다.
• name: 디버깅 구성의 이름을 의미합니다.
• runtimeExecutable: Node.js 명령어 대신 실행할 명령어 (여기서는 pnpm)를 지정합니다.
• runtimeArgs: 런타임 명령어 뒤에 오는 인자들입니다.
• autoAttachChildProcesses: 자식 프로세스를 자동으로 디버거에 연결합니다.
• sourceMaps: 소스맵을 활성화하여 Typescript와 같은 언어 디버깅을 돕습니다.
• restart: 파일 변경 감지 시 자동으로 디버거를 재시작합니다.
• console: VSCode 통합 터미널을 통해 디버깅 로그를 출력합니다.

사용 환경

본 설정은 NestJS 기반의 백엔드 개발 환경에서 특히 유용하며, 빠르게 오류를 발견하고 해결할 수 있도록 도와줍니다. TypeScript와의 원활한 디버깅을 위해 sourceMaps 옵션을 활성화해 두었습니다.

 

 

출처 : 코드팩토리의 백엔드 아카데미 : 한 번에 끝내는 NestJS 패키지 - 기초부터 MSA까지