doc: add `node:` prefix for all core modules by aduh95 · Pull Request #42752 · nodejs/node

aduh95 · 2022-04-15T23:24:08Z

Some core modules can be loaded with or without the node: prefix. Using the prefix disambiguates which specifiers refer to core modules.

This commit updates the docs to use the prefix everywhere, for consistency.

Alternative to #38620.
Fixes: #38343

nodejs-github-bot · 2022-04-15T23:24:12Z

Review requested:

@nodejs/http
@nodejs/http2
@nodejs/modules
@nodejs/net

Some core modules can be loaded with or without the `node:` prefix. Using the prefix disambiguates which specifiers refer to core modules. This commit updates the docs to use the prefix everywhere a core module is referenced.

targos · 2022-04-16T05:55:51Z

This may be a good opportunity to introduce .git-blame-ignore-revs

mcollina

lgtm

aduh95 · 2022-04-16T09:10:18Z

This may be a good opportunity to introduce .git-blame-ignore-revs

From what I can tell, it's not something I can do in this PR, but rather something that someone can do once it has landed, correct?

austinkelleher

✅

RaisinTen

RSLGTM

marsonya

lgtm

tniessen · 2022-04-17T10:18:13Z

+1 to doing this in examples (or, more generally, in code). Not so sure about doing this in text.

targos · 2022-04-18T14:26:06Z

This may be a good opportunity to introduce .git-blame-ignore-revs

From what I can tell, it's not something I can do in this PR, but rather something that someone can do once it has landed, correct?

Yeah, that's correct.

nodejs-github-bot · 2022-04-20T00:53:50Z

Commit Queue failed

