Debugging with VS Code in Node.js

Introduction

Debugging helps you find and fix mistakes in your code. VS Code makes this easy by letting you pause and check your program step-by-step.

When your Node.js program crashes or shows errors.

When you want to understand how your code runs line by line.

When you need to check the values of variables during execution.

When you want to test different parts of your code without guessing.

When you want to improve your code by finding hidden bugs.

Syntax

Node.js

1. Open your Node.js project in VS Code.
2. Go to the Run and Debug view (left sidebar or press Ctrl+Shift+D).
3. Click 'create a launch.json file' to set up debugging.
4. Choose 'Node.js' environment.
5. Add breakpoints by clicking next to the line numbers.
6. Press the green play button to start debugging.
7. Use controls to step over, step into, or continue running.

The launch.json file tells VS Code how to run your program for debugging.

Breakpoints pause your program so you can check what is happening at that moment.

Examples

This setup tells VS Code to run app.js in your project folder when debugging.

Node.js

// launch.json example
{
  "version": "0.2.0",
  "configurations": [
    {
      "type": "node",
      "request": "launch",
      "name": "Launch Program",
      "program": "${workspaceFolder}/app.js"
    }
  ]
}

Breakpoints let you stop the program exactly where you want to check variables or flow.

Node.js

// Setting a breakpoint
// Click on the left side of the line number in your code editor to add a red dot.
// When you run the debugger, the program will pause here.

Sample Program

This simple Node.js program adds two numbers. You can set a breakpoint on the line where result is calculated to see the values of a and b during debugging.

Node.js

console.log('Start program');

function add(a, b) {
  const result = a + b; // Set breakpoint here
  return result;
}

const sum = add(5, 7);
console.log('Sum is:', sum);

Important Notes

You can watch variables and call stack in the Debug panel to understand your program better.

Use the Debug Console to run commands or check variable values while paused.

Remember to remove or disable breakpoints when you finish debugging to avoid pausing unnecessarily.

Summary

Debugging with VS Code helps you find errors by running your code step-by-step.

Set breakpoints to pause your program and inspect variables.

Use the launch.json file to configure how your Node.js program runs in the debugger.

Practice

1. What is the main purpose of setting a breakpoint in VS Code when debugging a Node.js application?

easy

A. To speed up the execution of the program

B. To automatically fix syntax errors in the code

C. To convert JavaScript code into machine code

D. To pause the program at a specific line to inspect variables and program flow

Solution

1. Step 1: Understand what a breakpoint does

   A breakpoint pauses the program execution at a chosen line so you can check what is happening.

2. Step 2: Identify the purpose in debugging

   Pausing lets you inspect variables and see how the program flows step-by-step.

3. Final Answer:

   To pause the program at a specific line to inspect variables and program flow -> Option D

4. Quick Check:

   Breakpoint = Pause and inspect [OK]

Hint: Breakpoints pause code to check variables and flow [OK]

Common Mistakes:

• Thinking breakpoints fix errors automatically
• Believing breakpoints speed up code
• Confusing breakpoints with code compilation

2. Which of the following is the correct way to start debugging a Node.js app in VS Code using the launch.json file?

easy

A. { "type": "node", "request": "run", "program": "${workspaceFolder}/app.js" }

B. { "type": "node", "request": "launch", "program": "${workspaceFolder}/app.js" }

C. { "type": "node", "request": "compile", "program": "app.js" }

D. { "type": "python", "request": "launch", "program": "app.js" }

Solution

1. Step 1: Check the correct debug type for Node.js

   The type must be "node" to debug Node.js applications.

2. Step 2: Verify the request and program fields

   "request" should be "launch" to start debugging, and "program" points to the main file with workspace variable.

3. Final Answer:

   { "type": "node", "request": "launch", "program": "${workspaceFolder}/app.js" } -> Option B

4. Quick Check:

   Node debug launch with correct program path [OK]

Hint: Use type 'node' and request 'launch' in launch.json [OK]

Common Mistakes:

• Using wrong type like 'python' for Node.js
• Using 'compile' or 'run' instead of 'launch'
• Not using workspaceFolder variable for program path

3. Consider this Node.js code snippet debugged in VS Code with a breakpoint on line 3:

1 const x = 5;
2 const y = 10;
3 const sum = x + y;
4 console.log(sum);

When paused at the breakpoint on line 3, what will be the value of sum in the debugger?

medium

A. undefined

B. 15

C. 5

D. Error: sum is not defined

Solution

1. Step 1: Understand when the breakpoint pauses execution

   The breakpoint on line 3 pauses before executing that line, so sum is not yet assigned.

2. Step 2: Determine the value of sum at pause

   Since line 3 hasn't run, sum is declared but not assigned, so its value is undefined.

3. Final Answer:

   undefined -> Option A

4. Quick Check:

   Breakpoint pauses before assignment, sum = undefined [OK]

Hint: Breakpoint pauses before line runs, variable not assigned yet [OK]

Common Mistakes:

• Assuming sum already has the calculated value
• Confusing declaration with assignment timing
• Expecting runtime error at breakpoint

4. You set a breakpoint in VS Code but the debugger never pauses when running your Node.js app. Which of these is the most likely cause?

medium

A. The Node.js version is too new

B. You forgot to save the file before running

C. The launch.json file is missing or misconfigured

D. Breakpoints only work in browser debugging

Solution

1. Step 1: Check debugger configuration

   If launch.json is missing or has errors, VS Code cannot attach the debugger properly.

2. Step 2: Understand breakpoint behavior

   Without correct config, breakpoints won't pause execution even if set.

3. Final Answer:

   The launch.json file is missing or misconfigured -> Option C

4. Quick Check:

   Debugger config missing = breakpoints ignored [OK]

Hint: Verify launch.json exists and is correct to enable breakpoints [OK]

Common Mistakes:

• Blaming Node.js version without checking config
• Assuming breakpoints need browser debugging
• Not saving files but that usually doesn't stop breakpoints

5. You want to debug a Node.js app that uses environment variables. How can you configure launch.json to pass an environment variable named API_KEY with value 12345 to your app during debugging?

hard

A. { "type": "node", "request": "launch", "program": "${workspaceFolder}/app.js", "env": { "API_KEY": "12345" } }

B. { "type": "node", "request": "launch", "program": "app.js", "args": ["API_KEY=12345"] }

C. { "type": "node", "request": "launch", "program": "app.js", "envFile": "API_KEY=12345" }

D. { "type": "node", "request": "launch", "program": "app.js", "env": "API_KEY=12345" }

Solution

1. Step 1: Use the correct property for environment variables

   The "env" property in launch.json accepts an object with key-value pairs for environment variables.

2. Step 2: Format the environment variable correctly

   Set "API_KEY" as key and "12345" as its string value inside the "env" object.

3. Final Answer:

   { "type": "node", "request": "launch", "program": "${workspaceFolder}/app.js", "env": { "API_KEY": "12345" } } -> Option A

4. Quick Check:

   Use "env" object with key-value pairs in launch.json [OK]

Hint: Set env variables as key-value pairs inside "env" in launch.json [OK]

Common Mistakes:

• Using args array instead of env object
• Passing env as a string instead of object
• Confusing envFile with direct env variable setting