Open
Conversation
There was a problem hiding this comment.
Pull request overview
This PR adds a large set of new learning-resource pages across the site (TypeScript, Testing, Diagnostics, HTTP, File System, Command Line, Async, Getting Started, and Package Management), plus updates the main index to link into the new content.
Changes:
- Added a new TypeScript section with pages on introduction, running TS (natively/with runners), transpilation, and publishing TS packages.
- Added/expanded Testing and Diagnostics guides (Node test runner setup, mocking, coverage, profiling, debugging, memory tooling).
- Added multiple foundational pages across other sections (HTTP, command line, async, file system, getting started) and wired them into
pages/index.md.
Reviewed changes
Copilot reviewed 64 out of 64 changed files in this pull request and generated 16 comments.
Show a summary per file
| File | Description |
|---|---|
| pages/index.md | Adds the top-level navigation links to the new/expanded sections. |
| pages/typescript/introduction.md | New TypeScript introduction page. |
| pages/typescript/run.md | New guide covering TS runners (ts-node, tsx). |
| pages/typescript/run-natively.md | New guide for Node’s native TypeScript support and flags/constraints. |
| pages/typescript/transpile.md | New guide on compiling TS to JS with tsc. |
| pages/typescript/publishing-a-ts-package.md | New long-form guide on publishing TypeScript packages. |
| pages/testing/introduction.md | New testing section intro page. |
| pages/testing/using-test-runner.md | New in-depth guide for Node’s built-in test runner patterns. |
| pages/testing/mocking.md | New guide on mocking strategies and Node test runner mocking utilities. |
| pages/testing/collecting-code-coverage.md | New guide describing Node’s test coverage reporting options. |
| pages/package-management/an-introduction-to-the-npm-package-manager.md | Adds npm intro content for package management section. |
| pages/package-management/publishing-node-api-modules.md | Adds guidance on publishing Node-API and non-Node-API variants. |
| pages/package-management/abi-stability.md | Adds ABI stability background content. |
| pages/http/fetch.md | Adds a guide on using Fetch/Undici in Node.js. |
| pages/http/websocket.md | Adds a guide on Node’s built-in WebSocket client usage. |
| pages/http/enterprise-network-configuration.md | Adds enterprise proxy + CA configuration guidance. |
| pages/getting-started/introduction-to-nodejs.md | Adds a Node.js introduction page. |
| pages/getting-started/differences-between-nodejs-and-the-browser.md | Adds a comparison page for browser vs Node.js environments. |
| pages/getting-started/ecmascript-2015-es6-and-beyond.md | Adds a guide on ECMAScript feature support in Node/V8. |
| pages/getting-started/how-much-javascript-do-you-need-to-know-to-use-nodejs.md | Adds prerequisites guidance for learners. |
| pages/getting-started/nodejs-the-difference-between-development-and-production.md | Adds a page discussing NODE_ENV and environment behavior. |
| pages/getting-started/nodejs-with-webassembly.md | Adds a WebAssembly overview for Node.js. |
| pages/getting-started/the-v8-javascript-engine.md | Adds V8 engine overview content. |
| pages/getting-started/userland-migrations.md | Adds documentation for userland codemod migrations. |
| pages/file-system/reading-files-with-nodejs.md | Adds file reading guide content. |
| pages/file-system/writing-files-with-nodejs.md | Adds file writing guide content. |
| pages/file-system/working-with-folders-in-nodejs.md | Adds guide for folder operations. |
| pages/file-system/working-with-file-descriptors-in-nodejs.md | Adds guide for file descriptor usage. |
| pages/file-system/nodejs-file-paths.md | Adds guide for path handling. |
| pages/file-system/nodejs-file-stats.md | Adds guide for fs stats usage. |
| pages/file-system/working-with-different-filesystems.md | Adds best practices for filesystem differences. |
| pages/command-line/run-nodejs-scripts-from-the-command-line.md | Adds guide for running scripts and using --run. |
| pages/command-line/output-to-the-command-line-using-nodejs.md | Adds guide for console output techniques. |
| pages/command-line/how-to-use-the-nodejs-repl.md | Adds REPL usage guide. |
| pages/command-line/how-to-read-environment-variables-from-nodejs.md | Adds env var reading and --env-file content. |
| pages/command-line/accept-input-from-the-command-line-in-nodejs.md | Adds basic CLI input guide. |
| pages/asynchronous-work/javascript-asynchronous-programming-and-callbacks.md | Adds async/callback intro content. |
| pages/asynchronous-work/discover-promises-in-nodejs.md | Adds promises guide content. |
| pages/asynchronous-work/discover-javascript-timers.md | Adds timers guide content. |
| pages/asynchronous-work/understanding-processnexttick.md | Adds process.nextTick() explanation. |
| pages/asynchronous-work/understanding-setimmediate.md | Adds setImmediate() explanation and ordering notes. |
| pages/asynchronous-work/the-nodejs-event-emitter.md | Adds EventEmitter overview content. |
| pages/asynchronous-work/overview-of-blocking-vs-non-blocking.md | Adds blocking vs non-blocking overview. |
| pages/asynchronous-work/asynchronous-flow-control.md | Adds flow-control patterns for async code. |
| pages/diagnostics/user-journey.md | Adds diagnostics “user journey” index page. |
| pages/diagnostics/profiling.md | Adds profiling guide content. |
| pages/diagnostics/debugging.md | Adds debugging/inspector guide content. |
| pages/diagnostics/flame-graphs.md | Adds flame graph creation guide content. |
| pages/diagnostics/poor-performance/index.md | Adds poor performance index page and links into profiling/perf. |
| pages/diagnostics/poor-performance/using-linux-perf.md | Adds Linux perf walkthrough content. |
| pages/diagnostics/live-debugging/index.md | Adds live debugging index page. |
| pages/diagnostics/live-debugging/using-inspector.md | Adds inspector live-debugging short guide. |
| pages/diagnostics/memory/index.md | Adds memory diagnostics index page. |
| pages/diagnostics/memory/understanding-and-tuning-memory.md | Adds memory tuning article content. |
| pages/diagnostics/memory/using-heap-profiler.md | Adds heap profiler guide content. |
| pages/diagnostics/memory/using-heap-snapshot.md | Adds heap snapshot guide content. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
pages/testing/introduction.md
Outdated
|
|
||
| ## Running tests with Node.js | ||
|
|
||
| To run tests with Node.js, we recommend you to read the [test runner documentation](https://nodejs.org/docs/latest/api/test.html#test-runner). |
There was a problem hiding this comment.
Grammar: “we recommend you to read” → “we recommend you read” (or “we recommend reading”).
|
|
||
| ## Migrations guides | ||
|
|
||
| You can find all migrations guide on the [migration guides section](/blog/migrations). |
There was a problem hiding this comment.
Grammar: “You can find all migrations guide” should be plural (“all migration guides”).
pages/testing/mocking.md
Outdated
|
|
||
| Node.js provides many ways to mock various pieces of code. | ||
|
|
||
| This articles deals with the following types of tests: |
There was a problem hiding this comment.
Grammar: “This articles deals” should be “This article deals”.
pages/http/websocket.md
Outdated
|
|
||
| ## Important to Understand | ||
|
|
||
| Node.js v22 **does not** provide a built-in native WebSocket server implementation. To create a WebSocket server that accepts incoming connections from web browsers or other clients, one still need to use libraries like [ws](https://www.npmjs.com/package/ws) or [socket.io](https://www.npmjs.com/package/socket.io). This means that while Node.js can now easily **connect** to WebSocket servers, it still requires external tools to **become** a WebSocket server. |
There was a problem hiding this comment.
Grammar: “one still need to use libraries” → “one still needs to use libraries”.
pages/testing/using-test-runner.md
Outdated
Comment on lines
+241
to
+242
| There is no specific configuration _required_ except enabling the feature via [`--experimental-test-snapshots`](). But to demonstrate the optional configuration, you would probably add something like the following to one of your existing test config files. | ||
|
|
There was a problem hiding this comment.
The --experimental-test-snapshots reference is linked to an empty URL, so the rendered docs will show a broken link. Please link it to the appropriate Node.js CLI docs section (or remove the link formatting if no stable target exists).
Comment on lines
+45
to
+47
| > same tag, `npm update` will receive the later version. This should be acceptable | ||
| > version other than the latest published, the `package.json` dependency will | ||
| > have to refer to the exact version like the following: |
There was a problem hiding this comment.
This blockquote has a broken sentence (“This should be acceptable version other than…”). It reads like it’s missing words (e.g., “This should be acceptable; if you need a version other than the latest published, …”). Please rewrite for grammatical completeness so the guidance is unambiguous.
pages/typescript/transpile.md
Outdated
Comment on lines
+55
to
+63
| Now when we know how to compile and run TypeScript code let's see TypeScript bug-preventing capabilities in action! | ||
|
|
||
| **Step 4:** Run your JavaScript code using Node.js: | ||
|
|
||
| ```bash | ||
| node example.js | ||
| ``` | ||
|
|
||
| You should see the output of your TypeScript code in the terminal |
There was a problem hiding this comment.
This paragraph has a grammatical hiccup (“Now when we know…”). Consider rephrasing to “Now that we know how to compile and run TypeScript code, …”. Also add a period to the end of “You should see the output…” for consistency.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
cc @ovflowd