- Loading data for nodejs/node/pull/42752
✔  Done loading data for nodejs/node/pull/42752
----------------------------------- PR info ------------------------------------
Title      doc: add `node:` prefix for all core modules (#42752)
   ⚠  Could not retrieve the email or name of the PR author's from user's GitHub profile!
Branch     aduh95:node-prefix-in-docs -> nodejs:master
Labels     doc, author ready
Commits    3
 - doc: add `node:` prefix for all core modules
 - fixup! doc: add `node:` prefix for all core modules
 - fixup! doc: add `node:` prefix for all core modules
Committers 1
 - Antoine du Hamel 
PR-URL: https://github.com/nodejs/node/pull/42752
Fixes: https://github.com/nodejs/node/issues/38343
Reviewed-By: Matteo Collina 
Reviewed-By: Mestery 
Reviewed-By: Darshan Sen 
Reviewed-By: Akhil Marsonya 
Reviewed-By: Rafael Gonzaga 
Reviewed-By: Mohammed Keyvanzadeh 
Reviewed-By: Geoffrey Booth 
Reviewed-By: Stephen Belanger 
------------------------------ Generated metadata ------------------------------
PR-URL: https://github.com/nodejs/node/pull/42752
Fixes: https://github.com/nodejs/node/issues/38343
Reviewed-By: Matteo Collina 
Reviewed-By: Mestery 
Reviewed-By: Darshan Sen 
Reviewed-By: Akhil Marsonya 
Reviewed-By: Rafael Gonzaga 
Reviewed-By: Mohammed Keyvanzadeh 
Reviewed-By: Geoffrey Booth 
Reviewed-By: Stephen Belanger 
--------------------------------------------------------------------------------
   ℹ  This PR was created on Fri, 15 Apr 2022 23:24:08 GMT
   ✔  Approvals: 8
   ✔  - Matteo Collina (@mcollina) (TSC): https://github.com/nodejs/node/pull/42752#pullrequestreview-943831582
   ✔  - Mestery (@Mesteery): https://github.com/nodejs/node/pull/42752#pullrequestreview-943842190
   ✔  - Darshan Sen (@RaisinTen) (TSC): https://github.com/nodejs/node/pull/42752#pullrequestreview-943859669
   ✔  - Akhil Marsonya (@marsonya): https://github.com/nodejs/node/pull/42752#pullrequestreview-943877375
   ✔  - Rafael Gonzaga (@RafaelGSS): https://github.com/nodejs/node/pull/42752#pullrequestreview-943877842
   ✔  - Mohammed Keyvanzadeh (@VoltrexMaster): https://github.com/nodejs/node/pull/42752#pullrequestreview-943881395
   ✔  - Geoffrey Booth (@GeoffreyBooth): https://github.com/nodejs/node/pull/42752#pullrequestreview-946404778
   ✔  - Stephen Belanger (@Qard): https://github.com/nodejs/node/pull/42752#pullrequestreview-946451455
   ✔  Last GitHub CI successful
   ✖  No Jenkins CI runs detected
--------------------------------------------------------------------------------
   ✔  Aborted `git node land` session in /home/runner/work/node/node/.ncu

https://github.com/nodejs/node/actions/runs/2192990918

aduh95 · 2022-04-20T08:24:00Z

Landed in 6afd3fc

Refs: nodejs#42752

Refs: #42752 PR-URL: #42794 Reviewed-By: Mestery <[email protected]> Reviewed-By: Rafael Gonzaga <[email protected]> Reviewed-By: Paolo Insogna <[email protected]> Reviewed-By: Rich Trott <[email protected]>

Some core modules can be loaded with or without the `node:` prefix. Using the prefix disambiguates which specifiers refer to core modules. This commit updates the docs to use the prefix everywhere a core module is referenced. PR-URL: nodejs#42752 Fixes: nodejs#38343 Reviewed-By: Matteo Collina <[email protected]> Reviewed-By: Mestery <[email protected]> Reviewed-By: Darshan Sen <[email protected]> Reviewed-By: Akhil Marsonya <[email protected]> Reviewed-By: Rafael Gonzaga <[email protected]> Reviewed-By: Mohammed Keyvanzadeh <[email protected]> Reviewed-By: Geoffrey Booth <[email protected]> Reviewed-By: Stephen Belanger <[email protected]>

Refs: nodejs#42752 PR-URL: nodejs#42794 Reviewed-By: Mestery <[email protected]> Reviewed-By: Rafael Gonzaga <[email protected]> Reviewed-By: Paolo Insogna <[email protected]> Reviewed-By: Rich Trott <[email protected]>

Some core modules can be loaded with or without the `node:` prefix. Using the prefix disambiguates which specifiers refer to core modules. This commit updates the docs to use the prefix everywhere a core module is referenced. PR-URL: #42752 Fixes: #38343 Reviewed-By: Matteo Collina <[email protected]> Reviewed-By: Mestery <[email protected]> Reviewed-By: Darshan Sen <[email protected]> Reviewed-By: Akhil Marsonya <[email protected]> Reviewed-By: Rafael Gonzaga <[email protected]> Reviewed-By: Mohammed Keyvanzadeh <[email protected]> Reviewed-By: Geoffrey Booth <[email protected]> Reviewed-By: Stephen Belanger <[email protected]>

Refs: #42752 PR-URL: #42794 Reviewed-By: Mestery <[email protected]> Reviewed-By: Rafael Gonzaga <[email protected]> Reviewed-By: Paolo Insogna <[email protected]> Reviewed-By: Rich Trott <[email protected]>

This would make the GitHub blame UI ignore the revisions mentioned in the .git-blame-ignore-revs file. For now, it ignores the change introduced in nodejs@6afd3fc as asked for in nodejs#42752 (comment). Refs: https://github.blog/changelog/2022-03-24-ignore-commits-in-the-blame-view-beta Signed-off-by: Darshan Sen <[email protected]>

Some core modules can be loaded with or without the `node:` prefix. Using the prefix disambiguates which specifiers refer to core modules. This commit updates the docs to use the prefix everywhere a core module is referenced. PR-URL: #42752 Fixes: #38343 Reviewed-By: Matteo Collina <[email protected]> Reviewed-By: Mestery <[email protected]> Reviewed-By: Darshan Sen <[email protected]> Reviewed-By: Akhil Marsonya <[email protected]> Reviewed-By: Rafael Gonzaga <[email protected]> Reviewed-By: Mohammed Keyvanzadeh <[email protected]> Reviewed-By: Geoffrey Booth <[email protected]> Reviewed-By: Stephen Belanger <[email protected]>

Refs: #42752 PR-URL: #42794 Reviewed-By: Mestery <[email protected]> Reviewed-By: Rafael Gonzaga <[email protected]> Reviewed-By: Paolo Insogna <[email protected]> Reviewed-By: Rich Trott <[email protected]>

Some core modules can be loaded with or without the `node:` prefix. Using the prefix disambiguates which specifiers refer to core modules. This commit updates the docs to use the prefix everywhere a core module is referenced. PR-URL: #42752 Fixes: #38343 Reviewed-By: Matteo Collina <[email protected]> Reviewed-By: Mestery <[email protected]> Reviewed-By: Darshan Sen <[email protected]> Reviewed-By: Akhil Marsonya <[email protected]> Reviewed-By: Rafael Gonzaga <[email protected]> Reviewed-By: Mohammed Keyvanzadeh <[email protected]> Reviewed-By: Geoffrey Booth <[email protected]> Reviewed-By: Stephen Belanger <[email protected]>

Refs: #42752 PR-URL: #42794 Reviewed-By: Mestery <[email protected]> Reviewed-By: Rafael Gonzaga <[email protected]> Reviewed-By: Paolo Insogna <[email protected]> Reviewed-By: Rich Trott <[email protected]>

Support for the 'node:' prefixed builtin module namespace was introduced for `require()` expressions in Node v16.0.0, and backported to v14.18.0. This was never supported in Node v15.x or chronologically older. All of the current API history notes in the docs using 'node:' prefixed module `require()`s happen to be documenting changes in Node versions from before the time when support was first introduced. This commit reverts those `require()`s in the history notes to be un-prefixed. (They were incorrect as written; The prefixed `require()`s would not work for those older Node versions.) This change prevents the API history notes from inaccurately implying 'node:' prefixed builtin modules were introduced many Node versions ago, or were `require()`-able with the 'node:' prefix in those Node versions. Refs: nodejs#35387 Refs: nodejs#37246 Refs: nodejs#42752

Refs: #42752 PR-URL: #42794 Reviewed-By: Mestery <[email protected]> Reviewed-By: Rafael Gonzaga <[email protected]> Reviewed-By: Paolo Insogna <[email protected]> Reviewed-By: Rich Trott <[email protected]>

Some core modules can be loaded with or without the `node:` prefix. Using the prefix disambiguates which specifiers refer to core modules. This commit updates the docs to use the prefix everywhere a core module is referenced. PR-URL: #42752 Fixes: #38343 Reviewed-By: Matteo Collina <[email protected]> Reviewed-By: Mestery <[email protected]> Reviewed-By: Darshan Sen <[email protected]> Reviewed-By: Akhil Marsonya <[email protected]> Reviewed-By: Rafael Gonzaga <[email protected]> Reviewed-By: Mohammed Keyvanzadeh <[email protected]> Reviewed-By: Geoffrey Booth <[email protected]> Reviewed-By: Stephen Belanger <[email protected]>

Support for the 'node:' prefixed builtin module namespace was introduced for `require()` expressions in Node v16.0.0, and backported to v14.18.0. This was never supported in Node v15.x or chronologically older. All of the current API history notes in the docs using 'node:' prefixed module `require()`s happen to be documenting changes in Node versions from before the time when support was first introduced. This commit reverts those `require()`s in the history notes to be un-prefixed. (They were incorrect as written; The prefixed `require()`s would not work for those older Node versions.) This change prevents the API history notes from inaccurately implying 'node:' prefixed builtin modules were introduced many Node versions ago, or were `require()`-able with the 'node:' prefix in those Node versions. Refs: #35387 Refs: #37246 Refs: #42752 PR-URL: #43768 Reviewed-By: Rich Trott <[email protected]> Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: Darshan Sen <[email protected]> Reviewed-By: Matteo Collina <[email protected]>

Refs: #42752 PR-URL: #42794 Reviewed-By: Mestery <[email protected]> Reviewed-By: Rafael Gonzaga <[email protected]> Reviewed-By: Paolo Insogna <[email protected]> Reviewed-By: Rich Trott <[email protected]>

Some core modules can be loaded with or without the `node:` prefix. Using the prefix disambiguates which specifiers refer to core modules. This commit updates the docs to use the prefix everywhere a core module is referenced. PR-URL: #42752 Fixes: #38343 Reviewed-By: Matteo Collina <[email protected]> Reviewed-By: Mestery <[email protected]> Reviewed-By: Darshan Sen <[email protected]> Reviewed-By: Akhil Marsonya <[email protected]> Reviewed-By: Rafael Gonzaga <[email protected]> Reviewed-By: Mohammed Keyvanzadeh <[email protected]> Reviewed-By: Geoffrey Booth <[email protected]> Reviewed-By: Stephen Belanger <[email protected]>

Support for the 'node:' prefixed builtin module namespace was introduced for `require()` expressions in Node v16.0.0, and backported to v14.18.0. This was never supported in Node v15.x or chronologically older. All of the current API history notes in the docs using 'node:' prefixed module `require()`s happen to be documenting changes in Node versions from before the time when support was first introduced. This commit reverts those `require()`s in the history notes to be un-prefixed. (They were incorrect as written; The prefixed `require()`s would not work for those older Node versions.) This change prevents the API history notes from inaccurately implying 'node:' prefixed builtin modules were introduced many Node versions ago, or were `require()`-able with the 'node:' prefix in those Node versions. Refs: #35387 Refs: #37246 Refs: #42752 PR-URL: #43768 Reviewed-By: Rich Trott <[email protected]> Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: Darshan Sen <[email protected]> Reviewed-By: Matteo Collina <[email protected]>

Refs: nodejs/node#42752 PR-URL: nodejs/node#42794 Reviewed-By: Mestery <[email protected]> Reviewed-By: Rafael Gonzaga <[email protected]> Reviewed-By: Paolo Insogna <[email protected]> Reviewed-By: Rich Trott <[email protected]>

Some core modules can be loaded with or without the `node:` prefix. Using the prefix disambiguates which specifiers refer to core modules. This commit updates the docs to use the prefix everywhere a core module is referenced. PR-URL: nodejs/node#42752 Fixes: nodejs/node#38343 Reviewed-By: Matteo Collina <[email protected]> Reviewed-By: Mestery <[email protected]> Reviewed-By: Darshan Sen <[email protected]> Reviewed-By: Akhil Marsonya <[email protected]> Reviewed-By: Rafael Gonzaga <[email protected]> Reviewed-By: Mohammed Keyvanzadeh <[email protected]> Reviewed-By: Geoffrey Booth <[email protected]> Reviewed-By: Stephen Belanger <[email protected]>

Support for the 'node:' prefixed builtin module namespace was introduced for `require()` expressions in Node v16.0.0, and backported to v14.18.0. This was never supported in Node v15.x or chronologically older. All of the current API history notes in the docs using 'node:' prefixed module `require()`s happen to be documenting changes in Node versions from before the time when support was first introduced. This commit reverts those `require()`s in the history notes to be un-prefixed. (They were incorrect as written; The prefixed `require()`s would not work for those older Node versions.) This change prevents the API history notes from inaccurately implying 'node:' prefixed builtin modules were introduced many Node versions ago, or were `require()`-able with the 'node:' prefix in those Node versions. Refs: nodejs/node#35387 Refs: nodejs/node#37246 Refs: nodejs/node#42752 PR-URL: nodejs/node#43768 Reviewed-By: Rich Trott <[email protected]> Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: Darshan Sen <[email protected]> Reviewed-By: Matteo Collina <[email protected]>

nodejs-github-bot added the doc Issues and PRs related to the documentations. label Apr 15, 2022

aduh95 force-pushed the node-prefix-in-docs branch from b926e8a to f3aff3e Compare April 15, 2022 23:37

doc: add node: prefix for all core modules

3e71f33

Some core modules can be loaded with or without the `node:` prefix. Using the prefix disambiguates which specifiers refer to core modules. This commit updates the docs to use the prefix everywhere a core module is referenced.

aduh95 force-pushed the node-prefix-in-docs branch from f3aff3e to 3e71f33 Compare April 15, 2022 23:39

mcollina approved these changes Apr 16, 2022

View reviewed changes

aduh95 added the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label Apr 16, 2022

fixup! doc: add node: prefix for all core modules

739706f

Mesteery approved these changes Apr 16, 2022

View reviewed changes

austinkelleher reviewed Apr 16, 2022

View reviewed changes

RaisinTen approved these changes Apr 16, 2022

View reviewed changes

marsonya approved these changes Apr 16, 2022

View reviewed changes

RafaelGSS approved these changes Apr 16, 2022

View reviewed changes

VoltrexKeyva approved these changes Apr 16, 2022

View reviewed changes

fixup! doc: add node: prefix for all core modules

c3331d6

GeoffreyBooth approved these changes Apr 19, 2022

View reviewed changes

aduh95 added the commit-queue Add this label to land a pull request using GitHub Actions. label Apr 19, 2022

Qard approved these changes Apr 20, 2022

View reviewed changes

ErickWendel mentioned this pull request Apr 20, 2022

docs,test: add tests and docs for duplex.fromWeb and duplex.toWeb #42738

Merged

nodejs-github-bot added commit-queue-failed An error occurred while landing this pull request using GitHub Actions. and removed commit-queue Add this label to land a pull request using GitHub Actions. labels Apr 20, 2022

aduh95 merged commit 6afd3fc into nodejs:master Apr 20, 2022

aduh95 deleted the node-prefix-in-docs branch April 20, 2022 08:24

aduh95 added a commit to aduh95/node that referenced this pull request Apr 20, 2022

src: use node: prefix in example

94b069c

Refs: nodejs#42752

aduh95 mentioned this pull request Apr 20, 2022

src: use node: prefix in example #42794

Merged

targos mentioned this pull request May 2, 2022

v18.1.0 release proposal #42943

Merged

RaisinTen mentioned this pull request May 9, 2022

os: fix cpus invalid return type jsdoc syntax #43006

Merged

RaisinTen mentioned this pull request May 9, 2022

tools: add .git-blame-ignore-revs file #43017

Closed

juanarbol mentioned this pull request May 31, 2022

2022-05-XX, Version 16.16.0 'Gallium' (LTS) #43268

Closed

DeeDeeG mentioned this pull request Jul 11, 2022

doc: revert anachronistic 'node:' prefixed module require()s in API history notes #43768

Merged

targos mentioned this pull request Aug 3, 2022

v16.17.0 release proposal #44098

Merged

erickzhao mentioned this pull request Aug 28, 2023

docs: use node: imports for node core modules electron/electron#39681

Merged

5 tasks

aduh95 mentioned this pull request Jul 19, 2024

doc,tools: enforce use of node: prefix #53950

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

doc: add `node:` prefix for all core modules#42752

doc: add `node:` prefix for all core modules#42752
aduh95 merged 3 commits intonodejs:masterfrom
aduh95:node-prefix-in-docs

aduh95 commented Apr 15, 2022 •

edited

Loading

Uh oh!

nodejs-github-bot commented Apr 15, 2022

Uh oh!

targos commented Apr 16, 2022

Uh oh!

mcollina left a comment

Uh oh!

aduh95 commented Apr 16, 2022

Uh oh!

austinkelleher left a comment

Uh oh!

RaisinTen left a comment

Uh oh!

marsonya left a comment

Uh oh!

tniessen commented Apr 17, 2022

Uh oh!

targos commented Apr 18, 2022

Uh oh!

nodejs-github-bot commented Apr 20, 2022

Uh oh!

aduh95 commented Apr 20, 2022

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

13 participants

Uh oh!

Conversation

aduh95 commented Apr 15, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

nodejs-github-bot commented Apr 15, 2022

Uh oh!

targos commented Apr 16, 2022

Uh oh!

mcollina left a comment

Choose a reason for hiding this comment

Uh oh!

aduh95 commented Apr 16, 2022

Uh oh!

austinkelleher left a comment

Choose a reason for hiding this comment

Uh oh!

RaisinTen left a comment

Choose a reason for hiding this comment

Uh oh!

marsonya left a comment

Choose a reason for hiding this comment

Uh oh!

tniessen commented Apr 17, 2022

Uh oh!

targos commented Apr 18, 2022

Uh oh!

nodejs-github-bot commented Apr 20, 2022

Uh oh!

aduh95 commented Apr 20, 2022

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

13 participants

aduh95 commented Apr 15, 2022 •

edited

Loading