@rsbuild/core 1.0.17 → 1.0.18

package/dist/index.cjs

@@ -3734,7 +3734,7 @@ function pick(obj, keys) {
     {}
   );
 }
-var import_node_path4, import_deepmerge, import_picocolors3, rspackMinVersion, getNodeEnv, setNodeEnv, isFunction, isObject, isPlainObject, castArray, cloneDeep, compareSemver, isSatisfyRspackVersion, removeLeadingSlash, removeTailingSlash, addTrailingSlash, formatPublicPath, getPublicPathFromChain, getPublicPathFromCompiler, urlJoin, canParse, ensureAssetPrefix, applyToCompiler, upperFirst, isURL, createVirtualModule, isMultiCompiler, camelCase, prettyTime;
+var import_node_path4, import_deepmerge, import_picocolors3, rspackMinVersion, getNodeEnv, setNodeEnv, isFunction, isObject, isPlainObject, castArray, cloneDeep, compareSemver, isSatisfyRspackVersion, removeLeadingSlash, removeTailingSlash, addTrailingSlash, formatPublicPath, getPublicPathFromChain, getPublicPathFromCompiler, urlJoin, canParse, ensureAssetPrefix, applyToCompiler, upperFirst, isURL, createVirtualModule, isMultiCompiler, camelCase, prettyTime, isTTY;
 var init_helpers = __esm({
   "src/helpers/index.ts"() {
     "use strict";
@@ -3752,19 +3752,8 @@ var init_helpers = __esm({
     };
     isFunction = (func) => typeof func === "function";
     isObject = (obj) => Object.prototype.toString.call(obj) === "[object Object]";
-    isPlainObject = (o) => {
-      if (isObject(o) === false)
-        return false;
-      const ctor = o.constructor;
-      if (ctor === void 0)
-        return true;
-      const prot = ctor.prototype;
-      if (isObject(prot) === false)
-        return false;
-      if (prot.hasOwnProperty("isPrototypeOf") === false) {
-        return false;
-      }
-      return true;
+    isPlainObject = (obj) => {
+      return obj !== null && typeof obj === "object" && Object.getPrototypeOf(obj) === Object.prototype;
     };
     castArray = (arr) => {
       if (arr === void 0) {
@@ -3891,6 +3880,9 @@ var init_helpers = __esm({
       const minutes = seconds / 60;
       return `${format(minutes.toFixed(2))} m`;
     };
+    isTTY = (type = "stdout") => {
+      return (type === "stdin" ? process.stdin.isTTY : process.stdout.isTTY) && !process.env.CI;
+    };
   }
 });
 
@@ -3971,13 +3963,14 @@ var init_restart = __esm({
     import_node_path5 = __toESM(require("path"));
     import_picocolors4 = __toESM(require("../compiled/picocolors/index.js"));
     init_init();
+    init_helpers();
     init_logger();
     cleaners = [];
     onBeforeRestartServer = (cleaner) => {
       cleaners.push(cleaner);
     };
     clearConsole = () => {
-      if (process.stdout.isTTY && !process.env.DEBUG) {
+      if (isTTY() && !process.env.DEBUG) {
         process.stdout.write("\x1B[H\x1B[2J");
       }
     };
@@ -4302,7 +4295,8 @@ var init_config = __esm({
         svg: DEFAULT_DATA_URL_SIZE,
         font: DEFAULT_DATA_URL_SIZE,
         image: DEFAULT_DATA_URL_SIZE,
-        media: DEFAULT_DATA_URL_SIZE
+        media: DEFAULT_DATA_URL_SIZE,
+        assets: DEFAULT_DATA_URL_SIZE
       },
       legalComments: "linked",
       injectStyles: false,
@@ -5184,14 +5178,7 @@ function createPluginManager() {
         continue;
       }
       validatePlugin(newPlugin);
-      const existPlugin = plugins.find(
-        (item) => item.instance.name === newPlugin.name && item.environment === environment
-      );
-      if (existPlugin) {
-        import_rslog.logger.warn(
-          `Rsbuild plugin "${newPlugin.name}" registered multiple times.`
-        );
-      } else if (before) {
+      if (before) {
         const index = plugins.findIndex(
           (item) => item.instance.name === before
         );
@@ -6042,7 +6029,7 @@ async function createContext(options, userConfig, bundlerType) {
   const rsbuildConfig = await withDefaultConfig(rootPath, userConfig);
   const cachePath = (0, import_node_path10.join)(rootPath, "node_modules", ".cache");
   return {
-    version: "1.0.17",
+    version: "1.0.18",
     rootPath,
     distPath: "",
     cachePath,
@@ -6375,7 +6362,7 @@ var init_configChain = __esm({
         JS_DATA_URI: "js-data-uri",
         /** Rule for ts */
         TS: "ts",
-        /** Rule for css */
+        /** Rule for CSS */
         CSS: "css",
         /** Rule for less */
         LESS: "less",
@@ -7025,9 +7012,10 @@ var init_cliShortcuts = __esm({
     "use strict";
     import_node_readline = __toESM(require("readline"));
     import_picocolors10 = __toESM(require("../compiled/picocolors/index.js"));
+    init_helpers();
     init_logger();
     init_restart();
-    isCliShortcutsEnabled = (devConfig) => devConfig.cliShortcuts && process.stdin.isTTY && !process.env.CI;
+    isCliShortcutsEnabled = (devConfig) => devConfig.cliShortcuts && isTTY("stdin");
   }
 });
 
@@ -10374,6 +10362,19 @@ var init_asset = __esm({
           if (!emitAssets) {
             chain.module.generator.merge({ "asset/resource": { emit: false } });
           }
+          const { assetsInclude } = config.source;
+          if (assetsInclude) {
+            const { dataUriLimit } = config.output;
+            const rule = chain.module.rule("additional-assets").test(assetsInclude);
+            const maxSize = typeof dataUriLimit === "number" ? dataUriLimit : dataUriLimit.assets;
+            chainStaticAssetRule({
+              emit: emitAssets,
+              rule,
+              maxSize,
+              filename: assetsFilename,
+              assetType: "additional"
+            });
+          }
         });
       }
     });
@@ -13609,7 +13610,7 @@ var init_init = __esm({
 
 // src/cli/commands.ts
 function runCli() {
-  program.name("rsbuild").usage("<command> [options]").version("1.0.17");
+  program.name("rsbuild").usage("<command> [options]").version("1.0.18");
   const devCommand = program.command("dev");
   const buildCommand = program.command("build");
   const previewCommand = program.command("preview");
@@ -13718,7 +13719,7 @@ function prepareCli() {
   if (!npm_execpath || npm_execpath.includes("npx-cli.js") || npm_execpath.includes(".bun")) {
     console.log();
   }
-  import_rslog.logger.greet(`  ${`Rsbuild v${"1.0.17"}`}
+  import_rslog.logger.greet(`  ${`Rsbuild v${"1.0.18"}`}
 `);
 }
 var import_node_module;
@@ -13747,6 +13748,7 @@ __export(internal_exports, {
   initHooks: () => initHooks,
   initPlugins: () => initPlugins,
   initRsbuildConfig: () => initRsbuildConfig,
+  isPlainObject: () => isPlainObject,
   modifyBundlerChain: () => modifyBundlerChain,
   onCompileDone: () => onCompileDone,
   outputInspectConfigFiles: () => outputInspectConfigFiles,
@@ -13804,7 +13806,7 @@ init_logger();
 init_mergeConfig();
 init_helpers();
 init_constants();
-var version = "1.0.17";
+var version = "1.0.18";
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   PLUGIN_CSS_NAME,

package/dist/index.js

@@ -3773,7 +3773,7 @@ function pick(obj, keys) {
     {}
   );
 }
-var import_deepmerge, rspackMinVersion, getNodeEnv, setNodeEnv, isFunction, isObject, isPlainObject, castArray, cloneDeep, compareSemver, isSatisfyRspackVersion, removeLeadingSlash, removeTailingSlash, addTrailingSlash, formatPublicPath, getPublicPathFromChain, getPublicPathFromCompiler, urlJoin, canParse, ensureAssetPrefix, applyToCompiler, upperFirst, isURL, createVirtualModule, isMultiCompiler, camelCase, prettyTime;
+var import_deepmerge, rspackMinVersion, getNodeEnv, setNodeEnv, isFunction, isObject, isPlainObject, castArray, cloneDeep, compareSemver, isSatisfyRspackVersion, removeLeadingSlash, removeTailingSlash, addTrailingSlash, formatPublicPath, getPublicPathFromChain, getPublicPathFromCompiler, urlJoin, canParse, ensureAssetPrefix, applyToCompiler, upperFirst, isURL, createVirtualModule, isMultiCompiler, camelCase, prettyTime, isTTY;
 var init_helpers = __esm({
   "src/helpers/index.ts"() {
     "use strict";
@@ -3790,19 +3790,8 @@ var init_helpers = __esm({
     };
     isFunction = (func) => typeof func === "function";
     isObject = (obj) => Object.prototype.toString.call(obj) === "[object Object]";
-    isPlainObject = (o) => {
-      if (isObject(o) === false)
-        return false;
-      const ctor = o.constructor;
-      if (ctor === void 0)
-        return true;
-      const prot = ctor.prototype;
-      if (isObject(prot) === false)
-        return false;
-      if (prot.hasOwnProperty("isPrototypeOf") === false) {
-        return false;
-      }
-      return true;
+    isPlainObject = (obj) => {
+      return obj !== null && typeof obj === "object" && Object.getPrototypeOf(obj) === Object.prototype;
     };
     castArray = (arr) => {
       if (arr === void 0) {
@@ -3929,6 +3918,9 @@ var init_helpers = __esm({
       const minutes = seconds / 60;
       return `${format(minutes.toFixed(2))} m`;
     };
+    isTTY = (type = "stdout") => {
+      return (type === "stdin" ? process.stdin.isTTY : process.stdout.isTTY) && !process.env.CI;
+    };
   }
 });
 
@@ -4011,13 +4003,14 @@ var init_restart = __esm({
     "use strict";
     init_esm();
     init_init();
+    init_helpers();
     init_logger();
     cleaners = [];
     onBeforeRestartServer = (cleaner) => {
       cleaners.push(cleaner);
     };
     clearConsole = () => {
-      if (process.stdout.isTTY && !process.env.DEBUG) {
+      if (isTTY() && !process.env.DEBUG) {
         process.stdout.write("\x1B[H\x1B[2J");
       }
     };
@@ -4343,7 +4336,8 @@ var init_config = __esm({
         svg: DEFAULT_DATA_URL_SIZE,
         font: DEFAULT_DATA_URL_SIZE,
         image: DEFAULT_DATA_URL_SIZE,
-        media: DEFAULT_DATA_URL_SIZE
+        media: DEFAULT_DATA_URL_SIZE,
+        assets: DEFAULT_DATA_URL_SIZE
       },
       legalComments: "linked",
       injectStyles: false,
@@ -5230,14 +5224,7 @@ function createPluginManager() {
         continue;
       }
       validatePlugin(newPlugin);
-      const existPlugin = plugins.find(
-        (item) => item.instance.name === newPlugin.name && item.environment === environment
-      );
-      if (existPlugin) {
-        logger.warn(
-          `Rsbuild plugin "${newPlugin.name}" registered multiple times.`
-        );
-      } else if (before) {
+      if (before) {
         const index = plugins.findIndex(
           (item) => item.instance.name === before
         );
@@ -6091,7 +6078,7 @@ async function createContext(options, userConfig, bundlerType) {
   const rsbuildConfig = await withDefaultConfig(rootPath, userConfig);
   const cachePath = join6(rootPath, "node_modules", ".cache");
   return {
-    version: "1.0.17",
+    version: "1.0.18",
     rootPath,
     distPath: "",
     cachePath,
@@ -6428,7 +6415,7 @@ var init_configChain = __esm({
         JS_DATA_URI: "js-data-uri",
         /** Rule for ts */
         TS: "ts",
-        /** Rule for css */
+        /** Rule for CSS */
         CSS: "css",
         /** Rule for less */
         LESS: "less",
@@ -7080,9 +7067,10 @@ var init_cliShortcuts = __esm({
   "src/server/cliShortcuts.ts"() {
     "use strict";
     init_esm();
+    init_helpers();
     init_logger();
     init_restart();
-    isCliShortcutsEnabled = (devConfig) => devConfig.cliShortcuts && process.stdin.isTTY && !process.env.CI;
+    isCliShortcutsEnabled = (devConfig) => devConfig.cliShortcuts && isTTY("stdin");
   }
 });
 
@@ -10460,6 +10448,19 @@ var init_asset = __esm({
           if (!emitAssets) {
             chain.module.generator.merge({ "asset/resource": { emit: false } });
           }
+          const { assetsInclude } = config.source;
+          if (assetsInclude) {
+            const { dataUriLimit } = config.output;
+            const rule = chain.module.rule("additional-assets").test(assetsInclude);
+            const maxSize = typeof dataUriLimit === "number" ? dataUriLimit : dataUriLimit.assets;
+            chainStaticAssetRule({
+              emit: emitAssets,
+              rule,
+              maxSize,
+              filename: assetsFilename,
+              assetType: "additional"
+            });
+          }
         });
       }
     });
@@ -13727,7 +13728,7 @@ var init_init = __esm({
 
 // src/cli/commands.ts
 function runCli() {
-  program.name("rsbuild").usage("<command> [options]").version("1.0.17");
+  program.name("rsbuild").usage("<command> [options]").version("1.0.18");
   const devCommand = program.command("dev");
   const buildCommand = program.command("build");
   const previewCommand = program.command("preview");
@@ -13838,7 +13839,7 @@ function prepareCli() {
   if (!npm_execpath || npm_execpath.includes("npx-cli.js") || npm_execpath.includes(".bun")) {
     console.log();
   }
-  logger.greet(`  ${`Rsbuild v${"1.0.17"}`}
+  logger.greet(`  ${`Rsbuild v${"1.0.18"}`}
 `);
 }
 var init_prepare = __esm({
@@ -13866,6 +13867,7 @@ __export(internal_exports, {
   initHooks: () => initHooks,
   initPlugins: () => initPlugins,
   initRsbuildConfig: () => initRsbuildConfig,
+  isPlainObject: () => isPlainObject,
   modifyBundlerChain: () => modifyBundlerChain,
   onCompileDone: () => onCompileDone,
   outputInspectConfigFiles: () => outputInspectConfigFiles,
@@ -13909,7 +13911,7 @@ init_mergeConfig();
 init_helpers();
 init_constants();
 import { rspack as rspack10 } from "@rspack/core";
-var version = "1.0.17";
+var version = "1.0.18";
 export {
   PLUGIN_CSS_NAME,
   PLUGIN_SWC_NAME,

package/dist-types/configChain.d.ts

@@ -20,7 +20,7 @@ export declare const CHAIN_ID: {
         readonly JS_DATA_URI: "js-data-uri";
         /** Rule for ts */
         readonly TS: "ts";
-        /** Rule for css */
+        /** Rule for CSS */
         readonly CSS: "css";
         /** Rule for less */
         readonly LESS: "less";

package/dist-types/helpers/index.d.ts

@@ -10,7 +10,7 @@ export declare const setNodeEnv: (env: string) => void;
 export declare const isNil: (o: unknown) => o is undefined | null;
 export declare const isFunction: (func: unknown) => func is (...args: any[]) => any;
 export declare const isObject: (obj: unknown) => obj is Record<string, any>;
-export declare const isPlainObject: (o: unknown) => o is Record<string, any>;
+export declare const isPlainObject: (obj: unknown) => obj is Record<string, any>;
 export declare const castArray: <T>(arr?: T | T[]) => T[];
 export declare const cloneDeep: <T>(value: T) => T;
 export declare const isSatisfyRspackVersion: (originalVersion: string) => Promise<boolean>;
@@ -37,3 +37,7 @@ export declare const isMultiCompiler: <C extends Rspack.Compiler | WebpackCompil
 export declare function pick<T, U extends keyof T>(obj: T, keys: ReadonlyArray<U>): Pick<T, U>;
 export declare const camelCase: (input: string) => string;
 export declare const prettyTime: (seconds: number) => string;
+/**
+ * Check if running in a TTY context
+ */
+export declare const isTTY: (type?: "stdin" | "stdout") => boolean;

package/dist-types/internal.d.ts

@@ -11,7 +11,7 @@ export { initRsbuildConfig } from './provider/initConfigs';
 export { stringifyConfig, getRsbuildInspectConfig, outputInspectConfigFiles, } from './config';
 export type { InternalContext } from './types';
 export { setHTMLPlugin, getHTMLPlugin } from './pluginHelper';
-export { formatStats, getStatsOptions, prettyTime } from './helpers';
+export { formatStats, getStatsOptions, prettyTime, isPlainObject, } from './helpers';
 export { registerBuildHook, registerDevHook, onCompileDone } from './hooks';
 export { getChainUtils, getConfigUtils } from './provider/rspackConfig';
 export { chainToConfig, modifyBundlerChain } from './configChain';

package/dist-types/plugins/swc.d.ts

@@ -1,7 +1,7 @@
 import type { SwcLoaderOptions } from '@rspack/core';
 import type { NormalizedEnvironmentConfig, RsbuildPlugin } from '../types';
 /**
- * Provide some swc configs of rspack
+ * Provide some SWC configs of Rspack
  */
 export declare const pluginSwc: () => RsbuildPlugin;
 export declare function applySwcDecoratorConfig(swcConfig: SwcLoaderOptions, config: NormalizedEnvironmentConfig): void;

package/dist-types/provider/createCompiler.d.ts

@@ -9,7 +9,7 @@ export type MiddlewareCallbacks = {
     onDone: (stats: any) => void;
 };
 export type DevMiddlewareOptions = {
-    /** To ensure HMR works, the devMiddleware need inject the hmr client path into page when HMR enable. */
+    /** To ensure HMR works, the devMiddleware need inject the HMR client path into page when HMR enable. */
     clientPaths?: string[];
     clientConfig: DevConfig['client'];
     publicPath?: string;

package/dist-types/server/devMiddleware.d.ts

@@ -19,7 +19,7 @@ export type DevMiddlewareAPI = Middleware & {
 /**
  * The rsbuild/server do nothing about compiler, the devMiddleware need do such things to ensure dev works well:
  * - Call compiler.watch （normally did by rsbuild-dev-middleware）.
- * - Inject the hmr client path into page （the hmr client rsbuild/server already provide）.
+ * - Inject the HMR client path into page （the HMR client rsbuild/server already provide）.
  * - Notify server when compiler hooks are triggered.
  */
 export type DevMiddleware = (options: DevMiddlewareOptions) => DevMiddlewareAPI;

package/dist-types/types/config.d.ts

@@ -107,6 +107,11 @@ export interface SourceConfig {
      * and the `alias` option in the bundler.
      */
     aliasStrategy?: AliasStrategy;
+    /**
+     * Include additional files that should be treated as static assets.
+     * @default undefined
+     */
+    assetsInclude?: Rspack.RuleSetCondition;
     /**
      * Specify directories or modules that need additional compilation.
      * In order to maintain faster compilation speed, Rsbuild will not compile files under node_modules through
@@ -529,47 +534,78 @@ export type FilenameConfig = {
     assets?: string;
 };
 export type DataUriLimit = {
-    /** The data URI limit of the SVG image. */
+    /**
+     * The data URI limit of the SVG image.
+     * @default 4096
+     */
     svg?: number;
-    /** The data URI limit of the font file. */
+    /**
+     * The data URI limit of the font file.
+     * @default 4096
+     */
     font?: number;
-    /** The data URI limit of non-SVG images. */
+    /**
+     * The data URI limit of non-SVG images.
+     * @default 4096
+     */
     image?: number;
-    /** The data URI limit of media resources such as videos. */
+    /**
+     * The data URI limit of media resources such as videos.
+     * @default 4096
+     */
     media?: number;
+    /**
+     * The data URI limit of other static assets.
+     * @default 4096
+     */
+    assets?: number;
 };
 export type Charset = 'ascii' | 'utf8';
 export type LegalComments = 'none' | 'inline' | 'linked';
 export type NormalizedDataUriLimit = Required<DataUriLimit>;
 export type Polyfill = 'usage' | 'entry' | 'off';
 export type SourceMap = {
+    /**
+     * The source map type for JavaScript files.
+     * @default isDev ? 'cheap-module-source-map' : false
+     */
     js?: Rspack.Configuration['devtool'];
+    /**
+     * Whether to generate source map for CSS files.
+     * @default false
+     */
     css?: boolean;
 };
 export type CSSModulesLocalsConvention = 'asIs' | 'camelCase' | 'camelCaseOnly' | 'dashes' | 'dashesOnly';
 export type CSSModules = {
     /**
      * Allows CSS Modules to be automatically enabled based on their filenames.
+     * @default true
      */
     auto?: CSSLoaderModulesOptions['auto'];
     /**
      * Allows exporting names from global class names, so you can use them via import.
+     * @default false
      */
     exportGlobals?: boolean;
     /**
      * Style of exported class names.
+     * @default 'camelCase'
      */
     exportLocalsConvention?: CSSModulesLocalsConvention;
     /**
      * Set the local ident name of CSS Modules.
+     * @default isProd ? '[local]-[hash:base64:6]' : '[path][name]__[local]-[hash:base64:6]'
      */
     localIdentName?: string;
     /**
      * Controls the level of compilation applied to the input styles.
+     * @default 'local'
      */
     mode?: CSSLoaderModulesOptions['mode'];
     /**
      * Whether to enable ES modules named export for locals.
+     * @default false
      */
     namedExport?: boolean;
 };
@@ -609,6 +645,7 @@ export interface OutputConfig {
     /**
      * At build time, prevent some `import` dependencies from being packed into bundles in your code, and instead fetch them externally at runtime.
      * For more information, please see: [Rspack Externals](https://rspack.dev/config/externals)
+     * @default undefined
      */
     externals?: Externals;
     /**
@@ -628,12 +665,14 @@ export interface OutputConfig {
     charset?: Charset;
     /**
      * Configure how the polyfill is injected.
+     * @default 'off'
      */
     polyfill?: Polyfill;
     /**
      * When using CDN in the production,
      * you can use this option to set the URL prefix of static assets,
      * similar to the output.publicPath config of webpack.
+     * @default `server.base`
      */
     assetPrefix?: string;
     /**
@@ -647,6 +686,7 @@ export interface OutputConfig {
      * comment in CSS that contains @license or @preserve or that starts with //! or /\*!.
      * These comments are preserved in output files by default since that follows the intent
      * of the original authors of the code.
+     * @default 'linked'
      */
     legalComments?: LegalComments;
     /**
@@ -660,30 +700,44 @@ export interface OutputConfig {
     cssModules?: CSSModules;
     /**
      * Whether to disable code minification in production build.
+     * @default true
      */
     minify?: Minify;
     /**
      * Whether to generate manifest file.
+     * @default false
      */
     manifest?: string | boolean;
     /**
-     * Whether to generate source map files, and which format of source map to generate
+     * Whether to generate source map files, and which format of source map to generate.
+     *
+     * @default
+     * ```js
+     * const defaultSourceMap = {
+     *   js: isDev ? 'cheap-module-source-map' : false,
+     *   css: false,
+     * };
+     * ```
      */
     sourceMap?: SourceMap;
     /**
      * Whether to add filename hash after production build.
+     * @default true
      */
     filenameHash?: boolean | string;
     /**
      * Whether to inline output scripts files (.js files) into HTML with `<script>` tags.
+     * @default false
      */
     inlineScripts?: InlineChunkConfig;
     /**
      * Whether to inline output style files (.css files) into html with `<style>` tags.
+     * @default false
      */
     inlineStyles?: InlineChunkConfig;
     /**
      * Whether to inject styles into the DOM via `style-loader`.
+     * @default false
      */
     injectStyles?: boolean;
     /**
@@ -691,26 +745,25 @@ export interface OutputConfig {
      * This value will be used by [SWC](https://github.com/swc-project/swc) and
      * [Lightning CSS](https://github.com/parcel-bundler/lightningcss) to identify the JavaScript syntax that
      * need to be transformed and the CSS browser prefixes that need to be added.
+     * @default undefined
      */
     overrideBrowserslist?: string[];
     /**
      * Copies the specified file or directory to the dist directory.
+     * @default undefined
      */
     copy?: CopyRspackPluginOptions | CopyRspackPluginOptions['patterns'];
     /**
      * Whether to emit static assets such as image, font, etc.
      * Return `false` to avoid outputting unnecessary assets for some scenarios such as SSR.
+     * @default true
      */
     emitAssets?: boolean;
 }
 export interface NormalizedOutputConfig extends OutputConfig {
     target: RsbuildTarget;
     filename: FilenameConfig;
-    distPath: Omit<Required<DistPathConfig>, 'jsAsync' | 'cssAsync' | 'js'> & {
-        js?: string;
-        jsAsync?: string;
-        cssAsync?: string;
-    };
+    distPath: Omit<Required<DistPathConfig>, 'jsAsync' | 'cssAsync' | 'js'> & Pick<DistPathConfig, 'jsAsync' | 'cssAsync' | 'js'>;
     polyfill: Polyfill;
     sourceMap: {
         js?: Rspack.Configuration['devtool'];
@@ -809,27 +862,40 @@ export type AppIcon = {
 export interface HtmlConfig {
     /**
      * Configure the `<meta>` tag of the HTML.
+     *
+     * @default
+     * ```js
+     * const defaultMeta = {
+     *   charset: { charset: 'UTF-8' },
+     *   viewport: 'width=device-width, initial-scale=1.0',
+     * };
+     * ```
      */
     meta?: ChainedHtmlOption<MetaOptions>;
     /**
      * Set the title tag of the HTML page.
+     * @default 'Rsbuild App'
      */
     title?: ChainedHtmlOption<string>;
     /**
      * Set the inject position of the `<script>` tag.
+     * @default 'head'
      */
     inject?: ChainedHtmlOption<ScriptInject>;
     /**
      * Inject custom html tags into the output html files.
+     * @default undefined
      */
     tags?: OneOrMany<HtmlTagDescriptor>;
     /**
      * Set the favicon icon for all pages.
+     * @default undefined
      */
     favicon?: ChainedHtmlOption<string>;
     /**
      * Set the web application icons to display when added to the home screen of a mobile device.
      *
+     * @default undefined
      * @example
      * appIcon: {
      *   name: 'My Website',
@@ -842,20 +908,24 @@ export interface HtmlConfig {
     appIcon?: AppIcon;
     /**
      * Set the id of root element.
+     * @default 'root'
      */
     mountId?: string;
     /**
      * Set the [crossorigin](https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/crossorigin) attribute
      * of the `<script>` tag.
+     * @default false
      */
     crossorigin?: boolean | CrossOrigin;
     /**
      * Define the directory structure of the HTML output files.
+     * @default 'flat'
      */
     outputStructure?: OutputStructure;
     /**
      * Define the path to the HTML template,
      * corresponding to the `template` config of [html-rspack-plugin](https://github.com/rspack-contrib/html-rspack-plugin).
+     * @default A built-in HTML template
      */
     template?: ChainedHtmlOption<string>;
     /**
@@ -867,6 +937,7 @@ export interface HtmlConfig {
     }>;
     /**
      * Set the loading mode of the `<script>` tag.
+     * @default 'defer'
      */
     scriptLoading?: ScriptLoading;
 }

package/dist-types/types/plugin.d.ts

@@ -73,10 +73,12 @@ export type PluginManager = {
         environment: string;
     }) => RsbuildPlugin[];
     addPlugins: (plugins: Array<RsbuildPlugin | Falsy>, options?: {
+        /**
+         * Insert before the specified plugin.
+         */
         before?: string;
         /**
          * Add a plugin for the specified environment.
-         *
          * If environment is not specified, it will be registered as a global plugin (effective in all environments)
          */
         environment?: string;

package/dist-types/types/thirdParty.d.ts

@@ -36,7 +36,7 @@ export type CSSLoaderModulesMode = 'local' | 'global' | 'pure' | 'icss' | ((reso
 export type CSSLoaderExportLocalsConvention = 'asIs' | 'as-is' | 'camelCase' | 'camel-case' | 'camelCaseOnly' | 'camel-case-only' | 'dashes' | 'dashesOnly' | 'dashes-only' | ((name: string) => string);
 export interface CSSLoaderModulesOptions {
     /**
-     * Allows auto enable CSS modules/ICSS based on the filename, query or fragment.
+     * Allows auto enable CSS Modules/ICSS based on the filename, query or fragment.
      */
     auto?: boolean | RegExp | ((resourcePath: string, resourceQuery: string, resourceFragment: string) => boolean);
     /**
@@ -88,7 +88,7 @@ export interface CSSLoaderModulesOptions {
      */
     namedExport?: boolean;
     /**
-     * Enables a callback to output the CSS modules mapping JSON.
+     * Enables a callback to output the CSS Modules mapping JSON.
      */
     getJSON?: (context: {
         resourcePath: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rsbuild/core",
-  "version": "1.0.17",
+  "version": "1.0.18",
   "description": "The Rspack-based build tool.",
   "homepage": "https://rsbuild.dev",
   "bugs": {