feat: add `requireAlias` option to control require variable renaming #12686

LingyuCoder · 2026-01-09T05:35:23Z

Summary

This PR introduces a new experimental parser option requireAlias for JavaScript modules, which controls whether the require identifier can be renamed to another variable.

By default, requireAlias is set to true, allowing users to rename require to custom variables (e.g., var cjsRequire = require). When set to false, the require identifier cannot be renamed, preserving its original behavior.

This option provides more flexibility for users who want to control how CommonJS imports are handled in their builds, especially in scenarios where preventing require renaming is necessary for compatibility or code generation purposes.

Checklist

Tests updated (or not required).
Documentation updated (or not required).

netlify · 2026-01-09T05:38:50Z

✅ Deploy Preview for rspack ready!

Name	Link
🔨 Latest commit	`073cd41`
🔍 Latest deploy log	https://app.netlify.com/projects/rspack/deploys/6960bfa624ec0f00086c80a8
😎 Deploy Preview	https://deploy-preview-12686--rspack.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

Copilot

Pull request overview

This PR introduces a new experimental parser option requireRename for JavaScript modules, providing control over whether the require identifier can be renamed to other variables. The option defaults to true (allowing renaming), maintaining backward compatibility, while setting it to false preserves the require identifier in the output bundle.

Key changes:

Added requireRename boolean option to JavascriptParserOptions with default value of true
Implemented parser logic to respect the option when determining if require can be renamed
Added comprehensive test coverage for both enabled (default) and disabled renaming scenarios

Reviewed changes

Copilot reviewed 16 out of 22 changed files in this pull request and generated 2 comments.

Show a summary per file

