@lynx-js/rspeedy 0.8.6 → 0.8.7

package/CHANGELOG.md

@@ -1,5 +1,23 @@
 # @lynx-js/rspeedy
 
+## 0.8.7
+
+### Patch Changes
+
+- Support using `-debugids` in `output.sourceMap.js`. ([#342](https://github.com/lynx-family/lynx-stack/pull/342))
+
+  See [Source Map Debug ID Proposal](https://github.com/tc39/ecma426/blob/main/proposals/debug-id.md) for more details.
+
+- Use `chunkLoading: 'import-scripts'` for Web platform ([#352](https://github.com/lynx-family/lynx-stack/pull/352))
+
+- Support `output.distPath.*`. ([#366](https://github.com/lynx-family/lynx-stack/pull/366))
+
+  See [Rsbuild - distPath](https://rsbuild.dev/config/output/dist-path) for all available options.
+
+- Support `performance.printFileSize` ([#336](https://github.com/lynx-family/lynx-stack/pull/336))
+
+  Whether to print the file sizes after production build.
+
 ## 0.8.6
 
 ### Patch Changes

package/lib/config/output/dist-path.d.ts

@@ -1,39 +1,10 @@
+import type { DistPathConfig } from '@rsbuild/core';
 /**
  * {@inheritdoc Output.distPath}
  *
  * @public
  */
-export interface DistPath {
-    /**
-     * The root directory of all output files.
-     *
-     * @remarks
-     *
-     * Default value:
-     *
-     * - `'dist'`
-     */
-    root?: string | undefined;
-    /**
-     * The output directory of CSS style files.
-     *
-     * @remarks
-     *
-     * Default value:
-     *
-     * - The same as {@link DistPath.intermediate}
-     */
-    css?: string | undefined;
-    /**
-     * The output directory of async JavaScript files.
-     *
-     * @remarks
-     *
-     * Default value:
-     *
-     * - The `async` subdirectory of {@link DistPath.css}.
-     */
-    cssAsync?: string | undefined;
+export interface DistPath extends DistPathConfig {
     /**
      * The output directory of the intermediate files.
      *
@@ -44,25 +15,5 @@ export interface DistPath {
      * - `'.rspeedy'`
      */
     intermediate?: string | undefined;
-    /**
-     * The output directory of JavaScript files.
-     *
-     * @remarks
-     *
-     * Default value:
-     *
-     * - `'static/js'`
-     */
-    js?: string | undefined;
-    /**
-     * The output directory of async JavaScript files.
-     *
-     * @remarks
-     *
-     * Default value:
-     *
-     * - The `async` subdirectory of {@link DistPath.js}.
-     */
-    jsAsync?: string | undefined;
 }
 export declare const DEFAULT_DIST_PATH_INTERMEDIATE = ".rspeedy";

package/lib/config/output/index.d.ts

@@ -42,7 +42,7 @@ export interface Output {
      *
      * By default, if the output directory is a subdirectory of the project root path, Rspeedy will automatically clean all files in the build directory.
      *
-     * When {@link DistPath.root | output.distPath.root} is an external directory or the same as the project root directory, `cleanDistPath` is not enabled by default to prevent accidental deletion of files from other directories.
+     * When {@link https://rsbuild.dev/config/output/dist-path#root-directory | output.distPath.root} is an external directory or the same as the project root directory, `cleanDistPath` is not enabled by default to prevent accidental deletion of files from other directories.
      *
      * @example
      *
@@ -200,6 +200,10 @@ export interface Output {
     /**
      * Set the directory of the dist files.
      *
+     * @remarks
+     *
+     * More options can be found at {@link https://rsbuild.dev/config/output/dist-path | Rsbuild - distPath}.
+     *
      * @example
      *
      * Use `output` instead of `dist`(the default value):

package/lib/config/output/source-map.d.ts

@@ -64,5 +64,5 @@ export interface SourceMap {
      * })
      * ```
      */
-    js?: Rspack.DevTool | undefined;
+    js?: Rspack.DevTool | undefined | `${Exclude<Rspack.DevTool, false | 'eval'>}-debugids`;
 }

package/lib/config/performance/index.d.ts

@@ -1,3 +1,4 @@
+import type { PerformanceConfig } from '@rsbuild/core';
 import type { ChunkSplit, ChunkSplitBySize, ChunkSplitCustom } from './chunk-split.js';
 /**
  * The type of the console method.
@@ -47,4 +48,118 @@ export interface Performance {
      * ```
      */
     removeConsole?: boolean | ConsoleType[] | undefined;
+    /**
+     * Whether to print the file sizes after production build.
+     *
+     * {@link Performance.printFileSize}
+     *
+     * See {@link https://rsbuild.dev/config/performance/print-file-size | Rsbuild - performance.printFileSize} for details.
+     *
+     * @example
+     *
+     * If you don't want to print any information, you can disable it by setting printFileSize to false:
+     *
+     * ```ts
+     * import { defineConfig } from '@lynx-js/rspeedy'
+     *
+     * export default defineConfig({
+     *   performance: {
+     *     printFileSize: false
+     *   },
+     * })
+     * ```
+     *
+     * @example
+     *
+     * Set total to false to disable total size output.
+     *
+     * ```ts
+     * import { defineConfig } from '@lynx-js/rspeedy'
+     *
+     * export default defineConfig({
+     *   performance: {
+     *     printFileSize: {
+     *       total: false,
+     *     },
+     *   },
+     * })
+     * ```
+     *
+     * @example
+     *
+     * Set detail to false to disable per-asset size output.
+     *
+     * If you don't need to view the size of each static asset, you can set detail to false. In this case, only the total size will be output:
+     *
+     * ```ts
+     * import { defineConfig } from '@lynx-js/rspeedy'
+     *
+     * export default defineConfig({
+     *   performance: {
+     *     printFileSize: {
+     *       detail: false,
+     *     },
+     *   },
+     * })
+     * ```
+     *
+     * @example
+     *
+     * If you don't need to view the gzipped size, you can set compressed to false. This can save some gzip computation time for large projects:
+     *
+     * ```ts
+     * import { defineConfig } from '@lynx-js/rspeedy'
+     *
+     * export default defineConfig({
+     *   performance: {
+     *     printFileSize: {
+     *       compressed: false,
+     *     },
+     *   },
+     * })
+     * ```
+     *
+     * @example
+     *
+     * To include only static assets that meet certain criteria, use a filter function with include.
+     *
+     * If returned false, the static asset will be excluded and not included in the total size or detailed size.
+     *
+     * only output static assets larger than 10kB:
+     *
+     * ```ts
+     * import { defineConfig } from '@lynx-js/rspeedy'
+     *
+     * export default defineConfig({
+     *   performance: {
+     *     printFileSize: {
+     *       include: (asset) => asset.size > 10 * 1000,
+     *     }
+     *   },
+     * })
+     * ```
+     *
+     * @example
+     *
+     * To exclude static assets that meet certain criteria, use a filter function with exclude. If both include and exclude are set, exclude will take precedence.
+     *
+     * Rspeedy defaults to excluding source map, license files, and .d.ts type files, as these files do not affect page load performance.
+     *
+     * exclude .html files in addition to the default:
+     *
+     * ```ts
+     * import { defineConfig } from '@lynx-js/rspeedy'
+     *
+     * export default defineConfig({
+     *   performance: {
+     *     printFileSize: {
+     *       exclude: (asset) =>
+     *         /\.(?:map|LICENSE\.txt)$/.test(asset.name) ||
+     *         /\.html$/.test(asset.name),
+     *     }
+     *   },
+     * })
+     * ```
+     */
+    printFileSize?: PerformanceConfig['printFileSize'] | undefined;
 }

package/lib/config/rsbuild/index.js

@@ -27,6 +27,7 @@ export function toRsbuildConfig(config) {
             // We expect to use different default legalComments with Rsbuild
             legalComments: config.output?.legalComments ?? 'none',
             polyfill: 'off',
+            // TODO: update the Rsbuild type to allow `sourceMap.js` to be `*-debugids`
             sourceMap: config.output?.sourceMap,
         },
         source: {
@@ -51,6 +52,7 @@ export function toRsbuildConfig(config) {
         performance: {
             chunkSplit: config.performance?.chunkSplit,
             removeConsole: toRsbuildRemoveConsole(config),
+            printFileSize: config.performance?.printFileSize ?? true,
         },
         tools: {
             bundlerChain: config.tools?.bundlerChain,

package/lib/config/server/index.d.ts

@@ -44,6 +44,22 @@ export interface Server {
     headers?: Record<string, string | string[]> | undefined;
     /**
      * Specify the host that the Rspeedy Server listens to.
+     *
+     * @remarks
+     * By default, the server listens on local network IP, for example, `192.168.1.50`, verify your local net IP by the command `ifconfig` on your system for (en0 for MacOS and eth0 for LinuxOS users). In case you have multiple local network IP(s) particularly when you are running dockers on the host machine, then you can specify your desired host IP.
+     *
+     * @example
+     *
+     * Set the host to a custom value:
+     *
+     * ```js
+     * import { defineConfig } from '@lynx-js/rspeedy'
+     * export default defineConfig({
+     *   server: {
+     *     host: "192.168.1.50",
+     *   },
+     * })
+     * ```
      */
     host?: string | undefined;
     /**