@rsbuild/core 1.0.0 → 1.0.1-beta.1

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

@@ -0,0 +1,297 @@
+import type { CopyRspackPluginOptions, Externals, LightningCssMinimizerRspackPluginOptions, SwcJsMinimizerRspackPluginOptions } from '@rspack/core';
+import type { CSSLoaderModulesOptions } from '../../types';
+import type { RsbuildTarget } from '../rsbuild';
+import type { Rspack, RspackConfig } from '../rspack';
+export type DistPathConfig = {
+    /**
+     * The root directory of all files.
+     * @default 'dist'
+     **/
+    root?: string;
+    /**
+     * The output directory of JavaScript files.
+     * @default 'static/js'
+     */
+    js?: string;
+    /**
+     * The output directory of async JavaScript files.
+     * @default 'static/js/async'
+     */
+    jsAsync?: string;
+    /**
+     * The output directory of CSS files.
+     * @default 'static/css'
+     */
+    css?: string;
+    /**
+     * The output directory of async CSS files.
+     * @default 'static/css/async'
+     */
+    cssAsync?: string;
+    /**
+     * The output directory of SVG images.
+     * @default 'static/svg'
+     */
+    svg?: string;
+    /**
+     * The output directory of font files.
+     * @default 'static/font'
+     */
+    font?: string;
+    /**
+     * The output directory of HTML files.
+     * @default '/'
+     */
+    html?: string;
+    /**
+     * The output directory of Wasm files.
+     * @default 'static/wasm'
+     */
+    wasm?: string;
+    /**
+     * The output directory of non-SVG images.
+     * @default 'static/image'
+     */
+    image?: string;
+    /**
+     * The output directory of media resources, such as videos.
+     * @default 'static/media'
+     */
+    media?: string;
+};
+export type FilenameConfig = {
+    /**
+     * The name of the JavaScript files.
+     * @default
+     * - dev: '[name].js'
+     * - prod: '[name].[contenthash:8].js'
+     */
+    js?: NonNullable<Rspack.Configuration['output']>['filename'];
+    /**
+     * The name of the CSS files.
+     * @default
+     * - dev: '[name].css'
+     * - prod: '[name].[contenthash:8].css'
+     */
+    css?: string;
+    /**
+     * The name of the SVG images.
+     * @default '[name].[contenthash:8].svg'
+     */
+    svg?: string;
+    /**
+     * The name of the font files.
+     * @default '[name].[contenthash:8][ext]'
+     */
+    font?: string;
+    /**
+     * The name of non-SVG images.
+     * @default '[name].[contenthash:8][ext]'
+     */
+    image?: string;
+    /**
+     * The name of media assets, such as video.
+     * @default '[name].[contenthash:8][ext]'
+     */
+    media?: string;
+};
+export type DataUriLimit = {
+    /** The data URI limit of the SVG image. */
+    svg?: number;
+    /** The data URI limit of the font file. */
+    font?: number;
+    /** The data URI limit of non-SVG images. */
+    image?: number;
+    /** The data URI limit of media resources such as videos. */
+    media?: 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 = {
+    js?: RspackConfig['devtool'];
+    css?: boolean;
+};
+export type CSSModulesLocalsConvention = 'asIs' | 'camelCase' | 'camelCaseOnly' | 'dashes' | 'dashesOnly';
+export type CSSModules = {
+    /**
+     * Allows CSS Modules to be automatically enabled based on their filenames.
+     */
+    auto?: CSSLoaderModulesOptions['auto'];
+    /**
+     * Allows exporting names from global class names, so you can use them via import.
+     */
+    exportGlobals?: boolean;
+    /**
+     * Style of exported class names.
+     */
+    exportLocalsConvention?: CSSModulesLocalsConvention;
+    /**
+     * Set the local ident name of CSS Modules.
+     */
+    localIdentName?: string;
+    /**
+     * Controls the level of compilation applied to the input styles.
+     */
+    mode?: CSSLoaderModulesOptions['mode'];
+    /**
+     * Whether to enable ES modules named export for locals.
+     */
+    namedExport?: boolean;
+};
+export type Minify = boolean | {
+    /**
+     * Whether to enable JavaScript minification.
+     */
+    js?: boolean;
+    /**
+     * Minimizer options of JavaScript, which will be passed to SWC.
+     */
+    jsOptions?: SwcJsMinimizerRspackPluginOptions;
+    /**
+     * Whether to enable CSS minimization.
+     */
+    css?: boolean;
+    /**
+     * Minimizer options of CSS, which will be passed to LightningCSS.
+     */
+    cssOptions?: LightningCssMinimizerRspackPluginOptions;
+};
+export type InlineChunkTestFunction = (params: {
+    size: number;
+    name: string;
+}) => boolean;
+export type InlineChunkTest = RegExp | InlineChunkTestFunction;
+export interface OutputConfig {
+    /**
+     * Specify build target to run in specified environment.
+     * @default 'web'
+     */
+    target?: RsbuildTarget;
+    /**
+     * 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)
+     */
+    externals?: Externals;
+    /**
+     * Set the directory of the dist files.
+     * Rsbuild will output files to the corresponding subdirectory according to the file type.
+     */
+    distPath?: DistPathConfig;
+    /**
+     * Sets the filename of dist files.
+     */
+    filename?: FilenameConfig;
+    /**
+     * By default, Rsbuild's output is ASCII-only and will escape all non-ASCII characters.
+     * If you want to output the original characters without using escape sequences,
+     * you can set `output.charset` to `utf8`.
+     */
+    charset?: Charset;
+    /**
+     * Configure how the polyfill is injected.
+     */
+    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.
+     */
+    assetPrefix?: string;
+    /**
+     * Set the size threshold to inline static assets such as images and fonts.
+     * By default, static assets will be Base64 encoded and inline into the page if the size is less than 4KiB.
+     */
+    dataUriLimit?: number | DataUriLimit;
+    /**
+     * Configure how to handle the legal comment.
+     * A "legal comment" is considered to be any statement-level comment in JS or rule-level
+     * 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.
+     */
+    legalComments?: LegalComments;
+    /**
+     * Whether to clean all files in the dist path before starting compilation.
+     */
+    cleanDistPath?: boolean;
+    /**
+     * Allow to custom CSS Modules options.
+     */
+    cssModules?: CSSModules;
+    /**
+     * Whether to disable code minification in production build.
+     */
+    minify?: Minify;
+    /**
+     * Whether to generate manifest file.
+     */
+    manifest?: string | boolean;
+    /**
+     * Whether to generate source map files, and which format of source map to generate
+     */
+    sourceMap?: SourceMap;
+    /**
+     * Whether to add filename hash after production build.
+     */
+    filenameHash?: boolean | string;
+    /**
+     * Whether to inline output scripts files (.js files) into HTML with `<script>` tags.
+     */
+    inlineScripts?: boolean | InlineChunkTest;
+    /**
+     * Whether to inline output style files (.css files) into html with `<style>` tags.
+     */
+    inlineStyles?: boolean | InlineChunkTest;
+    /**
+     * Whether to inject styles into the DOM via `style-loader`.
+     */
+    injectStyles?: boolean;
+    /**
+     * Specifies the range of target browsers that the project is compatible with.
+     * This value will be used by [SWC](https://github.com/swc-project/swc) and
+     * [autoprefixer](https://github.com/postcss/autoprefixer) to identify the JavaScript syntax that
+     * need to be transformed and the CSS browser prefixes that need to be added.
+     */
+    overrideBrowserslist?: string[];
+    /**
+     * Copies the specified file or directory to the dist directory.
+     */
+    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.
+     */
+    emitAssets?: boolean;
+}
+export interface NormalizedOutputConfig extends OutputConfig {
+    target: RsbuildTarget;
+    filename: FilenameConfig;
+    distPath: Omit<Required<DistPathConfig>, 'jsAsync' | 'cssAsync' | 'js'> & {
+        js?: string;
+        jsAsync?: string;
+        cssAsync?: string;
+    };
+    polyfill: Polyfill;
+    sourceMap: {
+        js?: RspackConfig['devtool'];
+        css: boolean;
+    };
+    filenameHash: boolean | string;
+    assetPrefix: string;
+    dataUriLimit: number | NormalizedDataUriLimit;
+    minify: Minify;
+    inlineScripts: boolean | InlineChunkTest;
+    inlineStyles: boolean | InlineChunkTest;
+    injectStyles: boolean;
+    cssModules: {
+        auto: CSSModules['auto'];
+        namedExport: boolean;
+        exportGlobals: boolean;
+        exportLocalsConvention: CSSModulesLocalsConvention;
+        localIdentName?: string;
+        mode?: CSSModules['mode'];
+    };
+    emitAssets: boolean;
+}

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

@@ -0,0 +1,123 @@
+import type { Configuration } from '@rspack/core';
+import type { BundleAnalyzerPlugin } from '../../../compiled/webpack-bundle-analyzer';
+export type ConsoleType = 'log' | 'info' | 'warn' | 'error' | 'table' | 'group';
+export type BuildCacheOptions = {
+    /** Base directory for the filesystem cache. */
+    cacheDirectory?: string;
+    cacheDigest?: Array<string | undefined>;
+};
+export type PrintFileSizeOptions = {
+    total?: boolean;
+    detail?: boolean;
+    compressed?: boolean;
+};
+export interface PreconnectOption {
+    href: string;
+    crossorigin?: boolean;
+}
+export type Preconnect = Array<string | PreconnectOption>;
+export interface DnsPrefetchOption {
+    href: string;
+}
+export type DnsPrefetch = string[];
+export type PreloadIncludeType = 'async-chunks' | 'initial' | 'all-assets' | 'all-chunks';
+export type Filter = Array<string | RegExp> | ((filename: string) => boolean);
+export interface PreloadOrPreFetchOption {
+    type?: PreloadIncludeType;
+    include?: Filter;
+    exclude?: Filter;
+}
+export interface PerformanceConfig {
+    /**
+     * Whether to remove `console.[methodName]` in production build.
+     */
+    removeConsole?: boolean | ConsoleType[];
+    /**
+     * Whether to remove the locales of [moment.js](https://momentjs.com/).
+     */
+    removeMomentLocale?: boolean;
+    /**
+     * Controls the Rsbuild's caching behavior during the build process.
+     */
+    buildCache?: BuildCacheOptions | boolean;
+    /**
+     * Whether to print the file sizes after production build.
+     */
+    printFileSize?: PrintFileSizeOptions | boolean;
+    /**
+     * Configure the chunk splitting strategy.
+     */
+    chunkSplit?: RsbuildChunkSplit;
+    /**
+     * Analyze the size of output files.
+     */
+    bundleAnalyze?: BundleAnalyzerPlugin.Options;
+    /**
+     * Used to control resource `Preconnect`.
+     *
+     * Specifies that the user agent should preemptively connect to the target resource's origin.
+     */
+    preconnect?: Preconnect;
+    /**
+     * Used to control resource `DnsPrefetch`.
+     *
+     * Specifies that the user agent should preemptively perform DNS resolution for the target resource's origin.
+     */
+    dnsPrefetch?: DnsPrefetch;
+    /**
+     * Used to control resource `Preload`.
+     *
+     * Specifies that the user agent must preemptively fetch and cache the target resource for current navigation.
+     */
+    preload?: true | PreloadOrPreFetchOption;
+    /**
+     * Used to control resource `Prefetch`.
+     *
+     * Specifies that the user agent should preemptively fetch and cache the target resource as it is likely to be required for a followup navigation.
+     */
+    prefetch?: true | PreloadOrPreFetchOption;
+    /**
+     * Whether capture timing information for each module,
+     * same as the [profile](https://webpack.js.org/configuration/other-options/#profile) config of webpack.
+     */
+    profile?: boolean;
+}
+export interface NormalizedPerformanceConfig extends PerformanceConfig {
+    printFileSize: PrintFileSizeOptions | boolean;
+    buildCache: BuildCacheOptions | boolean;
+    chunkSplit: RsbuildChunkSplit;
+}
+export type SplitChunks = Configuration extends {
+    optimization?: {
+        splitChunks?: infer P;
+    };
+} ? P : never;
+export type CacheGroups = Configuration extends {
+    optimization?: {
+        splitChunks?: {
+            cacheGroups?: infer P;
+        } | false;
+    };
+} ? P : never;
+export type CacheGroup = CacheGroups extends {
+    [key: string]: infer P;
+} ? P : null;
+export type ForceSplitting = RegExp[] | Record<string, RegExp>;
+export interface BaseSplitRules {
+    strategy?: string;
+    forceSplitting?: ForceSplitting;
+    override?: SplitChunks;
+}
+export interface BaseChunkSplit extends BaseSplitRules {
+    strategy?: 'split-by-module' | 'split-by-experience' | 'all-in-one' | 'single-vendor';
+}
+export interface SplitBySize extends BaseSplitRules {
+    strategy: 'split-by-size';
+    minSize?: number;
+    maxSize?: number;
+}
+export interface SplitCustom extends BaseSplitRules {
+    strategy: 'custom';
+    splitChunks?: SplitChunks;
+}
+export type RsbuildChunkSplit = BaseChunkSplit | SplitBySize | SplitCustom;

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

@@ -0,0 +1,18 @@
+export type SriAlgorithm = 'sha256' | 'sha384' | 'sha512';
+export type SriOptions = {
+    algorithm?: SriAlgorithm;
+    enable?: boolean | 'auto';
+};
+export interface SecurityConfig {
+    /**
+     * Adding an nonce attribute to sub-resources introduced by HTML allows the browser to
+     * verify the nonce of the introduced resource, thus preventing xss.
+     */
+    nonce?: string;
+    /**
+     * Adding an integrity attribute (`integrity`) to sub-resources introduced by HTML allows the browser to
+     * verify the integrity of the introduced resource, thus preventing tampering with the downloaded resource.
+     */
+    sri?: SriOptions;
+}
+export type NormalizedSecurityConfig = Required<SecurityConfig>;

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

@@ -0,0 +1,106 @@
+import type { IncomingMessage, ServerResponse } from 'node:http';
+import type { SecureServerSessionOptions } from 'node:http2';
+import type { ServerOptions as HttpsServerOptions } from 'node:https';
+import type { Options as BaseProxyOptions, Filter as ProxyFilter } from '../../../compiled/http-proxy-middleware';
+import type { Routes } from '../hooks';
+export type HtmlFallback = false | 'index';
+export type ProxyDetail = BaseProxyOptions & {
+    bypass?: (req: IncomingMessage, res: ServerResponse, proxyOptions: ProxyOptions) => string | undefined | null | boolean;
+    context?: ProxyFilter;
+};
+export type ProxyOptions = Record<string, string> | Record<string, ProxyDetail> | ProxyDetail[] | ProxyDetail;
+export type HistoryApiFallbackContext = {
+    match: RegExpMatchArray;
+    parsedUrl: import('node:url').Url;
+    request: Request;
+};
+export type HistoryApiFallbackOptions = {
+    index?: string;
+    verbose?: boolean;
+    logger?: typeof console.log;
+    htmlAcceptHeaders?: string[];
+    disableDotRule?: true;
+    rewrites?: Array<{
+        from: RegExp;
+        to: string | RegExp | ((context: HistoryApiFallbackContext) => string);
+    }>;
+};
+export type PrintUrls = boolean | ((params: {
+    urls: string[];
+    port: number;
+    routes: Routes;
+    protocol: string;
+}) => string[] | void);
+export type PublicDirOptions = {
+    /**
+     * The name of the public directory, can be set as a relative path or an absolute path.
+     * @default 'public'
+     */
+    name?: string;
+    /**
+     * Whether to copy files from the publicDir to the distDir on production build
+     * @default true
+     */
+    copyOnBuild?: boolean;
+    /**
+     * whether to watch the public directory and reload the page when the files change
+     * @default false
+     */
+    watch?: boolean;
+};
+export type PublicDir = false | PublicDirOptions | PublicDirOptions[];
+export interface ServerConfig {
+    /**
+     * Whether to enable gzip compression
+     */
+    compress?: boolean;
+    /**
+     * Serving static files from the directory (by default 'public' directory)
+     */
+    publicDir?: PublicDir;
+    /**
+     * Specify a port number for Rsbuild Server to listen.
+     */
+    port?: number;
+    /**
+     * After configuring this option, you can enable HTTPS Server, and disabling the HTTP Server.
+     */
+    https?: HttpsServerOptions | SecureServerSessionOptions;
+    /**
+     * Used to set the host of Rsbuild Server.
+     */
+    host?: string;
+    /**
+     * Adds headers to all responses.
+     */
+    headers?: Record<string, string | string[]>;
+    /**
+     * Whether to support html fallback.
+     */
+    htmlFallback?: HtmlFallback;
+    /**
+     * Provide alternative pages for some 404 responses or other requests.
+     * see https://github.com/bripkens/connect-history-api-fallback
+     */
+    historyApiFallback?: boolean | HistoryApiFallbackOptions;
+    /**
+     * Set the page URL to open when the server starts.
+     */
+    open?: boolean | string | string[] | {
+        target?: string | string[];
+        before?: () => Promise<void> | void;
+    };
+    /**
+     * Configure proxy rules for the dev server or preview server to proxy requests to the specified service.
+     */
+    proxy?: ProxyOptions;
+    /**
+     * Whether to throw an error when the port is occupied.
+     */
+    strictPort?: boolean;
+    /**
+     * Whether to print the server urls when the server is started.
+     */
+    printUrls?: PrintUrls;
+}
+export type NormalizedServerConfig = ServerConfig & Required<Pick<ServerConfig, 'htmlFallback' | 'port' | 'host' | 'compress' | 'strictPort' | 'printUrls' | 'open'>>;

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

@@ -0,0 +1,79 @@
+import type { RuleSetCondition } from '@rspack/core';
+import type { RsbuildEntry } from '../rsbuild';
+import type { ConfigChain } from '../utils';
+export type Alias = Record<string, string | false | (string | false)[]>;
+export type Define = Record<string, any>;
+export type AliasStrategy = 'prefer-tsconfig' | 'prefer-alias';
+export type Decorators = {
+    /**
+     * Specify the version of decorators to use.
+     * @default 'legacy''
+     */
+    version?: 'legacy' | '2022-03';
+};
+export interface SourceConfig {
+    /**
+     * Create aliases to import or require certain modules,
+     * same as the [resolve.alias](https://rspack.dev/config/resolve) config of Rspack.
+     */
+    alias?: ConfigChain<Alias>;
+    /**
+     * Used to control the priority between the `paths` option in `tsconfig.json`
+     * and the `alias` option in the bundler.
+     */
+    aliasStrategy?: AliasStrategy;
+    /**
+     * Specify directories or modules that need additional compilation.
+     * In order to maintain faster compilation speed, Rsbuild will not compile files under node_modules through
+     * `babel-loader` or `ts-loader` by default, as will as the files outside the current project directory.
+     */
+    include?: RuleSetCondition[];
+    /**
+     * Set the entry modules.
+     */
+    entry?: RsbuildEntry;
+    /**
+     * Specifies that certain files that will be excluded from compilation.
+     */
+    exclude?: RuleSetCondition[];
+    /**
+     * Add a script before the entry file of each page.
+     * This script will be executed before the page code.
+     * It can be used to execute global logics, such as polyfill injection.
+     */
+    preEntry?: string | string[];
+    /**
+     * Used to replaces variables in your code with other values or expressions at compile time.
+     */
+    define?: Define;
+    /**
+     * Configuring decorators syntax.
+     */
+    decorators?: Decorators;
+    /**
+     * Used to import the code and style of the component library on demand.
+     */
+    transformImport?: false | TransformImport[];
+    /**
+     * Configure a custom tsconfig.json file path to use, can be a relative or absolute path.
+     * @default 'tsconfig.json'
+     */
+    tsconfigPath?: string;
+}
+export type TransformImport = {
+    libraryName: string;
+    libraryDirectory?: string;
+    style?: string | boolean;
+    styleLibraryDirectory?: string;
+    camelToDashComponentName?: boolean;
+    transformToDefaultImport?: boolean;
+    customName?: any;
+    customStyleName?: any;
+};
+export interface NormalizedSourceConfig extends SourceConfig {
+    define: Define;
+    alias: ConfigChain<Alias>;
+    aliasStrategy: AliasStrategy;
+    preEntry: string[];
+    decorators: Required<Decorators>;
+}