@rspack/cli 1.0.13 → 1.1.0-beta.0

package/dist/utils/crossImport.d.ts

@@ -1,5 +1,5 @@
 /**
- * Dynamically import files. It will make sure it's not being compiled away by TS/Rollup.
+ * Dynamically import files. It will make sure it's not being compiled away by TS/Rslib.
  */
 export declare const dynamicImport: Function;
 declare const crossImport: <T = any>(path: string, cwd?: string) => Promise<T>;

package/dist/utils/options.d.ts

@@ -1,5 +1,5 @@
 import type yargs from "yargs";
-export declare const commonOptions: (yargs: yargs.Argv<{}>) => yargs.Argv<yargs.Omit<{}, "entry" | "devtool" | "mode" | "watch" | "env" | "output-path" | "config" | "node-env" | "configName"> & yargs.InferredOptionTypes<{
+export declare const commonOptions: (yargs: yargs.Argv) => yargs.Argv<yargs.Omit<{}, "entry" | "devtool" | "mode" | "watch" | "env" | "output-path" | "config" | "node-env" | "configName"> & yargs.InferredOptionTypes<{
     config: {
         g: boolean;
         type: "string";
@@ -48,7 +48,7 @@ export declare const commonOptions: (yargs: yargs.Argv<{}>) => yargs.Argv<yargs.
         describe: string;
     };
 }>>;
-export declare const previewOptions: (yargs: yargs.Argv<{}>) => yargs.Argv<yargs.Omit<{
+export declare const previewOptions: (yargs: yargs.Argv) => yargs.Argv<yargs.Omit<{
     dir: string | undefined;
 }, "port" | "host" | "open" | "server" | "publicPath" | "config" | "configName"> & yargs.InferredOptionTypes<{
     publicPath: {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rspack/cli",
-  "version": "1.0.13",
+  "version": "1.1.0-beta.0",
   "description": "CLI for rspack",
   "homepage": "https://rspack.dev",
   "bugs": "https://github.com/web-infra-dev/rspack/issues",
@@ -11,13 +11,16 @@
   },
   "license": "MIT",
   "exports": {
-    ".": "./dist/index.js",
+    ".": {
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.js"
+    },
     "./package.json": "./package.json"
   },
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
   "bin": {
-    "rspack": "./bin/rspack"
+    "rspack": "./bin/rspack.js"
   },
   "files": [
     "bin",
@@ -27,7 +30,7 @@
     "@discoveryjs/json-ext": "^0.5.7",
     "@rspack/dev-server": "1.0.5",
     "colorette": "2.0.19",
-    "exit-hook": "^3.2.0",
+    "exit-hook": "^4.0.0",
     "interpret": "^3.1.1",
     "rechoir": "^0.8.0",
     "semver": "^7.6.2",
@@ -35,6 +38,7 @@
     "yargs": "17.6.2"
   },
   "devDependencies": {
+    "@rslib/core": "0.0.12",
     "@types/interpret": "^1.1.3",
     "@types/rechoir": "^0.6.1",
     "@types/semver": "^7.5.6",
@@ -45,8 +49,8 @@
     "execa": "^5.0.0",
     "internal-ip": "6.2.0",
     "ts-node": "^10.9.2",
-    "typescript": "5.0.2",
-    "@rspack/core": "1.0.13"
+    "typescript": "^5.6.3",
+    "@rspack/core": "1.1.0-beta.0"
   },
   "peerDependencies": {
     "@rspack/core": "^1.0.0-alpha || ^1.x"
@@ -56,8 +60,8 @@
     "provenance": true
   },
   "scripts": {
-    "build": "tsc -b ./tsconfig.build.json",
-    "dev": "tsc -b -w",
+    "build": "rslib build",
+    "dev": "rslib build -w",
     "test": "cross-env jest --colors"
   }
 }

package/bin/rspack

@@ -1,3 +0,0 @@
-#!/usr/bin/env node
-const runCLI = require("../dist/bootstrap").runCLI;
-runCLI(process.argv);

package/dist/bootstrap.d.ts

@@ -1 +0,0 @@
-export declare function runCLI(argv: string[]): Promise<void>;

package/dist/bootstrap.js

@@ -1,9 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.runCLI = void 0;
-const cli_1 = require("./cli");
-async function runCLI(argv) {
-    const cli = new cli_1.RspackCLI();
-    await cli.run(argv);
-}
-exports.runCLI = runCLI;

package/dist/cli.js

@@ -1,257 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.definePlugin = exports.defineConfig = exports.RspackCLI = void 0;
-const node_path_1 = __importDefault(require("node:path"));
-const node_util_1 = __importDefault(require("node:util"));
-const core_1 = require("@rspack/core");
-const rspackCore = __importStar(require("@rspack/core"));
-const semver_1 = __importDefault(require("semver"));
-const yargs_1 = __importDefault(require("yargs"));
-const helpers_1 = require("yargs/helpers");
-const build_1 = require("./commands/build");
-const preview_1 = require("./commands/preview");
-const serve_1 = require("./commands/serve");
-const loadConfig_1 = require("./utils/loadConfig");
-const options_1 = require("./utils/options");
-class RspackCLI {
-    constructor() {
-        this.colors = this.createColors();
-        this.program = (0, yargs_1.default)();
-    }
-    async createCompiler(options, rspackCommand, callback) {
-        process.env.RSPACK_CONFIG_VALIDATE ??= "loose";
-        process.env.WATCHPACK_WATCHER_LIMIT =
-            process.env.WATCHPACK_WATCHER_LIMIT || "20";
-        const nodeEnv = process?.env?.NODE_ENV;
-        const rspackCommandDefaultEnv = rspackCommand === "build" ? "production" : "development";
-        if (typeof options.nodeEnv === "string") {
-            process.env.NODE_ENV = nodeEnv || options.nodeEnv;
-        }
-        else {
-            process.env.NODE_ENV = nodeEnv || rspackCommandDefaultEnv;
-        }
-        let config = await this.loadConfig(options);
-        config = await this.buildConfig(config, options, rspackCommand);
-        const isWatch = Array.isArray(config)
-            ? config.some(i => i.watch)
-            : config.watch;
-        let compiler;
-        try {
-            compiler = (0, core_1.rspack)(config, isWatch ? callback : undefined);
-        }
-        catch (e) {
-            // Aligned with webpack-cli
-            // See: https://github.com/webpack/webpack-cli/blob/eea6adf7d34dfbfd3b5b784ece4a4664834f5a6a/packages/webpack-cli/src/webpack-cli.ts#L2394
-            if (e instanceof core_1.ValidationError) {
-                this.getLogger().error(e.message);
-                process.exit(2);
-            }
-            else if (e instanceof Error) {
-                callback?.(e);
-                return null;
-            }
-            throw e;
-        }
-        return compiler;
-    }
-    createColors(useColor) {
-        const { createColors, isColorSupported } = require("colorette");
-        const shouldUseColor = useColor || isColorSupported;
-        return {
-            ...createColors({ useColor: shouldUseColor }),
-            isColorSupported: shouldUseColor
-        };
-    }
-    getLogger() {
-        return {
-            error: val => console.error(`[rspack-cli] ${this.colors.red(node_util_1.default.format(val))}`),
-            warn: val => console.warn(`[rspack-cli] ${this.colors.yellow(val)}`),
-            info: val => console.info(`[rspack-cli] ${this.colors.cyan(val)}`),
-            success: val => console.log(`[rspack-cli] ${this.colors.green(val)}`),
-            log: val => console.log(`[rspack-cli] ${val}`),
-            raw: val => console.log(val)
-        };
-    }
-    async run(argv) {
-        if (semver_1.default.lt(semver_1.default.clean(process.version), "14.0.0")) {
-            this.getLogger().warn(`Minimum recommended Node.js version is 14.0.0, current version is ${process.version}`);
-        }
-        this.program.showHelpOnFail(false);
-        this.program.usage("[options]");
-        this.program.scriptName("rspack");
-        this.program.strictCommands(true).strict(true);
-        this.program.middleware(options_1.normalizeEnv);
-        this.registerCommands();
-        await this.program.parseAsync((0, helpers_1.hideBin)(argv));
-    }
-    async registerCommands() {
-        const builtinCommands = [
-            new build_1.BuildCommand(),
-            new serve_1.ServeCommand(),
-            new preview_1.PreviewCommand()
-        ];
-        for (const command of builtinCommands) {
-            command.apply(this);
-        }
-    }
-    async buildConfig(item, options, command) {
-        const isBuild = command === "build";
-        const isServe = command === "serve";
-        const commandDefaultEnv = isBuild
-            ? "production"
-            : "development";
-        const internalBuildConfig = async (item) => {
-            if (options.entry) {
-                item.entry = {
-                    main: options.entry.map(x => node_path_1.default.resolve(process.cwd(), x))[0] // Fix me when entry supports array
-                };
-            }
-            // to set output.path
-            item.output = item.output || {};
-            if (options["output-path"]) {
-                item.output.path = node_path_1.default.resolve(process.cwd(), options["output-path"]);
-            }
-            if (options.analyze) {
-                const { BundleAnalyzerPlugin } = await import("webpack-bundle-analyzer");
-                (item.plugins ??= []).push({
-                    name: "rspack-bundle-analyzer",
-                    apply(compiler) {
-                        new BundleAnalyzerPlugin({
-                            generateStatsFile: true
-                        }).apply(compiler);
-                    }
-                });
-            }
-            if (options.profile) {
-                item.profile = true;
-            }
-            if (process.env.RSPACK_PROFILE) {
-                const { applyProfile } = await import("./utils/profile.js");
-                await applyProfile(process.env.RSPACK_PROFILE, item);
-            }
-            // cli --watch overrides the watch config
-            if (options.watch) {
-                item.watch = options.watch;
-            }
-            // auto set default mode if user config don't set it
-            if (!item.mode) {
-                item.mode = commandDefaultEnv ?? "none";
-            }
-            // user parameters always has highest priority than default mode and config mode
-            if (options.mode) {
-                item.mode = options.mode;
-            }
-            // false is also a valid value for sourcemap, so don't override it
-            if (typeof item.devtool === "undefined") {
-                item.devtool = isBuild ? "source-map" : "cheap-module-source-map";
-            }
-            if (isServe) {
-                const installed = (item.plugins ||= []).find(item => item instanceof rspackCore.ProgressPlugin);
-                if (!installed) {
-                    (item.plugins ??= []).push(new rspackCore.ProgressPlugin());
-                }
-            }
-            if (typeof item.stats === "undefined") {
-                item.stats = { preset: "errors-warnings", timings: true };
-            }
-            else if (typeof item.stats === "boolean") {
-                item.stats = item.stats ? { preset: "normal" } : { preset: "none" };
-            }
-            else if (typeof item.stats === "string") {
-                item.stats = {
-                    preset: item.stats
-                };
-            }
-            if (this.colors.isColorSupported &&
-                typeof item.stats.colors === "undefined") {
-                item.stats.colors = true;
-            }
-            return item;
-        };
-        if (Array.isArray(item)) {
-            return Promise.all(item.map(internalBuildConfig));
-        }
-        return internalBuildConfig(item);
-    }
-    async loadConfig(options) {
-        let loadedConfig = (await (0, loadConfig_1.loadRspackConfig)(options));
-        if (options.configName) {
-            const notFoundConfigNames = [];
-            loadedConfig = options.configName.map((configName) => {
-                let found;
-                if (Array.isArray(loadedConfig)) {
-                    found = loadedConfig.find(options => options.name === configName);
-                }
-                else {
-                    found =
-                        loadedConfig.name === configName
-                            ? loadedConfig
-                            : undefined;
-                }
-                if (!found) {
-                    notFoundConfigNames.push(configName);
-                }
-                // WARNING: if config is not found, the program will exit
-                // so assert here is okay to avoid runtime filtering
-                return found;
-            });
-            if (notFoundConfigNames.length > 0) {
-                this.getLogger().error(notFoundConfigNames
-                    .map(configName => `Configuration with the name "${configName}" was not found.`)
-                    .join(" "));
-                process.exit(2);
-            }
-        }
-        if (typeof loadedConfig === "function") {
-            loadedConfig = loadedConfig(options.argv?.env, options.argv);
-            // if return promise we should await its result
-            if (typeof loadedConfig.then === "function") {
-                loadedConfig = await loadedConfig;
-            }
-        }
-        return loadedConfig;
-    }
-    isMultipleCompiler(compiler) {
-        return Boolean(compiler.compilers);
-    }
-    isWatch(compiler) {
-        return Boolean(this.isMultipleCompiler(compiler)
-            ? compiler.compilers.some(compiler => compiler.options.watch)
-            : compiler.options.watch);
-    }
-}
-exports.RspackCLI = RspackCLI;
-function defineConfig(config) {
-    return config;
-}
-exports.defineConfig = defineConfig;
-function definePlugin(plugin) {
-    return plugin;
-}
-exports.definePlugin = definePlugin;

package/dist/commands/build.js

@@ -1,132 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.BuildCommand = void 0;
-const fs = __importStar(require("node:fs"));
-const options_1 = require("../utils/options");
-class BuildCommand {
-    async apply(cli) {
-        cli.program.command(["build", "$0", "bundle", "b"], "run the rspack build", yargs => (0, options_1.commonOptions)(yargs).options({
-            analyze: {
-                type: "boolean",
-                default: false,
-                describe: "analyze"
-            },
-            json: {
-                describe: "emit stats json"
-            },
-            profile: {
-                type: "boolean",
-                default: false,
-                describe: "capture timing information for each module"
-            }
-        }), async (options) => {
-            const env = (0, options_1.ensureEnvObject)(options);
-            if (options.watch) {
-                (0, options_1.setBuiltinEnvArg)(env, "WATCH", true);
-            }
-            else {
-                (0, options_1.setBuiltinEnvArg)(env, "BUNDLE", true);
-                (0, options_1.setBuiltinEnvArg)(env, "BUILD", true);
-            }
-            const logger = cli.getLogger();
-            let createJsonStringifyStream;
-            if (options.json) {
-                const jsonExt = await import("@discoveryjs/json-ext");
-                createJsonStringifyStream = jsonExt.default.stringifyStream;
-            }
-            const errorHandler = (error, stats) => {
-                if (error) {
-                    logger.error(error);
-                    process.exit(2);
-                }
-                if (stats?.hasErrors()) {
-                    process.exitCode = 1;
-                }
-                if (!compiler || !stats) {
-                    return;
-                }
-                const statsOptions = cli.isMultipleCompiler(compiler)
-                    ? {
-                        children: compiler.compilers.map(compiler => compiler.options ? compiler.options.stats : undefined)
-                    }
-                    : compiler.options
-                        ? compiler.options.stats
-                        : undefined;
-                if (options.json && createJsonStringifyStream) {
-                    const handleWriteError = (error) => {
-                        logger.error(error);
-                        process.exit(2);
-                    };
-                    if (options.json === true) {
-                        createJsonStringifyStream(stats.toJson(statsOptions))
-                            .on("error", handleWriteError)
-                            .pipe(process.stdout)
-                            .on("error", handleWriteError)
-                            .on("close", () => process.stdout.write("\n"));
-                    }
-                    else if (typeof options.json === "string") {
-                        createJsonStringifyStream(stats.toJson(statsOptions))
-                            .on("error", handleWriteError)
-                            .pipe(fs.createWriteStream(options.json))
-                            .on("error", handleWriteError)
-                            // Use stderr to logging
-                            .on("close", () => {
-                            process.stderr.write(`[rspack-cli] ${cli.colors.green(`stats are successfully stored as json to ${options.json}`)}\n`);
-                        });
-                    }
-                }
-                else {
-                    const printedStats = stats.toString(statsOptions);
-                    // Avoid extra empty line when `stats: 'none'`
-                    if (printedStats) {
-                        logger.raw(printedStats);
-                    }
-                }
-            };
-            const rspackOptions = { ...options, argv: { ...options } };
-            const compiler = await cli.createCompiler(rspackOptions, "build", errorHandler);
-            if (!compiler || cli.isWatch(compiler)) {
-                return;
-            }
-            compiler.run((error, stats) => {
-                // If there is a compilation error, the close method should not be called,
-                // Otherwise Rspack may generate invalid caches.
-                if (error || stats?.hasErrors()) {
-                    errorHandler(error, stats);
-                }
-                else {
-                    compiler.close(closeErr => {
-                        if (closeErr) {
-                            logger.error(closeErr);
-                        }
-                        errorHandler(error, stats);
-                    });
-                }
-            });
-        });
-    }
-}
-exports.BuildCommand = BuildCommand;

package/dist/commands/preview.js

@@ -1,73 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.PreviewCommand = void 0;
-const node_path_1 = __importDefault(require("node:path"));
-const core_1 = require("@rspack/core");
-const options_1 = require("../utils/options");
-const defaultRoot = "dist";
-class PreviewCommand {
-    async apply(cli) {
-        cli.program.command(["preview [dir]", "preview", "p"], "run the rspack server for build output", options_1.previewOptions, async (options) => {
-            // config、configName are necessary for loadConfig
-            const rspackOptions = {
-                config: options.config,
-                configName: options.configName,
-                argv: {
-                    ...options
-                }
-            };
-            const { RspackDevServer } = await import("@rspack/dev-server");
-            let config = await cli.loadConfig(rspackOptions);
-            config = await getPreviewConfig(config, options);
-            if (!Array.isArray(config)) {
-                config = [config];
-            }
-            config = config;
-            // find the possible devServer config
-            config = config.find(item => item.devServer) || config[0];
-            const devServerOptions = config.devServer;
-            try {
-                const compiler = (0, core_1.rspack)({ entry: {} });
-                if (!compiler)
-                    return;
-                const server = new RspackDevServer(devServerOptions, compiler);
-                await server.start();
-            }
-            catch (error) {
-                const logger = cli.getLogger();
-                logger.error(error);
-                process.exit(2);
-            }
-        });
-    }
-}
-exports.PreviewCommand = PreviewCommand;
-// get the devServerOptions from the config
-async function getPreviewConfig(item, options) {
-    const internalPreviewConfig = async (item) => {
-        // all of the options that a preview static server needs(maybe not all)
-        item.devServer = {
-            static: {
-                directory: options.dir
-                    ? node_path_1.default.join(item.context ?? process.cwd(), options.dir)
-                    : item.output?.path ??
-                        node_path_1.default.join(item.context ?? process.cwd(), defaultRoot),
-                publicPath: options.publicPath ?? "/"
-            },
-            port: options.port ?? 8080,
-            proxy: item.devServer?.proxy,
-            host: options.host ?? item.devServer?.host,
-            open: options.open ?? item.devServer?.open,
-            server: options.server ?? item.devServer?.server,
-            historyApiFallback: item.devServer?.historyApiFallback
-        };
-        return item;
-    };
-    if (Array.isArray(item)) {
-        return Promise.all(item.map(internalPreviewConfig));
-    }
-    return internalPreviewConfig(item);
-}