How to Debug Node.js in VS Code

In this tutorial, you'll learn about How to Debug Node.js in VS Code. We cover key concepts, practical examples, and best practices.

The Problem

You're using console.log() everywhere to debug your Node.js app. VS Code has a built-in debugger that's much more powerful.

Quick Fix

1. Open the Run and Debug panel

Press Ctrl+Shift+D (or click the play icon in the left sidebar).

2. Start debugging

Click Run and Debug then select Node.js.

VS Code starts your app with the debugger attached.

3. Set breakpoints

Click in the gutter (left of line numbers) where you want to pause execution. A red dot appears.

4. Use the debug toolbar

When execution hits a breakpoint:

5. Inspect variables

In the VARIABLES section, you can see local, closure, and global variables. Hover over variables in your code to see their current value.

Launch Configuration

Create .vscode/launch.json:

{
  "version": "0.2.0",
  "configurations": [
    {
      "type": "node",
      "request": "launch",
      "name": "Launch Program",
      "skipFiles": ["<node_internals>/**"],
      "program": "${workspaceFolder}/app.js"
    }
  ]
}

Debugging npm Scripts

Add this to launch.json:

{
  "type": "node",
  "request": "launch",
  "name": "npm start",
  "runtimeExecutable": "npm",
  "runtimeArgs": ["run", "start"],
  "skipFiles": ["<node_internals>/**"]
}