feat(binding-builder): add binding-builder cli #10876

h-a-n-a · 2025-07-02T10:24:01Z

Summary

Introduce a new package @rspack/binding-builder-cli to build binding (bin: rspack-builder).

The new @rspack/binding-builder-cli will be utilized for both crates/node_binding and projects using rspack-binding-template or similar.

The original build script contains special environment variables and features that are specialized for crates/node_binding. With that being said, I kept the original scripts/build.js to call rspack-builder to achieve the same effect.

Rationale

This package is designed to provide a command-line interface for building custom bindings for rspack.

Rspack internally performs post-processing modifications on the generated TypeScript definition (.d.ts) files from NAPI-RS bindings. The @rspack/binding-builder-cli synchronizes these modifications, ensuring that the generated .d.ts files are complete and provide access to all type information available in @rspack/binding plus the newly added types in custom binding.

Debug

To debug rspack-builder, set DEBUG=rspack-builder:* as a prefix to the command.

Checklist

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

netlify · 2025-07-02T10:24:06Z

✅ Deploy Preview for rspack ready!

Name	Link
🔨 Latest commit	`4a924a7`
🔍 Latest deploy log	https://app.netlify.com/projects/rspack/deploys/686635884387d300081bf0ce
😎 Deploy Preview	https://deploy-preview-10876--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.

h-a-n-a · 2025-07-02T10:49:27Z

.github/actions/pnpm/install-binding-dependencies/action.yml

@@ -31,7 +31,7 @@ runs:
      shell: bash
      run: |
        cd ./crates/node_binding
-        pnpm install --ignore-workspace --no-lockfile


The bad part is we have to link binding-builder-cli to crates/node_binding. This requires the binding to fallback to workspace install instead of plain package install. cc @stormslowly

stormslowly · 2025-07-02T10:52:18Z

.github/actions/pnpm/install-binding-dependencies/action.yml

@@ -31,7 +31,7 @@ runs:
      shell: bash
      run: |
        cd ./crates/node_binding
-        pnpm install --ignore-workspace --no-lockfile


remove --ignore-workspace will install all workspace depenceies and slow down installation.

We could probably install the binding builder cli as a dependency (not from the current workspace) after the first release, then we can revert the workflow back.

packages/binding-builder-cli/package.json

pnpm-lock.yaml

crates/node_binding/scripts/build.js

crates/rspack_binding_builder_testing/package.json

crates/node_binding/scripts/build.js

hardfist · 2025-07-02T10:59:50Z

packages/binding-builder-cli/scripts/build.js

+	process.exit(0);
+}
+
+const { NapiCli } = require("@napi-rs/cli");


I'm not sure it's a stable public api or just an internal api, I'm afraid whether we'll miss some logic in the napi-cli/bin

https://github.com/napi-rs/napi-rs/blob/7e34e30b66b2c35de31a3f4386d166c2154e4e8c/cli/package.json#L26 Looks like public APIs to me

hardfist · 2025-07-02T11:09:33Z

packages/binding-builder-cli/scripts/build.js

