feat: add Rust-based builtin modules generator with automated workflow

Author: Boshen

.github/renovate.json

@@ -1,4 +1,11 @@
 {
   "$schema": "https://docs.renovatebot.com/renovate-schema.json",
-  "extends": ["github>Boshen/renovate"]
+  "extends": ["github>Boshen/renovate"],
+  "packageRules": [
+    {
+      "matchDatasources": ["node-version"],
+      "matchDepNames": ["node"],
+      "enabled": true
+    }
+  ]
 }

.github/workflows/update-builtins.yml

@@ -0,0 +1,53 @@
+name: Update Built-in Modules
+
+permissions:
+  contents: write
+  pull-requests: write
+
+on:
+  push:
+    branches:
+      - main
+    paths:
+      - ".node-version"
+  workflow_dispatch:
+
+defaults:
+  run:
+    shell: bash
+
+jobs:
+  update-builtins:
+    name: Update Node.js Built-in Modules
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@1af3b93b6815bc44a9784bd300feb67ff0d1eeb3 # v6.0.0
+        with:
+          token: ${{ secrets.OXC_BOT_PAT }}
+
+      - name: Read Node.js version
+        id: node-version
+        run: echo "version=$(cat .node-version)" >> $GITHUB_OUTPUT
+
+      - name: Setup Node.js
+        uses: actions/setup-node@0a44ba7841725637a19e28fa30b79a866c81b0a6 # v4.0.4
+        with:
+          node-version: ${{ steps.node-version.outputs.version }}
+
+      - name: Setup Rust
+        uses: oxc-project/setup-rust@ecabb7322a2ba5aeedb3612d2a40b86a85cee235 # v1.0.11
+
+      - name: Update built-in modules list
+        run: cargo run -p update_builtins
+
+      - name: Format generated code
+        run: cargo fmt
+
+      - name: Run tests
+        run: cargo test
+
+      - uses: stefanzweifel/git-auto-commit-action@28e16e81777b558cc906c8750092100bbb34c5e3 # v7.0.0
+        if: github.ref == 'refs/heads/main' && github.event_name == 'push'
+        with:
+          commit_message: "chore: update built-in modules for Node.js ${{ steps.node-version.outputs.version }} [skip ci]"
+          file_pattern: src/lib.rs

.node-version

@@ -0,0 +1 @@
+24.0.0

Cargo.lock

@@ -1,3 +1,7 @@
+[workspace]
+members = [".", "tasks/update_builtins"]
+resolver = "2"
+
 [package]
 name = "nodejs-built-in-modules"
 version = "0.0.1"

Cargo.toml

@@ -26,6 +26,7 @@ Found 12 outliers among 100 measurements (12.00%)
 **Result:** The `contains` method is ~18% faster than `binary_search` (3.24 µs vs 3.84 µs).
 
 Run benchmarks with:
+
 ```bash
 cargo bench
 ```

README.md

@@ -1,4 +1,4 @@
-use criterion::{black_box, criterion_group, criterion_main, Criterion};
+use criterion::{Criterion, black_box, criterion_group, criterion_main};
 use nodejs_built_in_modules::{BUILTINS, BUILTINS_WITH_MANDATORY_NODE_PREFIX};
 
 /// Version using contains (current implementation)

benches/is_builtin.rs

@@ -11,6 +11,10 @@ alias r := ready
 init:
   cargo binstall watchexec-cli cargo-insta typos-cli cargo-shear dprint -y
 
+update-builtins:
+  cargo run -p update_builtins
+  cargo fmt
+
 ready:
   git diff --exit-code --quiet
   typos

justfile

@@ -0,0 +1,13 @@
+[package]
+name = "update_builtins"
+version = "0.0.0"
+edition = "2024"
+publish = false
+
+[[bin]]
+name = "update_builtins"
+path = "src/main.rs"
+
+[dependencies]
+quote = "1.0"
+serde_json = "1.0"

