@rsbuild/core 1.0.9 → 1.0.11

package/dist-types/config.d.ts

@@ -24,7 +24,7 @@ export declare function defineConfig(config: RsbuildConfig): RsbuildConfig;
 export declare function defineConfig(config: RsbuildConfigSyncFn): RsbuildConfigSyncFn;
 export declare function defineConfig(config: RsbuildConfigAsyncFn): RsbuildConfigAsyncFn;
 export declare function defineConfig(config: RsbuildConfigExport): RsbuildConfigExport;
-export declare function watchFiles(files: string[], watchOptions?: WatchOptions): Promise<void>;
+export declare function watchFilesForRestart(files: string[], watchOptions?: WatchOptions): Promise<void>;
 export declare function loadConfig({ cwd, path, envMode, }?: {
     cwd?: string;
     path?: string;

package/dist-types/constants.d.ts

@@ -18,6 +18,7 @@ export declare const DEFAULT_DATA_URL_SIZE = 4096;
 export declare const DEFAULT_MOUNT_ID = "root";
 export declare const DEFAULT_DEV_HOST = "0.0.0.0";
 export declare const DEFAULT_ASSET_PREFIX = "/";
+export declare const DEFAULT_BASE_URL = "/";
 export declare const DEFAULT_WEB_BROWSERSLIST: string[];
 export declare const DEFAULT_BROWSERSLIST: Record<string, string[]>;
 export declare const HTML_REGEX: RegExp;

package/dist-types/index.d.ts

@@ -15,7 +15,7 @@ export { logger } from './logger';
 export { mergeRsbuildConfig } from './mergeConfig';
 export { ensureAssetPrefix } from './helpers';
 export { PLUGIN_SWC_NAME, PLUGIN_CSS_NAME } from './constants';
-export type { AppIcon, AppIconItem, AliasStrategy, Build, BuildOptions, BundlerPluginInstance, CacheGroup, CacheGroups, Charset, ClientConfig, ConfigChain, ConfigChainWithContext, ConsoleType, CreateCompiler, CreateCompilerOptions, CreateRsbuildOptions, CrossOrigin, CSSLoaderOptions, CSSModules, CSSModulesLocalsConvention, DataUriLimit, Decorators, DevConfig, DistPathConfig, EnvironmentContext, EnvironmentConfig, FilenameConfig, HistoryApiFallbackContext, HistoryApiFallbackOptions, HtmlConfig, HtmlRspackPlugin, HtmlBasicTag, HtmlFallback, HtmlTagHandler, HtmlTagDescriptor, HtmlTagContext, InspectConfigOptions, InspectConfigResult, InlineChunkConfig, InlineChunkTest, InlineChunkTestFunction, LegalComments, MetaAttrs, MetaOptions, Minify, ModifyBundlerChainFn, ModifyBundlerChainUtils, ModifyChainUtils, ModifyRspackConfigFn, ModifyRspackConfigUtils, ModifyRsbuildConfigFn, ModifyWebpackChainFn, ModifyWebpackChainUtils, ModifyWebpackConfigUtils, ModuleFederationConfig, MergedEnvironmentConfig, NormalizedConfig, NormalizedDevConfig, NormalizedEnvironmentConfig, NormalizedHtmlConfig, NormalizedModuleFederationConfig, NormalizedOutputConfig, NormalizedPerformanceConfig, NormalizedSecurityConfig, NormalizedServerConfig, NormalizedSourceConfig, NormalizedToolsConfig, OnAfterBuildFn, OnAfterCreateCompilerFn, OnAfterStartDevServerFn, OnAfterStartProdServerFn, OnBeforeBuildFn, OnBeforeCreateCompilerFn, OnBeforeStartDevServerFn, OnBeforeStartProdServerFn, OnCloseDevServerFn, OnDevCompileDoneFn, OnExitFn, OutputConfig, OutputStructure, PerformanceConfig, PluginManager, Polyfill, PostCSSLoaderOptions, PostCSSPlugin, PreconnectOption, ProxyConfig, ProxyOptions, PrintUrls, PublicDir, PublicDirOptions, ProgressBarConfig, RequestHandler, ResolvedCreateRsbuildOptions, RsbuildConfig, RsbuildContext, RsbuildEntry, RsbuildEntryDescription, RsbuildInstance, RsbuildMode, RsbuildPlugin, RsbuildPluginAPI, RsbuildPlugins, RsbuildProvider, RsbuildTarget, RspackChain, RspackRule, SriOptions, SriAlgorithm, ScriptInject, ScriptLoading, SecurityConfig, SourceMap, SetupMiddlewaresFn, SetupMiddlewaresServer, ServerConfig, SourceConfig, SplitChunks, StyleLoaderOptions, ToolsConfig, TransformFn, TransformHandler, TransformImport, WatchFiles, } from './types';
+export type { AppIcon, AppIconItem, AliasStrategy, Build, BuildOptions, BundlerPluginInstance, CacheGroup, CacheGroups, Charset, ClientConfig, CliShortcut, ConfigChain, ConfigChainWithContext, ConsoleType, CreateCompiler, CreateRsbuildOptions, CrossOrigin, CSSLoaderOptions, CSSModules, CSSModulesLocalsConvention, DataUriLimit, Decorators, DevConfig, DistPathConfig, EnvironmentContext, EnvironmentConfig, FilenameConfig, HistoryApiFallbackContext, HistoryApiFallbackOptions, HtmlConfig, HtmlRspackPlugin, HtmlBasicTag, HtmlFallback, HtmlTagHandler, HtmlTagDescriptor, HtmlTagContext, InspectConfigOptions, InspectConfigResult, InlineChunkConfig, InlineChunkTest, InlineChunkTestFunction, LegalComments, MetaAttrs, MetaOptions, Minify, ModifyBundlerChainFn, ModifyBundlerChainUtils, ModifyChainUtils, ModifyRspackConfigFn, ModifyRspackConfigUtils, ModifyRsbuildConfigFn, ModifyWebpackChainFn, ModifyWebpackChainUtils, ModifyWebpackConfigUtils, ModuleFederationConfig, MergedEnvironmentConfig, NormalizedConfig, NormalizedDevConfig, NormalizedEnvironmentConfig, NormalizedHtmlConfig, NormalizedModuleFederationConfig, NormalizedOutputConfig, NormalizedPerformanceConfig, NormalizedSecurityConfig, NormalizedServerConfig, NormalizedSourceConfig, NormalizedToolsConfig, OnAfterBuildFn, OnAfterCreateCompilerFn, OnAfterStartDevServerFn, OnAfterStartProdServerFn, OnBeforeBuildFn, OnBeforeCreateCompilerFn, OnBeforeStartDevServerFn, OnBeforeStartProdServerFn, OnCloseDevServerFn, OnDevCompileDoneFn, OnExitFn, OutputConfig, OutputStructure, PerformanceConfig, PluginManager, Polyfill, PostCSSLoaderOptions, PostCSSPlugin, PreviewOptions, PreconnectOption, ProxyConfig, ProxyOptions, PrintUrls, PublicDir, PublicDirOptions, ProgressBarConfig, RequestHandler, ResolvedCreateRsbuildOptions, RsbuildConfig, RsbuildContext, RsbuildEntry, RsbuildEntryDescription, RsbuildInstance, RsbuildMode, RsbuildPlugin, RsbuildPluginAPI, RsbuildPlugins, RsbuildProvider, RsbuildTarget, RspackChain, RspackRule, SriOptions, SriAlgorithm, ScriptInject, ScriptLoading, SecurityConfig, SourceMap, SetupMiddlewaresFn, SetupMiddlewaresServer, ServerConfig, SourceConfig, SplitChunks, StyleLoaderOptions, ToolsConfig, TransformFn, TransformHandler, TransformImport, WatchFiles, } from './types';
 export type { ChainIdentifier } from './configChain';
 export { 
 /**

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

@@ -0,0 +1,9 @@
+import type { CliShortcut, NormalizedDevConfig } from '../types/config';
+export declare const isCliShortcutsEnabled: (devConfig: NormalizedDevConfig) => boolean;
+export declare function setupCliShortcuts({ openPage, closeServer, printUrls, restartServer, customShortcuts, }: {
+    openPage: () => Promise<void>;
+    closeServer: () => Promise<void>;
+    printUrls: () => void;
+    restartServer?: () => Promise<void>;
+    customShortcuts?: (shortcuts: CliShortcut[]) => CliShortcut[];
+}): void;

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

@@ -14,9 +14,11 @@ export type StartServerResult = {
     };
 };
 export declare const normalizeUrl: (url: string) => string;
+export declare const joinUrlSegments: (s1: string, s2: string) => string;
+export declare const stripBase: (path: string, base: string) => string;
 export declare const getRoutes: (context: InternalContext) => Routes;
-export declare const formatRoutes: (entry: RsbuildEntry, prefix: string | undefined, outputStructure: OutputStructure | undefined) => Routes;
-export declare function printServerURLs({ urls: originalUrls, port, routes, protocol, printUrls, }: {
+export declare const formatRoutes: (entry: RsbuildEntry, base: string, distPathPrefix: string | undefined, outputStructure: OutputStructure | undefined) => Routes;
+export declare function printServerURLs({ urls: originalUrls, port, routes, protocol, printUrls, trailingLineBreak, }: {
     urls: Array<{
         url: string;
         label: string;
@@ -25,6 +27,7 @@ export declare function printServerURLs({ urls: originalUrls, port, routes, prot
     routes: Routes;
     protocol: string;
     printUrls?: PrintUrls;
+    trailingLineBreak?: boolean;
 }): string | null;
 /**
  * Get available free port.

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

@@ -11,6 +11,12 @@ export declare const getHtmlCompletionMiddleware: (params: {
     callback: Middleware;
     outputFileSystem: Rspack.OutputFileSystem;
 }) => Middleware;
+/**
+ * handle `server.base`
+ */
+export declare const getBaseMiddleware: (params: {
+    base: string;
+}) => Middleware;
 /**
  * support HTML fallback in some edge cases
  */

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

@@ -1,7 +1,7 @@
 import type { Server } from 'node:http';
 import type { Http2SecureServer } from 'node:http2';
 import type Connect from '../../compiled/connect';
-import type { InternalContext, NormalizedConfig, PreviewServerOptions, ServerConfig } from '../types';
+import type { InternalContext, NormalizedConfig, PreviewOptions, ServerConfig } from '../types';
 import { type StartServerResult } from './helper';
 type RsbuildProdServerOptions = {
     pwd: string;
@@ -21,5 +21,5 @@ export declare class RsbuildProdServer {
     private applyStaticAssetMiddleware;
     close(): Promise<void>;
 }
-export declare function startProdServer(context: InternalContext, config: NormalizedConfig, { getPortSilently }?: PreviewServerOptions): Promise<StartServerResult>;
+export declare function startProdServer(context: InternalContext, config: NormalizedConfig, { getPortSilently }?: PreviewOptions): Promise<StartServerResult>;
 export {};

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

@@ -3,7 +3,8 @@ type Cleaner = () => Promise<unknown> | unknown;
  * Add a cleaner to handle side effects
  */
 export declare const onBeforeRestartServer: (cleaner: Cleaner) => void;
-export declare const restartDevServer: ({ filePath, }: {
-    filePath: string;
+export declare const restartDevServer: ({ filePath, clear, }?: {
+    filePath?: string;
+    clear?: boolean;
 }) => Promise<void>;
 export {};

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

@@ -220,6 +220,12 @@ export type PublicDirOptions = {
 };
 export type PublicDir = false | PublicDirOptions | PublicDirOptions[];
 export interface ServerConfig {
+    /**
+     * Configure the base path of the server.
+     *
+     * @default '/'
+     */
+    base?: string;
     /**
      * Whether to enable gzip compression
      */
@@ -273,7 +279,7 @@ export interface ServerConfig {
      */
     printUrls?: PrintUrls;
 }
-export type NormalizedServerConfig = ServerConfig & Required<Pick<ServerConfig, 'htmlFallback' | 'port' | 'host' | 'compress' | 'strictPort' | 'printUrls' | 'open'>>;
+export type NormalizedServerConfig = ServerConfig & Required<Pick<ServerConfig, 'htmlFallback' | 'port' | 'host' | 'compress' | 'strictPort' | 'printUrls' | 'open' | 'base'>>;
 export type SriAlgorithm = 'sha256' | 'sha384' | 'sha512';
 export type SriOptions = {
     algorithm?: SriAlgorithm;
@@ -933,6 +939,20 @@ export type WatchFiles = {
     options?: WatchOptions;
     type?: 'reload-page' | 'reload-server';
 };
+export type CliShortcut = {
+    /**
+     * The key to trigger the shortcut.
+     */
+    key: string;
+    /**
+     * The description of the shortcut.
+     */
+    description: string;
+    /**
+     * The action to execute when the shortcut is triggered.
+     */
+    action: () => void | Promise<void>;
+};
 export interface DevConfig {
     /**
      * Whether to enable Hot Module Replacement.
@@ -955,6 +975,17 @@ export interface DevConfig {
      * Config for Rsbuild client code.
      */
     client?: ClientConfig;
+    /**
+     * Whether to enable CLI shortcuts.
+     */
+    cliShortcuts?: boolean | {
+        /**
+         * Customize the CLI shortcuts.
+         * @param shortcuts - The default CLI shortcuts.
+         * @returns - The customized CLI shortcuts.
+         */
+        custom?: (shortcuts?: CliShortcut[]) => CliShortcut[];
+    };
     /**
      * Provides the ability to execute a custom function and apply custom middlewares.
      */
@@ -967,14 +998,14 @@ export interface DevConfig {
     /**
      * This option allows you to configure a list of globs/directories/files to watch for file changes.
      */
-    watchFiles?: WatchFiles;
+    watchFiles?: WatchFiles | WatchFiles[];
     /**
      * Enable lazy compilation.
      * @default false
      */
     lazyCompilation?: boolean | Rspack.LazyCompilationOptions;
 }
-export type NormalizedDevConfig = DevConfig & Required<Pick<DevConfig, 'hmr' | 'liveReload' | 'assetPrefix' | 'writeToDisk'>> & {
+export type NormalizedDevConfig = DevConfig & Required<Pick<DevConfig, 'hmr' | 'liveReload' | 'assetPrefix' | 'writeToDisk' | 'cliShortcuts'>> & {
     client: NormalizedClientConfig;
 };
 export type ModuleFederationConfig = {

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

@@ -8,11 +8,15 @@ import type { PluginManager, RsbuildPluginAPI } from './plugin';
 import type { Rspack } from './rspack';
 import type { WebpackConfig } from './thirdParty';
 export type Bundler = 'rspack' | 'webpack';
-export type CreateCompilerOptions = {
-    watch?: boolean;
-};
 export type StartDevServerOptions = {
+    /**
+     * Using a custom Rspack Compiler object.
+     */
     compiler?: Compiler | MultiCompiler;
+    /**
+     * Whether to get port silently and not print any logs.
+     * @default false
+     */
     getPortSilently?: boolean;
 };
 export type CreateDevServerOptions = StartDevServerOptions & {
@@ -23,8 +27,17 @@ export type CreateDevServerOptions = StartDevServerOptions & {
      */
     runCompile?: boolean;
 };
-export type PreviewServerOptions = {
+export type PreviewOptions = {
+    /**
+     * Whether to get port silently and not print any logs.
+     * @default false
+     */
     getPortSilently?: boolean;
+    /**
+     * Whether to check if the dist directory exists and is not empty.
+     * @default true
+     */
+    checkDistDir?: boolean;
 };
 export type BuildOptions = {
     /**
@@ -67,7 +80,7 @@ export type InspectConfigResult<B extends 'rspack' | 'webpack' = 'rspack'> = {
         bundlerConfigs: B extends 'rspack' ? Rspack.Configuration[] : WebpackConfig[];
     };
 };
-export type CreateCompiler = <C = Compiler | MultiCompiler>(options?: CreateCompilerOptions) => Promise<C>;
+export type CreateCompiler = <C = Compiler | MultiCompiler>() => Promise<C>;
 export type CreateRsbuildOptions = {
     /** The root path of current project. */
     cwd?: string;
@@ -104,7 +117,7 @@ export type RsbuildInstance = {
     removePlugins: PluginManager['removePlugins'];
     isPluginExists: PluginManager['isPluginExists'];
     build: ProviderInstance['build'];
-    preview: (options?: PreviewServerOptions) => Promise<StartServerResult>;
+    preview: (options?: PreviewOptions) => Promise<StartServerResult>;
     initConfigs: ProviderInstance['initConfigs'];
     inspectConfig: ProviderInstance['inspectConfig'];
     createCompiler: ProviderInstance['createCompiler'];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rsbuild/core",
-  "version": "1.0.9",
+  "version": "1.0.11",
   "description": "The Rspack-based build tool.",
   "homepage": "https://rsbuild.dev",
   "bugs": {
@@ -88,7 +88,7 @@
     "sirv": "^2.0.4",
     "style-loader": "3.3.4",
     "tsc-alias": "^1.8.10",
-    "typescript": "^5.5.2",
+    "typescript": "^5.6.2",
     "webpack": "^5.95.0",
     "webpack-bundle-analyzer": "^4.10.2",
     "webpack-merge": "6.0.1",