+
+const debug = require("debug")("rspack-builder:build");
+
+const OPTIONS_CONFIG = {


is this duplicate of https://github.com/napi-rs/napi-rs/blob/main/cli/src/def/build.ts#L5 or we add custom logic here?

Yea, it's a bunch of code supposed to achieve the same functionalities with napi-rs cli. I changed it to programmatic API to make our CLI output nice and clean.

stormslowly · 2025-07-02T11:11:35Z

If rspack-builder is mainly for rspack template user, in my opinion, put how we use napi in package.json's script is better.

easy for napi veteran to tweak
less abstraction; In my opinion, the template repo is more of a rust napi project other than rspack plugin project.

hardfist · 2025-07-02T11:13:56Z

packages/binding-builder-cli/package.json

@@ -0,0 +1,31 @@
+{
+  "name": "@rspack/binding-builder-cli",
+  "version": "1.4.2",


I don't fully understand why we need make our own cli instead of using napi-cli? can you help explain in README.md so outside contributors can understand it

Being explained in #10876 (comment)

+README.md https://github.com/web-infra-dev/rspack/blob/55995fcc35e6518fca990d507cb11dfbed9d8aa6/packages/binding-builder-cli/README.md

h-a-n-a · 2025-07-02T11:15:11Z

If rspack-builder is mainly for rspack template user, in my opinion, put how we use napi in package.json's script is better.

easy for napi veteran to tweak

less abstraction; In my opinion, the template repo is more of a rust napi project other than rspack plugin project.

I had thought about this in the first place. But rspack's binding heavily requires some tweaking to the binding.d.ts and we need to sync these changes to the users and this is the most painful part.

github-actions · 2025-07-03T06:37:25Z

📦 Binary Size-limit

Comparing binary size with Commit: fix: always rebuild error module (#10873) by jinrui

❌ Size increased by 1150.33MB from 59.79MB to 1210.13MB (⬆️1923.89%)

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

h-a-n-a force-pushed the binding-builder-cli branch 2 times, most recently from 7c7b928 to 63b2164 Compare July 2, 2025 10:36

h-a-n-a marked this pull request as ready for review July 2, 2025 10:46

h-a-n-a requested review from chenjiahan, hardfist and stormslowly July 2, 2025 10:46

h-a-n-a commented Jul 2, 2025

View reviewed changes

stormslowly reviewed Jul 2, 2025

View reviewed changes

chenjiahan reviewed Jul 2, 2025

View reviewed changes

packages/binding-builder-cli/package.json Show resolved Hide resolved

pnpm-lock.yaml Show resolved Hide resolved

stormslowly reviewed Jul 2, 2025

View reviewed changes

crates/node_binding/scripts/build.js Show resolved Hide resolved

hardfist reviewed Jul 2, 2025

View reviewed changes

crates/rspack_binding_builder_testing/package.json Show resolved Hide resolved

stormslowly reviewed Jul 2, 2025

View reviewed changes

crates/node_binding/scripts/build.js Show resolved Hide resolved

hardfist reviewed Jul 2, 2025

View reviewed changes

h-a-n-a force-pushed the binding-builder-cli branch 2 times, most recently from d42471e to 941c66c Compare July 2, 2025 11:37

h-a-n-a requested review from stormslowly, chenjiahan and hardfist July 2, 2025 11:53

h-a-n-a enabled auto-merge (squash) July 2, 2025 12:06

h-a-n-a added 3 commits July 3, 2025 15:47

feat(binding-builder): add binding-builder cli

8148048

ci: invoke binding builder cli in ci

34de589

chore: cr

75d483a

h-a-n-a added 3 commits July 3, 2025 15:47

docs: update README

750e9c1

chore: try parking lot

9da9600

chore: try

4a924a7

h-a-n-a force-pushed the binding-builder-cli branch from 144c0f4 to 4a924a7 Compare July 3, 2025 07:47


		const debug = require("debug")("rspack-builder:build");

		const OPTIONS_CONFIG = {

Uh oh!

feat(binding-builder): add binding-builder cli #10876

Are you sure you want to change the base?

feat(binding-builder): add binding-builder cli #10876

Conversation

h-a-n-a commented Jul 2, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Rationale

Debug

Related links

Checklist

Uh oh!

netlify bot commented Jul 2, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for rspack ready!

Uh oh!

h-a-n-a Jul 2, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

stormslowly commented Jul 2, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

h-a-n-a commented Jul 2, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions bot commented Jul 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

📦 Binary Size-limit

Uh oh!

Uh oh!

h-a-n-a commented Jul 2, 2025 •

edited

Loading

netlify bot commented Jul 2, 2025 •

edited

Loading

h-a-n-a Jul 2, 2025 •

edited

Loading

h-a-n-a commented Jul 2, 2025 •

edited

Loading

github-actions bot commented Jul 3, 2025 •

edited

Loading