File	Description
packages/rspack/src/config/types.ts	Added `requireRename` type definition to JavascriptParserOptions
packages/rspack/src/config/defaults.ts	Set default value of `requireRename` to `true`
packages/rspack/src/config/adapter.ts	Added adapter mapping for `requireRename` option
packages/rspack/etc/core.api.md	Updated API documentation with new option
crates/rspack_plugin_javascript/src/parser_plugin/common_js_imports_parse_plugin.rs	Implemented core logic to check `require_rename` option in `can_rename` method
crates/rspack_core/src/options/module.rs	Added `require_rename` field to JavascriptParserOptions struct
crates/rspack_binding_api/src/raw_options/raw_module/mod.rs	Added binding support for `requireRename` with experimental annotation
crates/rspack/src/builder/mod.rs	Set builder default value to `true`
crates/node_binding/napi-binding.d.ts	Added TypeScript bindings with experimental JSDoc annotation
crates/rspack/tests/snapshots/defaults__default_options.snap	Updated snapshot to include new option
tests/rspack-test/normalCases/parsing/renaming/index.js	Uncommented existing tests to verify default renaming behavior
tests/rspack-test/configCases/parsing/renaming-disabled/*	Added new test case to verify disabled renaming behavior
tests/rspack-test/defaultsCases/default/base.js	Updated snapshot to include `requireRename: true`
tests/rspack-test/defaultsCases/library/*.js	Fixed indentation in inline snapshots (formatting)

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

packages/rspack/src/config/types.ts

tests/rspack-test/configCases/parsing/renaming-disabled/index.js

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

packages/rspack/src/config/types.ts

github-actions · 2026-01-09T05:51:36Z

Rsdoctor Bundle Diff Analysis

Found 5 projects in monorepo, 0 projects with changes.

📊 Quick Summary

Project	Total Size	Change
react-10k	5.7 MB	0
react-1k	825.4 KB	0
rome	984.3 KB	0
react-5k	2.7 MB	0
ui-components	2.1 MB	0

Generated by Rsdoctor GitHub Action

github-actions · 2026-01-09T05:52:15Z

📦 Binary Size-limit

Comparing 073cd41 to feat: rspack_cacheable context expose project root (#12685) by jinrui

❌ Size increased by 7.00KB from 47.87MB to 47.88MB (⬆️0.01%)

codspeed-hq · 2026-01-09T05:56:49Z

CodSpeed Performance Report

Merging this PR will not alter performance

_{Comparing feat/require-rename-option (073cd41) with main (b81dfa2)}

Summary

✅ 16 untouched benchmarks
⏩ 1 skipped benchmark¹

1 benchmark was skipped, so the baseline result was used instead. If it was deleted from the codebase, click here and archive it to remove it from the performance reports. ↩

…12686) * feat: add requireRename option to control require variable renaming * Update packages/rspack/src/config/types.ts Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Update tests/rspack-test/configCases/parsing/renaming-disabled/index.js Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * rename * rename --------- Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

feat: add requireRename option to control require variable renaming

fbc4d42

Copilot AI review requested due to automatic review settings January 9, 2026 05:35

LingyuCoder requested review from h-a-n-a and hardfist as code owners January 9, 2026 05:35

github-actions bot added team The issue/pr is created by the member of Rspack. release: feature release: feature related release(mr only) labels Jan 9, 2026

Copilot started reviewing on behalf of LingyuCoder January 9, 2026 05:36 View session

Copilot AI reviewed Jan 9, 2026

View reviewed changes

packages/rspack/src/config/types.ts Outdated Show resolved Hide resolved

tests/rspack-test/configCases/parsing/renaming-disabled/index.js Outdated Show resolved Hide resolved

LingyuCoder and others added 2 commits January 9, 2026 13:41

Update packages/rspack/src/config/types.ts

467f4e1

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Update tests/rspack-test/configCases/parsing/renaming-disabled/index.js

ac9cb11

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

chenjiahan reviewed Jan 9, 2026

View reviewed changes

packages/rspack/src/config/types.ts Outdated Show resolved Hide resolved

rename

b840c6f

LingyuCoder changed the title ~~feat: add requireRename option to control require variable renaming~~ feat: add requireAlias option to control require variable renaming Jan 9, 2026

rename

44e0b46

LingyuCoder force-pushed the feat/require-rename-option branch from 0a86fc3 to 44e0b46 Compare January 9, 2026 06:54

LingyuCoder enabled auto-merge (squash) January 9, 2026 08:29

rename

073cd41

stormslowly approved these changes Jan 9, 2026

View reviewed changes

LingyuCoder merged commit 6ee0d4b into main Jan 9, 2026
52 checks passed

LingyuCoder deleted the feat/require-rename-option branch January 9, 2026 09:10

github-actions bot mentioned this pull request Jan 9, 2026

chore: update main #12691

Merged

2 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

feat: add `requireAlias` option to control require variable renaming #12686

feat: add `requireAlias` option to control require variable renaming #12686

Uh oh!

LingyuCoder commented Jan 9, 2026 •

edited

Loading

Uh oh!

netlify bot commented Jan 9, 2026 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

github-actions bot commented Jan 9, 2026 •

edited

Loading

Uh oh!

github-actions bot commented Jan 9, 2026 •

edited

Loading

Uh oh!

codspeed-hq bot commented Jan 9, 2026 •

edited

Loading

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Uh oh!

feat: add requireAlias option to control require variable renaming #12686

feat: add requireAlias option to control require variable renaming #12686

Uh oh!

Conversation

LingyuCoder commented Jan 9, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Checklist

Uh oh!

netlify bot commented Jan 9, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for rspack ready!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

github-actions bot commented Jan 9, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Rsdoctor Bundle Diff Analysis

Uh oh!

github-actions bot commented Jan 9, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

📦 Binary Size-limit

Uh oh!

codspeed-hq bot commented Jan 9, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

CodSpeed Performance Report

Merging this PR will not alter performance

Summary

Footnotes

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

feat: add `requireAlias` option to control require variable renaming #12686

feat: add `requireAlias` option to control require variable renaming #12686

LingyuCoder commented Jan 9, 2026 •

edited

Loading

netlify bot commented Jan 9, 2026 •

edited

Loading

github-actions bot commented Jan 9, 2026 •

edited

Loading

github-actions bot commented Jan 9, 2026 •

edited

Loading

codspeed-hq bot commented Jan 9, 2026 •

edited

Loading