Debugging JavaScript Projects with VS Code & Chrome Debugger

Master JavaScript Debugging with VS Code and Chrome Debugger: A Comprehensive Guide

Tired of relying on console.log() for JavaScript debugging? This article introduces powerful debugging techniques using Visual Studio Code (VS Code) and the Chrome Debugger extension, transforming your debugging workflow.

Imagine a world without console.log(). Debugging would be a nightmare! While console.log() offers a quick fix, it becomes cumbersome for complex issues. Debugging tools provide a superior alternative. This guide utilizes VS Code's integrated debugger and the Debugger for Chrome extension for seamless integration with Chrome DevTools.

Key Advantages:

• Streamlined debugging, eliminating console.log() reliance.
• Precise breakpoints for pausing execution at specific points.
• Detailed inspection of variable states and step-by-step code execution.
• Customizable launch.json configurations for targeted debugging.
• Effective breakpoint management and expression watching within the VS Code debugging panel.
• Seamless Mocha test debugging for isolating and resolving test failures.
• Client-side JavaScript debugging with the Chrome Debugger.

Prerequisites:

• Modern JavaScript understanding.
• Node.js
• Visual Studio Code
• Chrome Browser
• debug-example project (clone this project for hands-on practice).

Setting up the debug-example Project:

1. Clone the debug-example repository.
2. Open the project in VS Code.
3. Install dependencies:

npm install
npm install -g mocha

Debugging in VS Code: A Step-by-Step Guide

Let's debug src/places.js:

const places = [];

module.exports = {
  places,

  addPlace: (city, country) => {
    const id = ++places.length; // Bug: Modifies places.length prematurely
    let numType = 'odd';
    if (id % 2) { // Bug: Incorrect modulus condition
      numType = 'even';
    }
    places.push({ id, city, country, numType });
  },
};

module.exports.addPlace('Mombasa', 'Kenya');
module.exports.addPlace('Kingston', 'Jamaica');
module.exports.addPlace('Cape Town', 'South Africa');

1. Set Breakpoints: Click in the gutter next to line numbers to set breakpoints (red dots).

2. Launch Debugger: Click the debug icon (bug icon) in the VS Code activity bar.

3. Configure launch.json: Click the gear icon to create launch.json. Configure it to debug places.js:

npm install
npm install -g mocha

4. Start Debugging: Select "Launch Places" and press F5 (or click the play button).

5. Debug Controls: Use the debug toolbar controls: Continue, Step Over, Step Into, Step Out, Restart, Stop.

6. Inspect Variables: Hover over variables to see their values, or use the "Variables" and "Watch" sections of the debug panel.

7. Identify and Fix Bugs: Through stepping and inspection, identify the bugs in places.js (premature length increment and incorrect modulus condition). Correct the code accordingly.

Debugging Mocha Tests:

1. Add Mocha Configuration: In the debug panel, click the dropdown and select "Add Configuration". Choose "Mocha Tests".

2. Set Breakpoints in placesTest.js: Add breakpoints in your test file.

3. Start Debugging: Select "Mocha Tests" and start debugging. Step through the tests, inspecting variables to identify and fix any remaining issues. Remember to add a beforeEach hook to reset the places array between tests.

Debugging Client-Side Code with Chrome Debugger:

1. Install the Extension: Install the "Debugger for Chrome" extension from the VS Code marketplace.

2. Configure launch.json: Add a Chrome configuration:

const places = [];

module.exports = {
  places,

  addPlace: (city, country) => {
    const id = ++places.length; // Bug: Modifies places.length prematurely
    let numType = 'odd';
    if (id % 2) { // Bug: Incorrect modulus condition
      numType = 'even';
    }
    places.push({ id, city, country, numType });
  },
};

module.exports.addPlace('Mombasa', 'Kenya');
module.exports.addPlace('Kingston', 'Jamaica');
module.exports.addPlace('Cape Town', 'South Africa');

3. Start the Server: Run your Express server (npm start).

4. Start Debugging: Select "Launch Chrome" and start debugging. The debugger will attach to your Chrome instance.

5. Debug Client-Side Code: Set breakpoints in your client-side JavaScript (app.js), step through the code, and inspect variables to identify and fix any client-side bugs (e.g., incorrect selectors, missing IDs).

Summary:

This guide demonstrates the power of VS Code and the Chrome Debugger for effective JavaScript debugging. By mastering these techniques, you can significantly improve your debugging efficiency and write higher-quality code. Explore the VS Code debugging documentation for advanced features like conditional breakpoints. 告别 console.log()，拥抱高效调试！

The above is the detailed content of Debugging JavaScript Projects with VS Code & Chrome Debugger. For more information, please follow other related articles on the PHP Chinese website!