Skip to content

docs(transform): use the node: namespace in the example#19998

Merged
overlookmotel merged 1 commit intooxc-project:mainfrom
lumirlumir:docs/node-namespace
Apr 23, 2026
Merged

docs(transform): use the node: namespace in the example#19998
overlookmotel merged 1 commit intooxc-project:mainfrom
lumirlumir:docs/node-namespace

Conversation

@lumirlumir
Copy link
Copy Markdown
Contributor

@lumirlumir lumirlumir commented Mar 4, 2026

Hi,

This PR simply updates the documentation example in napi/transform/README.md to use the node: namespace when importing a Node.js built-in module.

As far as I know, the node: namespace prefix for built-in modules was introduced in Node.js 14.18.0 and 16.0.0, so it should work with the current Node.js supported version range.

"engines": {
"node": "^20.19.0 || >=22.12.0"
}

Also, it appears that the other source files already use it when importing Node.js built-in modules.

import fs from "node:fs";
import { join as pathJoin } from "node:path";

const fs = require("node:fs");
const childProcess = require("node:child_process");

Please let me know if there's anything wrong with this change!

Copilot AI review requested due to automatic review settings March 4, 2026 10:25
@github-actions github-actions Bot added the A-transformer Area - Transformer / Transpiler label Mar 4, 2026
@lumirlumir lumirlumir changed the title docs: use the node: namespace in the example docs(transform): use the node: namespace in the example Mar 4, 2026
@github-actions github-actions Bot added the C-docs Category - Documentation. Related to user-facing or internal documentation label Mar 4, 2026
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Updates the napi/transform documentation examples to use the node: namespace when importing Node.js built-in modules, aligning the README with modern Node.js import conventions used elsewhere in this package.

Changes:

  • Replaced import assert from "assert"; with import assert from "node:assert"; in the transform example.
  • Replaced import assert from "assert"; with import assert from "node:assert"; in the isolated declarations example.

You can also share your feedback on Copilot code review. Take the survey.

@lumirlumir lumirlumir changed the title docs(transform): use the node: namespace in the example docs(oxc-transform): use the node: namespace in the example Mar 4, 2026
@lumirlumir lumirlumir changed the title docs(oxc-transform): use the node: namespace in the example docs(transform): use the node: namespace in the example Mar 4, 2026
Copy link
Copy Markdown
Member

@overlookmotel overlookmotel left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Really sorry this has languished unreviewed for so long. Thanks very much for the contribution!

@overlookmotel overlookmotel merged commit e4cea25 into oxc-project:main Apr 23, 2026
24 checks passed
camc314 pushed a commit that referenced this pull request Apr 27, 2026
### 💥 BREAKING CHANGES

- 502e804 ast: [**BREAKING**] Reduce size of `TSTypePredicateName`
(#21711) (overlookmotel)
- 5651539 ast: [**BREAKING**] Reduce size of `JSXExpression` (#21710)
(overlookmotel)
- c44e280 ast: [**BREAKING**] Reduce size of `ArrayExpressionElement`
(#21709) (overlookmotel)
- c5b3deb syntax: [**BREAKING**] Remove `CommentNodeId` (#21679)
(overlookmotel)

### 🚀 Features

- b738a39 allocator: Add `Allocator::cursor_ptr` method (#21773)
(overlookmotel)
- 678767e ast: Generate node_id accessors for AST enum wrappers (#21653)
(camc314)
- f091d77 minifier: Inline constant spread elements into arrays (#21095)
(Armano)

### 🐛 Bug Fixes

- 0d608c2 minifier: Preserve raw CR in template literals (#21645)
(Dunqing)
- a889ea9 minifier: Track pure functions in DCE mode (#21722) (Dunqing)
- 674dfac allocator: `Arena` retry allocation when chunk size approaches
maximum (#21777) (overlookmotel)
- f130cc0 allocator: Fix arithmetic overflow in
`Arena::new_chunk_memory_details` (#21745) (overlookmotel)
- b9bf239 allocator: Fix UB in `Arena::grow_zeroed` (#21739)
(overlookmotel)
- d2b9389 allocator: Clippy warning when building without `testing`
feature (#21681) (camc314)
- 503dc86 codegen: Map sourcemaps from visible output starts (#21662)
(Dunqing)
- c92bd3b transformer: Use SPAN for synthesized helper calls to prevent
comment misattribution (#21578) (Dunqing)
- 0d80441 codegen: Add mapping before printing `#` for private ident
(#21619) (camc314)

### ⚡ Performance

- 9fa362e napi/parser: Do not generate tokens except in tests (#21811)
(overlookmotel)
- 0044392 allocator: Reduce branches when allocating new chunk (#21776)
(overlookmotel)
- 7896bd0 allocator: `Allocator::used_bytes` do not use chunk iterator
(#21771) (overlookmotel)
- a5c562f allocator: Remove check in `Arena::new_chunk_memory_details`
(#21750) (overlookmotel)
- 35bbe1f allocator: `Arena` use unchecked size round up where
guaranteed no overflow (#21743) (overlookmotel)
- ffe229b allocator: Remove unnecessary check from
`Arena::try_alloc_layout_slow_impl` (#21732) (overlookmotel)
- 72fece5 allocator: Use `NonNull::offset_from_unsigned` in
`Arena::chunk_capacity` (#21731) (overlookmotel)
- cab32ae ast: Add `#[inline(always)]` to `node_id` methods on enums
with all variants unboxed (#21707) (overlookmotel)
- b179688 parser: Allocate `TriviaBuilder` comments in the arena
(#21512) (Boshen)
- 2290f31 lexer: Fix perf of `Token::set_*` methods on Rust 1.95.0
(#21659) (overlookmotel)
- 1b58029 allocator: Move code into cold path in `Arena::alloc_layout`
(#21622) (overlookmotel)
- 3cf7cef allocator: Reduce instructions on allocation hot path (#21510)
(overlookmotel)

### 📚 Documentation

- ce65070 data_structures: Document why `as_ref` and `as_mut` on
`NonNullConst` and `NonNullMut` take `self` (#21800) (overlookmotel)
- 93b7dbd allocator: Improve doc comments for `ChunkFooter` (#21733)
(overlookmotel)
- 295db8d transformer: Fix comment (#21717) (overlookmotel)
- 5c93af8 ast: Add comments explaining `#[inline(always)]` to `node_id`
methods on enums (#21706) (overlookmotel)
- e4cea25 transform: Use the `node:` namespace in the example (#19998)
(루밀LuMir)

### 🛡️ Security

- d8076c9 deps: Update rolldown (#21639) (renovate)

Co-authored-by: Boshen <1430279+Boshen@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

A-transformer Area - Transformer / Transpiler C-docs Category - Documentation. Related to user-facing or internal documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants