README.md

A Crude Debug Mode For a Dockerized NestJS App

Caution

Why I say crude? Because you need to write debugger and cannot use breakpoints :/.

1. Create a Dockerfile as we did here.

   nestjs-materials/docker/vscode-dev-mode/Dockerfile

   Lines 1 to 19 in 5155bff

   	FROM node:20.10.0-slim AS development
   	ENV PNPM_HOME="/pnpm"
   	ENV PATH="$PNPM_HOME:$PATH"
   	RUN corepack enable
   	ARG NODE_ENV=development
   	ENV NODE_ENV=${NODE_ENV}
   	WORKDIR /usr/src/app
   	COPY pnpm-lock.yaml .
   	RUN pnpm fetch
   	# COPY package*.json .
   	EXPOSE 3000 9229
   	COPY . .
   	RUN pnpm install -r --offline

2. Create and expose 9229 port in your compose file, see here.

   nestjs-materials/docker/vscode-dev-mode/compose.yml

   Lines 1 to 12 in 5155bff

   	services:
   	api:
   	build:
   	context: .
   	target: development
   	ports:
   	- 3000:3000
   	- 9229:9229
   	volumes:
   	- .:/usr/src/app
   	- /usr/src/app/node_modules
   	command: npm run start:debug

3. Create launch.json.

   nestjs-materials/.vscode/launch.json

   Lines 1 to 18 in 5155bff

   	{
   	"version": "0.2.0",
   	"configurations": [
   	{
   	"type": "node",
   	"request": "attach",
   	"name": "Debug",
   	"remoteRoot": "/usr/src/app",
   	"localRoot": "${workspaceFolder}",
   	"protocol": "inspector",
   	"port": 9229,
   	"restart": true,
   	"address": "0.0.0.0",
   	"skipFiles": ["<node_internals>/**"],
   	"sourceMaps": true
   	}
   	]
   	}