Skip to content

docs(learn): Migrate the legacy guide "Debugging - Getting Started" to the learn section #6265

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.

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
Show file tree
Hide file tree
Changes from all commits
Commits
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
3 changes: 2 additions & 1 deletion i18n/locales/en.json
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,8 @@
"ecmascript2015Es6AndBeyond": "ECMAScript 2015 (ES6) and beyond",
"nodejsTheDifferenceBetweenDevelopmentAndProduction": "Node.js, the difference between development and production",
"nodejsWithTypescript": "Node.js with TypeScript",
"nodejsWithWebassembly": "Node.js with WebAssembly"
"nodejsWithWebassembly": "Node.js with WebAssembly",
"debugging": "Debugging Node.js"
}
},
"asynchronousWork": {
Expand Down
4 changes: 4 additions & 0 deletions navigation.json
Original file line number Diff line number Diff line change
Expand Up @@ -116,6 +116,10 @@
"nodejsWithWebassembly": {
"link": "/learn/getting-started/nodejs-with-webassembly",
"label": "components.navigation.learn.gettingStarted.links.nodejsWithWebassembly"
},
"debugging": {
"link": "/learn/getting-started/debugging",
"label": "components.navigation.learn.gettingStarted.links.debugging"
}
}
},
Expand Down
1 change: 0 additions & 1 deletion pages/en/guides/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,6 @@ layout: docs.hbs

## General

- [Debugging - Getting Started](/guides/debugging-getting-started/)
- [Easy profiling for Node.js Applications](/guides/simple-profiling/)
- [Diagnostics - Flame Graphs](/guides/diagnostics-flamegraph/)
- [Diagnostics - User Journey](/guides/diagnostics/)
Expand Down
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
---
title: Debugging - Getting Started
layout: docs.hbs
title: Debugging Node.js
layout: learn.hbs
---

# Debugging Guide
# Debugging Node.js

This guide will help you get started debugging your Node.js apps and scripts.

Expand All @@ -22,8 +22,6 @@ Node.js will also start listening for debugging messages if it receives a
earlier, this activates the legacy Debugger API. In Node.js 8 and later, it will
activate the Inspector API.

---

## Security Implications

Since the debugger has full access to the Node.js execution environment, a
Expand Down Expand Up @@ -111,8 +109,6 @@ Several commercial and open source tools can also connect to the Node.js Inspect
- 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`).

---

## Command-line options

The following table lists the impact of various runtime flags on debugging:
Expand All @@ -126,8 +122,6 @@ The following table lists the impact of various runtime flags on debugging:
| node inspect script.js | Spawn child process to run user's script under --inspect flag; and use main process to run CLI debugger. |
| node inspect --port=xxxx script.js | Spawn child process to run user's script under --inspect flag; and use main process to run CLI debugger. Listen on port port (default: 9229) |

---

## Enabling remote debugging scenarios

We recommend that you never have the debugger listen on a public IP address. If
Expand Down Expand Up @@ -156,8 +150,6 @@ machine will be forwarded to port 9229 on remote.example.com. You can now attach
a debugger such as Chrome DevTools or Visual Studio Code to localhost:9221,
which should be able to debug as if the Node.js application was running locally.

---

## Legacy Debugger

**The legacy debugger has been deprecated as of Node.js 7.7.0. Please use
Expand Down