@lynx-js/rspeedy 0.11.0 → 0.11.2

package/CHANGELOG.md

@@ -1,5 +1,91 @@
 # @lynx-js/rspeedy
 
+## 0.11.2
+
+### Patch Changes
+
+- Support `server.proxy`. ([#1745](https://github.com/lynx-family/lynx-stack/pull/1745))
+
+- Support `command` and `env` parameters in the function exported by `lynx.config.js`. ([#1669](https://github.com/lynx-family/lynx-stack/pull/1669))
+
+  ```js
+  import { defineConfig } from '@lynx-js/rspeedy'
+
+  export default defineConfig(({ command, env }) => {
+    const isBuild = command === 'build'
+    const isTest = env === 'test'
+
+    return {
+      output: {
+        minify: !isTest,
+      },
+      performance: {
+        buildCache: isBuild,
+      },
+    }
+  })
+  ```
+
+- Support `resolve.dedupe`. ([#1671](https://github.com/lynx-family/lynx-stack/pull/1671))
+
+  This is useful when having multiple duplicated packages in the bundle:
+
+  ```js
+  import { defineConfig } from '@lynx-js/rspeedy'
+
+  export default defineConfig({
+    resolve: {
+      dedupe: ['tslib'],
+    },
+  })
+  ```
+
+- Support `resolve.aliasStrategy` for controlling priority between `tsconfig.json` paths and `resolve.alias` ([#1722](https://github.com/lynx-family/lynx-stack/pull/1722))
+
+  ```js
+  import { defineConfig } from '@lynx-js/rspeedy'
+
+  export default defineConfig({
+    resolve: {
+      alias: {
+        '@': './src',
+      },
+      // 'prefer-tsconfig' (default): tsconfig.json paths take priority
+      // 'prefer-alias': resolve.alias takes priority
+      aliasStrategy: 'prefer-alias',
+    },
+  })
+  ```
+
+- Bump Rsbuild v1.5.4 with Rspack v1.5.2. ([#1644](https://github.com/lynx-family/lynx-stack/pull/1644))
+
+- Updated dependencies [[`d7c5da3`](https://github.com/lynx-family/lynx-stack/commit/d7c5da329caddfb12ed77159fb8b1b8f38717cff)]:
+  - @lynx-js/chunk-loading-webpack-plugin@0.3.3
+  - @lynx-js/cache-events-webpack-plugin@0.0.2
+
+## 0.11.1
+
+### Patch Changes
+
+- Disable lazyCompilation by default. ([#1647](https://github.com/lynx-family/lynx-stack/pull/1647))
+
+- Bump Rsbuild v1.5.2 with Rspack v1.5.1. ([#1624](https://github.com/lynx-family/lynx-stack/pull/1624))
+
+- Add `output.dataUriLimit.*` for fine-grained control of asset inlining. ([#1648](https://github.com/lynx-family/lynx-stack/pull/1648))
+
+  ```js
+  import { defineConfig } from '@lynx-js/rspeedy'
+
+  export default defineConfig({
+    output: {
+      dataUriLimit: {
+        image: 5000,
+        media: 0,
+      },
+    },
+  })
+  ```
+
 ## 0.11.0
 
 ### Minor Changes

package/dist/index.d.ts

@@ -16,10 +16,12 @@
  */
 
 import type { CreateRsbuildOptions } from '@rsbuild/core';
+import type { DataUriLimit } from '@rsbuild/core';
 import type { DistPathConfig } from '@rsbuild/core';
 import type { InlineChunkConfig } from '@rsbuild/core';
 import { logger } from '@rsbuild/core';
 import type { PerformanceConfig } from '@rsbuild/core';
+import type { ProxyConfig } from '@rsbuild/core';
 import type { RsbuildConfig } from '@rsbuild/core';
 import type { RsbuildInstance } from '@rsbuild/core';
 import { RsbuildPlugin } from '@rsbuild/core';
@@ -442,6 +444,42 @@ export declare interface Config {
     plugins?: RsbuildPlugins | undefined;
 }
 
+/**
+ *  Parameters for the function exported from `lynx.config.js`.
+ *
+ * @public
+ */
+export declare interface ConfigParams {
+    /**
+     * The value of `process.env['NODE_ENV']`
+     *
+     * @remarks
+     * Common values include (non-exhaustive):
+     * - `'production'`
+     *
+     * - `'development'`
+     *
+     * - `'test'`
+     */
+    env: 'production' | 'development' | 'test' | (string & Record<never, never>);
+    /**
+     * The CLI command of Rspeedy.
+     *
+     * @remarks
+     *
+     * Possible values:
+     *
+     * - `'build'`
+     *
+     * - `'dev'`
+     *
+     * - `'inspect'`
+     *
+     * - `'preview'`
+     */
+    command: 'build' | 'dev' | 'inspect' | 'preview' | (string & Record<never, never>);
+}
+
 /**
  * The type of the console method.
  *
@@ -913,9 +951,26 @@ export declare function defineConfig(config: Config): Config;
  * })
  * ```
  *
+ * @example
+ *
+ * Use `defineConfig` with parameters in `lynx.config.ts`:
+ *
+ * ```ts
+ * import { defineConfig } from '@lynx-js/rspeedy'
+ *
+ * export default defineConfig(({ env }) => {
+ *   const isTest = env === 'test'
+ *   return {
+ *     output: {
+ *       minify: isTest ? false : true,
+ *     },
+ *   }
+ * })
+ * ```
+ *
  * @public
  */
-export declare function defineConfig(config: () => Config): () => Config;
+export declare function defineConfig(config: (params: ConfigParams) => Config): (params: ConfigParams) => Config;
 
 /**
  * The `defineConfig` method is a helper function used to get TypeScript intellisense.
@@ -961,9 +1016,27 @@ export declare function defineConfig(config: Promise<Config>): Promise<Config>;
  * })
  * ```
  *
+ * @example
+ *
+ * Use `defineConfig` with parameters in `lynx.config.ts`:
+ *
+ * ```ts
+ * import { defineConfig } from '@lynx-js/rspeedy'
+ *
+ * export default defineConfig(async ({ env }) => {
+ *   const foo = await bar()
+ *   const isTest = env === 'test'
+ *   return {
+ *     output: {
+ *       minify: isTest ? false : true,
+ *     },
+ *   }
+ * })
+ * ```
+ *
  * @public
  */
-export declare function defineConfig(config: () => Promise<Config>): () => Promise<Config>;
+export declare function defineConfig(config: (params: ConfigParams) => Promise<Config>): (params: ConfigParams) => Promise<Config>;
 
 /**
  * {@inheritdoc Config.dev}
@@ -1988,8 +2061,25 @@ export declare interface Output {
      *   },
      * })
      * ```
+     *
+     * @example
+     *
+     * Disable inlining of all media but not images.
+     *
+     * ```ts title="lynx.config.ts"
+     * import { defineConfig } from '@lynx-js/rspeedy'
+     *
+     * export default defineConfig({
+     *   output: {
+     *     dataUriLimit: {
+     *       image: 5000,
+     *       media: 0,
+     *     },
+     *   },
+     * })
+     * ```
      */
-    dataUriLimit?: number | undefined;
+    dataUriLimit?: number | DataUriLimit | undefined;
     /**
      * Set the directory of the dist files.
      *
@@ -2452,6 +2542,54 @@ export declare interface Resolve {
      * ```
      */
     alias?: Record<string, string | false | string[]> | undefined;
+    /**
+     * Set the strategy for path alias resolution, to control the priority relationship
+     * between the `paths` option in `tsconfig.json` and the `resolve.alias` option of Rsbuild.
+     * - `prefer-tsconfig` (default): The `paths` option in `tsconfig.json` will take precedence over the
+     * `resolve.alias` option of Rsbuild.
+     * - `prefer-alias`: The `resolve.alias` option of Rsbuild will take precedence over the
+     * `paths` option in `tsconfig.json`.
+     *
+     * @example
+     *
+     * ```js
+     * import { defineConfig } from '@lynx-js/rspeedy'
+     *
+     * export default defineConfig({
+     *   resolve: {
+     *     alias: {
+     *       '@': './src',
+     *     },
+     *     aliasStrategy: 'prefer-alias',
+     *   },
+     * })
+     * ```
+     */
+    aliasStrategy?: 'prefer-tsconfig' | 'prefer-alias' | undefined;
+    /**
+     * Force to resolve the specified packages from project root, which is useful for deduplicating packages and reducing the bundle size.
+     *
+     * @remarks
+     *
+     * {@link Resolve.dedupe} is implemented based on {@link Resolve.alias}, it will get the path of the specified package through `require.resolve` in the project root directory and set it to the alias.
+     *
+     * The alias generated by {@link Resolve.dedupe} will be merged with the configured {@link Resolve.alias} in the project, and the {@link Resolve.alias} config will take precedence when the keys are the same.
+     *
+     * @example
+     *
+     * Use `tslib` from the project root directory.
+     *
+     * ```js
+     * import { defineConfig } from '@lynx-js/rspeedy'
+     *
+     * export default defineConfig({
+     *   resolve: {
+     *     dedupe: ['tslib'],
+     *   },
+     * })
+     * ```
+     */
+    dedupe?: string[] | undefined;
 }
 
 export { RsbuildPlugin }
@@ -2561,6 +2699,24 @@ export declare interface Server {
      * ```
      */
     port?: number | undefined;
+    /**
+     * Configure proxy rules for the dev server or preview server to proxy requests to the specified service.
+     *
+     * @example
+     *
+     * ```js
+     * export default {
+     *   server: {
+     *     proxy: {
+     *       // http://localhost:3000/api -> http://localhost:3000/api
+     *       // http://localhost:3000/api/foo -> http://localhost:3000/api/foo
+     *       '/api': 'http://localhost:3000',
+     *     },
+     *   },
+     * }
+     * ```
+     */
+    proxy?: ProxyConfig | undefined;
     /**
      * When a port is occupied, Rspeedy will automatically increment the port number until an available port is found.
      *
@@ -2978,7 +3134,7 @@ export declare interface Source {
      *
      * - The `paths` field is used to configure {@link Source.alias | Path Aliases}.
      *
-     * - Sets the scope and rules for the {@link https://rsbuild.dev/plugins/list/plugin-type-check | Type Check Plugin}.
+     * - Sets the scope and rules for the {@link https://rsbuild.rs/guide/basic/typescript#type-checking | Type Check Plugin}.
      *
      * @example
      *

package/dist/index.js

@@ -108,7 +108,7 @@ var __webpack_modules__ = {
         });
         var core_ = __webpack_require__("@rsbuild/core");
         var package_namespaceObject = {
-            rE: "0.11.0"
+            rE: "0.11.2"
         };
         const version = package_namespaceObject.rE;
         const rspackVersion = core_.rspack.rspackVersion;
@@ -318,6 +318,7 @@ const defaultDataUriLimit = 2048;
 function toRsbuildConfig(config) {
     return {
         dev: {
+            lazyCompilation: false,
             watchFiles: config.dev?.watchFiles,
             writeToDisk: config.dev?.writeToDisk ?? true,
             progressBar: config.dev?.progressBar ?? true
@@ -341,7 +342,9 @@ function toRsbuildConfig(config) {
             sourceMap: config.output?.sourceMap
         },
         resolve: {
-            alias: config.resolve?.alias
+            alias: config.resolve?.alias,
+            aliasStrategy: config.resolve?.aliasStrategy,
+            dedupe: config.resolve?.dedupe
         },
         source: {
             alias: config.source?.alias,
@@ -360,6 +363,7 @@ function toRsbuildConfig(config) {
             headers: config.server?.headers,
             host: config.server?.host,
             port: config.server?.port,
+            proxy: config.server?.proxy,
             strictPort: config.server?.strictPort
         },
         plugins: config.plugins,
@@ -467,10 +471,14 @@ async function loadConfig(loadConfigOptions) {
             import(`${specifier}?t=${Date.now()}`),
             __webpack_require__.e("src_config_validate_ts").then(__webpack_require__.bind(__webpack_require__, "./src/config/validate.ts"))
         ]);
-        const content = validate('default' in exports ? exports.default : exports, configPath);
+        const configExport = 'default' in exports ? exports.default : exports;
+        const rawContent = 'function' == typeof configExport ? await configExport({
+            command: process.argv[2] ?? 'build',
+            env: process.env['NODE_ENV'] ?? 'production'
+        }) : await configExport;
         return {
             configPath,
-            content: 'function' == typeof content ? await content() : await content
+            content: validate(rawContent, configPath)
         };
     } finally{
         unregister();

package/dist/src_cli_build_ts.js

@@ -99,10 +99,14 @@ export const __webpack_modules__ = {
                     import(`${specifier}?t=${Date.now()}`),
                     __webpack_require__.e("src_config_validate_ts").then(__webpack_require__.bind(__webpack_require__, "./src/config/validate.ts"))
                 ]);
-                const content = validate('default' in exports ? exports.default : exports, configPath);
+                const configExport = 'default' in exports ? exports.default : exports;
+                const rawContent = 'function' == typeof configExport ? await configExport({
+                    command: process.argv[2] ?? 'build',
+                    env: process.env['NODE_ENV'] ?? 'production'
+                }) : await configExport;
                 return {
                     configPath,
-                    content: 'function' == typeof content ? await content() : await content
+                    content: validate(rawContent, configPath)
                 };
             } finally{
                 unregister();
@@ -298,6 +302,7 @@ export const __webpack_modules__ = {
         function toRsbuildConfig(config) {
             return {
                 dev: {
+                    lazyCompilation: false,
                     watchFiles: config.dev?.watchFiles,
                     writeToDisk: config.dev?.writeToDisk ?? true,
                     progressBar: config.dev?.progressBar ?? true
@@ -321,7 +326,9 @@ export const __webpack_modules__ = {
                     sourceMap: config.output?.sourceMap
                 },
                 resolve: {
-                    alias: config.resolve?.alias
+                    alias: config.resolve?.alias,
+                    aliasStrategy: config.resolve?.aliasStrategy,
+                    dedupe: config.resolve?.dedupe
                 },
                 source: {
                     alias: config.source?.alias,
@@ -340,6 +347,7 @@ export const __webpack_modules__ = {
                     headers: config.server?.headers,
                     host: config.server?.host,
                     port: config.server?.port,
+                    proxy: config.server?.proxy,
                     strictPort: config.server?.strictPort
                 },
                 plugins: config.plugins,

package/dist/src_cli_commands_ts.js

@@ -41,7 +41,7 @@ export const __webpack_modules__ = {
         });
         var core_ = __webpack_require__("@rsbuild/core");
         var package_namespaceObject = {
-            rE: "0.11.0"
+            rE: "0.11.2"
         };
         const version = package_namespaceObject.rE;
         const rspackVersion = core_.rspack.rspackVersion;

package/dist/src_cli_dev_ts.js

@@ -91,10 +91,14 @@ export const __webpack_modules__ = {
                     import(`${specifier}?t=${Date.now()}`),
                     __webpack_require__.e("src_config_validate_ts").then(__webpack_require__.bind(__webpack_require__, "./src/config/validate.ts"))
                 ]);
-                const content = validate('default' in exports ? exports.default : exports, configPath);
+                const configExport = 'default' in exports ? exports.default : exports;
+                const rawContent = 'function' == typeof configExport ? await configExport({
+                    command: process.argv[2] ?? 'build',
+                    env: process.env['NODE_ENV'] ?? 'production'
+                }) : await configExport;
                 return {
                     configPath,
-                    content: 'function' == typeof content ? await content() : await content
+                    content: validate(rawContent, configPath)
                 };
             } finally{
                 unregister();
@@ -290,6 +294,7 @@ export const __webpack_modules__ = {
         function toRsbuildConfig(config) {
             return {
                 dev: {
+                    lazyCompilation: false,
                     watchFiles: config.dev?.watchFiles,
                     writeToDisk: config.dev?.writeToDisk ?? true,
                     progressBar: config.dev?.progressBar ?? true
@@ -313,7 +318,9 @@ export const __webpack_modules__ = {
                     sourceMap: config.output?.sourceMap
                 },
                 resolve: {
-                    alias: config.resolve?.alias
+                    alias: config.resolve?.alias,
+                    aliasStrategy: config.resolve?.aliasStrategy,
+                    dedupe: config.resolve?.dedupe
                 },
                 source: {
                     alias: config.source?.alias,
@@ -332,6 +339,7 @@ export const __webpack_modules__ = {
                     headers: config.server?.headers,
                     host: config.server?.host,
                     port: config.server?.port,
+                    proxy: config.server?.proxy,
                     strictPort: config.server?.strictPort
                 },
                 plugins: config.plugins,

package/dist/src_cli_inspect_ts.js

@@ -56,10 +56,14 @@ export const __webpack_modules__ = {
                     import(`${specifier}?t=${Date.now()}`),
                     __webpack_require__.e("src_config_validate_ts").then(__webpack_require__.bind(__webpack_require__, "./src/config/validate.ts"))
                 ]);
-                const content = validate('default' in exports ? exports.default : exports, configPath);
+                const configExport = 'default' in exports ? exports.default : exports;
+                const rawContent = 'function' == typeof configExport ? await configExport({
+                    command: process.argv[2] ?? 'build',
+                    env: process.env['NODE_ENV'] ?? 'production'
+                }) : await configExport;
                 return {
                     configPath,
-                    content: 'function' == typeof content ? await content() : await content
+                    content: validate(rawContent, configPath)
                 };
             } finally{
                 unregister();
@@ -236,6 +240,7 @@ export const __webpack_modules__ = {
         function toRsbuildConfig(config) {
             return {
                 dev: {
+                    lazyCompilation: false,
                     watchFiles: config.dev?.watchFiles,
                     writeToDisk: config.dev?.writeToDisk ?? true,
                     progressBar: config.dev?.progressBar ?? true
@@ -259,7 +264,9 @@ export const __webpack_modules__ = {
                     sourceMap: config.output?.sourceMap
                 },
                 resolve: {
-                    alias: config.resolve?.alias
+                    alias: config.resolve?.alias,
+                    aliasStrategy: config.resolve?.aliasStrategy,
+                    dedupe: config.resolve?.dedupe
                 },
                 source: {
                     alias: config.source?.alias,
@@ -278,6 +285,7 @@ export const __webpack_modules__ = {
                     headers: config.server?.headers,
                     host: config.server?.host,
                     port: config.server?.port,
+                    proxy: config.server?.proxy,
                     strictPort: config.server?.strictPort
                 },
                 plugins: config.plugins,

package/dist/src_cli_preview_ts.js

@@ -56,10 +56,14 @@ export const __webpack_modules__ = {
                     import(`${specifier}?t=${Date.now()}`),
                     __webpack_require__.e("src_config_validate_ts").then(__webpack_require__.bind(__webpack_require__, "./src/config/validate.ts"))
                 ]);
-                const content = validate('default' in exports ? exports.default : exports, configPath);
+                const configExport = 'default' in exports ? exports.default : exports;
+                const rawContent = 'function' == typeof configExport ? await configExport({
+                    command: process.argv[2] ?? 'build',
+                    env: process.env['NODE_ENV'] ?? 'production'
+                }) : await configExport;
                 return {
                     configPath,
-                    content: 'function' == typeof content ? await content() : await content
+                    content: validate(rawContent, configPath)
                 };
             } finally{
                 unregister();
@@ -238,6 +242,7 @@ export const __webpack_modules__ = {
         function toRsbuildConfig(config) {
             return {
                 dev: {
+                    lazyCompilation: false,
                     watchFiles: config.dev?.watchFiles,
                     writeToDisk: config.dev?.writeToDisk ?? true,
                     progressBar: config.dev?.progressBar ?? true
@@ -261,7 +266,9 @@ export const __webpack_modules__ = {
                     sourceMap: config.output?.sourceMap
                 },
                 resolve: {
-                    alias: config.resolve?.alias
+                    alias: config.resolve?.alias,
+                    aliasStrategy: config.resolve?.aliasStrategy,
+                    dedupe: config.resolve?.dedupe
                 },
                 source: {
                     alias: config.source?.alias,
@@ -280,6 +287,7 @@ export const __webpack_modules__ = {
                     headers: config.server?.headers,
                     host: config.server?.host,
                     port: config.server?.port,
+                    proxy: config.server?.proxy,
                     strictPort: config.server?.strictPort
                 },
                 plugins: config.plugins,