tasks/update_builtins/Cargo.toml

@@ -0,0 +1,101 @@
+use quote::quote;
+use std::{
+    fs,
+    process::{Command, Stdio},
+};
+
+fn main() {
+    let node_version_path = ".node-version";
+    let node_version = fs::read_to_string(node_version_path)
+        .expect("Failed to read .node-version")
+        .trim()
+        .to_string();
+
+    // Get Node.js major version
+    let node_major_version = node_version.split('.').next().unwrap();
+
+    println!("Using Node.js version: {node_version}");
+
+    // Run Node.js command to get built-in modules
+    let output = Command::new("node")
+        .arg("-p")
+        .arg("[...require('module').builtinModules].map(b => JSON.stringify(b)).join(',\\n')")
+        .stdout(Stdio::piped())
+        .stderr(Stdio::piped())
+        .output()
+        .expect("Failed to execute node command");
+
+    if !output.status.success() {
+        eprintln!("Node.js command failed:");
+        eprintln!("{}", String::from_utf8_lossy(&output.stderr));
+        std::process::exit(1);
+    }
+
+    let modules_output = String::from_utf8(output.stdout).expect("Invalid UTF-8 output");
+
+    // Parse the module names (they're JSON strings separated by commas and newlines)
+    let json_array_str = format!("[{}]", modules_output.trim());
+    let all_modules: Vec<String> =
+        serde_json::from_str(&json_array_str).expect("Failed to parse module list");
+
+    // Separate modules with mandatory node: prefix from regular modules
+    let mut mandatory_prefix_modules: Vec<String> = all_modules
+        .iter()
+        .filter(|m| m.starts_with("node:"))
+        .map(|m| m.strip_prefix("node:").unwrap().to_string())
+        .collect();
+    mandatory_prefix_modules.sort();
+
+    let mut regular_modules: Vec<String> = all_modules
+        .iter()
+        .filter(|m| !m.starts_with("node:"))
+        .cloned()
+        .collect();
+    regular_modules.sort();
+
+    // Build the complete file with doc comments using quote!
+    let regular_module_refs = &regular_modules;
+    let mandatory_module_refs = &mandatory_prefix_modules;
+
+    let content = format!(
+        r#"//! Node.js v{} built-in modules
+//!
+//! <https://nodejs.org/api/modules.html#built-in-modules>
+
+/// Generated by
+///
+/// `node -p "[...require('module').builtinModules].map(b => JSON.stringify(b)).join(',\n')"`
+///
+/// with `node:` prefixed values moved [BUILTINS_WITH_MANDATORY_NODE_PREFIX].
+{}
+
+/// <https://nodejs.org/api/modules.html#built-in-modules-with-mandatory-node-prefix>
+{}
+
+/// Is `specifier` a node.js built-in module?
+{}
+"#,
+        node_major_version,
+        quote! { pub static BUILTINS: &[&str] = &[#(#regular_module_refs,)*]; },
+        quote! { pub static BUILTINS_WITH_MANDATORY_NODE_PREFIX: &[&str] = &[#(#mandatory_module_refs),*]; },
+        quote! {
+            pub fn is_nodejs_builtin_module(specifier: &str) -> bool {
+                if let Some(stripped) = specifier.strip_prefix("node:") {
+                    return BUILTINS.contains(&stripped)
+                        || BUILTINS_WITH_MANDATORY_NODE_PREFIX.contains(&stripped);
+                }
+                BUILTINS.contains(&specifier)
+            }
+        }
+    );
+
+    // Write to src/lib.rs
+    fs::write("src/lib.rs", content).expect("Failed to write src/lib.rs");
+
+    println!("✓ Updated built-in modules for Node.js v{node_version}");
+    println!("  - {} regular modules", regular_modules.len());
+    println!(
+        "  - {} mandatory prefix modules",
+        mandatory_prefix_modules.len()
+    );
+}