Skip to content

docs(learn): improve debugging docs #8329

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Nov 6, 2025
Merged

docs(learn): improve debugging docs #8329

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
265e37d
docs(learn): improve debugging docs
efekrskl Nov 4, 2025
9b7a593
docs(learn): remove gitpod section
efekrskl Nov 4, 2025
da9c7b9
docs(learn): update vscode link
efekrskl Nov 4, 2025
fc188a5
Update apps/site/pages/en/learn/getting-started/debugging.md
efekrskl Nov 5, 2025
2044273
docs(learn): update debugging docs according to copilot suggestions
efekrskl Nov 5, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 13 additions & 14 deletions apps/site/pages/en/learn/getting-started/debugging.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,20 +71,25 @@ Several commercial and open source tools can also connect to the Node.js Inspect

### Chrome DevTools 55+, Microsoft Edge

- **Option 1**: Open `chrome://inspect` in a Chromium-based
browser or `edge://inspect` in Edge. Click the Configure button and ensure your target host and port
are listed.
- **Option 2**: Copy the `devtoolsFrontendUrl` from the output of `/json/list`
(see above) or the --inspect hint text and paste into Chrome.
#### Option 1: Use the built-in DevTools UI

See https://github.com/ChromeDevTools/devtools-frontend, https://www.microsoftedgeinsider.com for more information.
- Open `chrome://inspect` (`edge://inspect` in Microsoft Edge) in your browser.
- Click the Configure button and ensure your target host and port are listed.
- Your Node.js application should appear in the Remote Target list.

#### Option 2: Connect manually

- Visit `http://localhost:<inspect-port>/json/list`. It should return a JSON object containing a `devtoolsFrontendUrl`.
- Copy the `devtoolsFrontendUrl` value from the response and paste it into your browser's address bar.

See [Chrome DevTools Frontend](https://github.com/ChromeDevTools/devtools-frontend) and [Microsoft Edge DevTools Guide](https://learn.microsoft.com/microsoft-edge/devtools-guide-chromium/) for more information.

### Visual Studio Code 1.10+

- In the Debug panel, click the settings icon to open `.vscode/launch.json`.
Select "Node.js" for initial setup.

See https://github.com/microsoft/vscode for more information.
See https://code.visualstudio.com/docs/nodejs/nodejs-debugging for more information.

### Visual Studio 2017+

Expand All @@ -104,18 +109,12 @@ See https://github.com/microsoft/vscode for more information.

See https://github.com/cyrus-and/chrome-remote-interface for more information.

### Gitpod

- Start a Node.js debug configuration from the `Debug` view or hit `F5`. [Detailed instructions](https://medium.com/gitpod/debugging-node-js-applications-in-theia-76c94c76f0a1)

See https://www.gitpod.io for more information.

### Eclipse IDE with Eclipse Wild Web Developer extension

- From a .js file, choose "Debug As... > Node program", or
- Create a Debug Configuration to attach debugger to running Node.js application (already started with `--inspect`).

See https://eclipse.org/eclipseide for more information.
See https://eclipseide.org/ for more information.

## Command-line options

Expand Down
Loading