@utoo/pack 1.1.1 → 1.1.2-alpha.2

package/README.md

@@ -0,0 +1,126 @@
+# @utoo/pack
+
+> 🌖 High-performance bundler core for the Utoo toolchain, powered by [Turbopack](https://turbo.build/pack).
+
+`@utoo/pack` is the engine behind the Utoo build system. It leverages the incremental computation power of Turbopack and the performance of Rust to provide a lightning-fast development and build experience.
+
+## ✨ Key Features
+
+- ⚡ **Extreme Performance**: Core bundling logic implemented in Rust via NAPI-RS.
+- 🛠️ **Turbopack Powered**: Built on top of the same engine that powers Next.js Turbopack.
+- 🔌 **Webpack Compatibility**: Support for consuming `webpack.config.js` to simplify migration from Webpack.
+- 📦 **Modern Web Support**: Native support for TypeScript, JSX, CSS Modules, Less, Sass, and more.
+- 🔧 **Extensible Architecture**: Support for custom loaders, plugins, and flexible configuration.
+- 🔄 **Fast HMR**: Instant updates during development with optimized Hot Module Replacement.
+
+## ✨ Supported Features
+
+`@utoo/pack` aims for high compatibility with the Webpack ecosystem while providing superior performance.
+
+- **Entry**: Supports `name`, `import`, and `filename` templates.
+- **Module Rules**: Support for most mainstream Webpack loaders via `loader-runner`.
+- **Resolve**: Full support for `alias` and `extensions`.
+- **Styles**: Built-in support for Less, Sass, PostCSS, CSS Modules, and LightningCSS.
+- **Optimization**: Minification, Tree Shaking, Module Concatenation, and more.
+- **Frameworks**: Optimized for React (including `styled-jsx`, `emotion`, `styled-components`).
+- **Tools**: Integrated Bundle Analyzer and Tracing Logs.
+
+> [!TIP]
+> For a detailed status of all features, see the [Features List](./docs/features-list.md).
+
+## 📦 Installation
+
+```bash
+npm install @utoo/pack
+```
+
+## 🚀 Quick Start
+
+### Programmatic API
+
+You can use `@utoo/pack` directly in your Node.js scripts:
+
+```javascript
+const { build, dev } = require('@utoo/pack');
+
+// Production build
+async function runBuild() {
+  await build({
+    root: process.cwd(),
+    config: {
+      entry: [
+        {
+          key: 'main',
+          value: './src/index.ts'
+        }
+      ],
+      mode: 'production'
+    }
+  });
+}
+
+// Development mode with HMR
+async function startDev() {
+  const server = await dev({
+    root: process.cwd(),
+    config: {
+      mode: 'development'
+    }
+  });
+}
+```
+
+## 🔌 Webpack Compatibility Mode
+
+`@utoo/pack` provides a partial compatibility layer for Webpack. This allows you to use your existing `webpack.config.js` with minimal changes.
+
+### Usage via CLI
+
+```bash
+utoo-pack build --webpack
+```
+
+### Programmatic Usage
+
+```javascript
+const { build } = require('@utoo/pack');
+const { compatOptionsFromWebpack } = require('@utoo/pack/webpack-compat');
+const webpackConfig = require('./webpack.config.js');
+
+async function run() {
+  const options = compatOptionsFromWebpack(webpackConfig);
+  await build(options);
+}
+```
+
+> [!NOTE]
+> Not all Webpack features and plugins are supported. Check the [Features List](./docs/features-list.md) for details on supported configuration options.
+
+## ⚙️ Configuration
+
+The bundler can be configured via a `project_options.json` or through the programmatic API. Key configuration areas include:
+
+- **`entry`**: Define your application entry points.
+- **`define`**: Build-time variable replacement.
+- **`externals`**: Exclude specific dependencies from the bundle.
+- **`mode`**: `development` or `production`.
+
+For a full list of options, see the [Configuration Schema](./config_schema.json).
+
+## 🛠️ Development
+
+### Prerequisites
+
+- **Rust**: Nightly toolchain (see [rust-toolchain.toml](../../rust-toolchain.toml)).
+- **Node.js**: Version 20 or higher.
+
+### Building from Source
+
+```bash
+# Build Rust bindings and TypeScript modules
+npm run build
+```
+
+## 📄 License
+
+[MIT](./LICENSE)

package/cjs/types.d.ts

@@ -98,6 +98,21 @@ export interface ExternalAdvanced {
     script?: string;
 }
 export type ExternalConfig = string | ExternalAdvanced;
+/**
+ * Provider configuration for automatic module imports.
+ * Similar to webpack's ProvidePlugin.
+ *
+ * @example
+ * ```ts
+ * provider: {
+ *   // Provides `$` as `import $ from 'jquery'`
+ *   $: 'jquery',
+ *   // Provides `Buffer` as `import { Buffer } from 'buffer'`
+ *   Buffer: ['buffer', 'Buffer'],
+ * }
+ * ```
+ */
+export type ProviderConfig = Record<string, string | [string, string]>;
 export interface ConfigComplete {
     entry: EntryOptions[];
     mode?: "production" | "development";
@@ -119,6 +134,7 @@ export interface ConfigComplete {
     target?: string;
     sourceMaps?: boolean;
     define?: Record<string, string>;
+    provider?: ProviderConfig;
     optimization?: {
         moduleIds?: "named" | "deterministic";
         minify?: boolean;

package/cjs/webpackCompat.js

@@ -29,6 +29,7 @@ function compatOptionsFromWebpack(webpackConfig, projectPath, rootPath) {
             sourceMaps: compatSourceMaps(devtool),
             optimization: compatOptimization(optimization),
             define: compatFromWebpackPlugin(plugins, compatDefine),
+            provider: compatFromWebpackPlugin(plugins, compatProvider),
             stats: compatStats(stats),
         },
         buildId: webpackConfig.name,
@@ -129,6 +130,31 @@ function compatDefine(maybeWebpackPluginInstance) {
     }
     return processedDefinitions;
 }
+compatProvider.pluginName = "ProvidePlugin";
+function compatProvider(maybeWebpackPluginInstance) {
+    const definitions = maybeWebpackPluginInstance === null || maybeWebpackPluginInstance === void 0 ? void 0 : maybeWebpackPluginInstance.definitions;
+    if (!definitions || typeof definitions !== "object") {
+        return undefined;
+    }
+    const provider = {};
+    for (const [key, value] of Object.entries(definitions)) {
+        if (typeof value === "string") {
+            // Simple module import: { $: 'jquery' }
+            provider[key] = value;
+        }
+        else if (Array.isArray(value)) {
+            if (value.length === 1) {
+                // e.g. { process: ['process/browser'] } for default import
+                provider[key] = value[0];
+            }
+            else if (value.length >= 2) {
+                // Named export import: { Buffer: ['buffer', 'Buffer'] }
+                provider[key] = [value[0], value[1]];
+            }
+        }
+    }
+    return Object.keys(provider).length > 0 ? provider : undefined;
+}
 function compatExternals(webpackExternals) {
     if (!webpackExternals) {
         return undefined;

package/esm/types.d.ts

@@ -98,6 +98,21 @@ export interface ExternalAdvanced {
     script?: string;
 }
 export type ExternalConfig = string | ExternalAdvanced;
+/**
+ * Provider configuration for automatic module imports.
+ * Similar to webpack's ProvidePlugin.
+ *
+ * @example
+ * ```ts
+ * provider: {
+ *   // Provides `$` as `import $ from 'jquery'`
+ *   $: 'jquery',
+ *   // Provides `Buffer` as `import { Buffer } from 'buffer'`
+ *   Buffer: ['buffer', 'Buffer'],
+ * }
+ * ```
+ */
+export type ProviderConfig = Record<string, string | [string, string]>;
 export interface ConfigComplete {
     entry: EntryOptions[];
     mode?: "production" | "development";
@@ -119,6 +134,7 @@ export interface ConfigComplete {
     target?: string;
     sourceMaps?: boolean;
     define?: Record<string, string>;
+    provider?: ProviderConfig;
     optimization?: {
         moduleIds?: "named" | "deterministic";
         minify?: boolean;

package/esm/webpackCompat.js

@@ -22,6 +22,7 @@ export function compatOptionsFromWebpack(webpackConfig, projectPath, rootPath) {
             sourceMaps: compatSourceMaps(devtool),
             optimization: compatOptimization(optimization),
             define: compatFromWebpackPlugin(plugins, compatDefine),
+            provider: compatFromWebpackPlugin(plugins, compatProvider),
             stats: compatStats(stats),
         },
         buildId: webpackConfig.name,
@@ -122,6 +123,31 @@ function compatDefine(maybeWebpackPluginInstance) {
     }
     return processedDefinitions;
 }
+compatProvider.pluginName = "ProvidePlugin";
+function compatProvider(maybeWebpackPluginInstance) {
+    const definitions = maybeWebpackPluginInstance === null || maybeWebpackPluginInstance === void 0 ? void 0 : maybeWebpackPluginInstance.definitions;
+    if (!definitions || typeof definitions !== "object") {
+        return undefined;
+    }
+    const provider = {};
+    for (const [key, value] of Object.entries(definitions)) {
+        if (typeof value === "string") {
+            // Simple module import: { $: 'jquery' }
+            provider[key] = value;
+        }
+        else if (Array.isArray(value)) {
+            if (value.length === 1) {
+                // e.g. { process: ['process/browser'] } for default import
+                provider[key] = value[0];
+            }
+            else if (value.length >= 2) {
+                // Named export import: { Buffer: ['buffer', 'Buffer'] }
+                provider[key] = [value[0], value[1]];
+            }
+        }
+    }
+    return Object.keys(provider).length > 0 ? provider : undefined;
+}
 function compatExternals(webpackExternals) {
     if (!webpackExternals) {
         return undefined;

package/package.json

@@ -1,10 +1,12 @@
 {
   "name": "@utoo/pack",
-  "version": "1.1.1",
+  "version": "1.1.2-alpha.2",
   "main": "cjs/index.js",
   "module": "esm/index.js",
+  "types": "esm/index.d.ts",
   "exports": {
     ".": {
+      "types": "./esm/index.d.ts",
       "import": "./esm/index.js",
       "require": "./cjs/index.js"
     },
@@ -72,25 +74,26 @@
     "node": ">= 20"
   },
   "scripts": {
-    "pretsc": "npm run build --workspace @utoo/pack-shared",
+    "build": "npm run build:binding && npm run build:cjs && npm run build:esm",
+    "build:js": "npm run build:cjs && npm run build:esm",
     "build:cjs": "rm -rf cjs && tsc -p ./tsconfig.json --module commonjs --outDir cjs && cp src/*.d.ts cjs/",
     "build:esm": "rm -rf esm && tsc -p ./tsconfig.json --module esnext --outDir esm && cp src/*.d.ts esm/",
-    "build:local": "npm run build:binding:local && npm run pretsc && npm run build:cjs && npm run build:esm && cp src/*.node cjs/ && cp src/*.node esm/",
+    "build:local": "npm run build:binding:local && npx turbo run build --filter=@utoo/pack-shared && npm run build:cjs && npm run build:esm && cp src/*.node cjs/ && cp src/*.node esm/",
     "artifacts": "napi artifacts --dir ./src --dist npm",
     "build:binding": "napi build src --platform --release -p pack-napi --cargo-cwd ../../ --cargo-name pack_napi --features plugin --js binding.js --dts binding.d.ts",
     "build:binding:local": "napi build src --platform --profile release-local -p pack-napi --cargo-cwd ../../ --cargo-name pack_napi --features plugin --js binding.js --dts binding.d.ts",
-    "prepublishOnly": "npm run pretsc && npm run build:esm && npm run build:cjs && napi prepublish -t npm --skip-gh-release",
+    "prepublishOnly": "turbo run build:js --filter=@utoo/pack && napi prepublish -t npm --skip-gh-release",
     "version": "napi version",
     "generate-features-list": "node ./scripts/generate-feature-list.js"
   },
   "repository": "git@github.com:utooland/utoo.git",
   "optionalDependencies": {
-    "@utoo/pack-darwin-arm64": "1.1.1",
-    "@utoo/pack-darwin-x64": "1.1.1",
-    "@utoo/pack-linux-arm64-gnu": "1.1.1",
-    "@utoo/pack-linux-arm64-musl": "1.1.1",
-    "@utoo/pack-linux-x64-gnu": "1.1.1",
-    "@utoo/pack-linux-x64-musl": "1.1.1",
-    "@utoo/pack-win32-x64-msvc": "1.1.1"
+    "@utoo/pack-darwin-arm64": "1.1.2-alpha.2",
+    "@utoo/pack-darwin-x64": "1.1.2-alpha.2",
+    "@utoo/pack-linux-arm64-gnu": "1.1.2-alpha.2",
+    "@utoo/pack-linux-arm64-musl": "1.1.2-alpha.2",
+    "@utoo/pack-linux-x64-gnu": "1.1.2-alpha.2",
+    "@utoo/pack-linux-x64-musl": "1.1.2-alpha.2",
+    "@utoo/pack-win32-x64-msvc": "1.1.2-alpha.2"
   }
 }