@lynx-js/rspeedy 0.8.3 → 0.8.4

package/CHANGELOG.md

@@ -1,5 +1,34 @@
 # @lynx-js/rspeedy
 
+## 0.8.4
+
+### Patch Changes
+
+- Bump Rsbuild v1.2.19 with Rspack v1.2.8 ([#168](https://github.com/lynx-family/lynx-stack/pull/168))
+
+- Add `mergeRspeedyConfig` function for merging multiple Rspeedy configuration object. ([#169](https://github.com/lynx-family/lynx-stack/pull/169))
+
+- Bump Rsdoctor v1.0.0-rc.0 ([#186](https://github.com/lynx-family/lynx-stack/pull/186))
+
+- Support configure the base path of the server. ([#196](https://github.com/lynx-family/lynx-stack/pull/196))
+
+  By default, the base path of the server is `/`, and users can access lynx bundle through `http://<host>:<port>/main.lynx.bundle`
+  If you want to access lynx bundle through `http://<host>:<port>/foo/main.lynx.bundle`, you can change `server.base` to `/foo`
+
+  example:
+
+  ```js
+  import { defineConfig } from '@lynx-js/rspeedy'
+  export default defineConfig({
+    server: {
+      base: '/dist',
+    },
+  })
+  ```
+
+- Updated dependencies [[`b026c8b`](https://github.com/lynx-family/lynx-stack/commit/b026c8bdcbf7bdcda73e170477297213b447d876)]:
+  - @lynx-js/webpack-dev-transport@0.1.2
+
 ## 0.8.3
 
 ### Patch Changes

package/lib/config/mergeRspeedyConfig.d.ts

@@ -0,0 +1,36 @@
+import type { Config } from './index.js';
+/**
+ * Merge multiple Rspeedy configuration objects.
+ *
+ * @param configs - The Rspeedy configuration objects to merge.
+ *
+ * @returns The merged Rspeedy configuration object.
+ *
+ * @example
+ *
+ * ```ts
+ * import { mergeRspeedyConfig } from '@lynx-js/rspeedy';
+ *
+ * const config1 = {
+ *   dev: {
+ *     writeToDisk: false,
+ *   },
+ * };
+ * const config2 = {
+ *   dev: {
+ *     writeToDisk: true,
+ *   },
+ * };
+ *
+ * const mergedConfig = mergeRspeedyConfig(config1, config2);
+ *
+ * console.log(mergedConfig); // { dev: { writeToDisk: true } }
+ * ```
+ *
+ * @remarks
+ *
+ * This is actually an alias of {@link https://rsbuild.dev/api/javascript-api/core#mergersbuildconfig | mergeRsbuildConfig}.
+ *
+ * @public
+ */
+export declare function mergeRspeedyConfig(...configs: Config[]): Config;

package/lib/config/mergeRspeedyConfig.js

@@ -0,0 +1,42 @@
+// Copyright 2024 The Lynx Authors. All rights reserved.
+// Licensed under the Apache License Version 2.0 that can be found in the
+// LICENSE file in the root directory of this source tree.
+import { mergeRsbuildConfig } from '@rsbuild/core';
+/**
+ * Merge multiple Rspeedy configuration objects.
+ *
+ * @param configs - The Rspeedy configuration objects to merge.
+ *
+ * @returns The merged Rspeedy configuration object.
+ *
+ * @example
+ *
+ * ```ts
+ * import { mergeRspeedyConfig } from '@lynx-js/rspeedy';
+ *
+ * const config1 = {
+ *   dev: {
+ *     writeToDisk: false,
+ *   },
+ * };
+ * const config2 = {
+ *   dev: {
+ *     writeToDisk: true,
+ *   },
+ * };
+ *
+ * const mergedConfig = mergeRspeedyConfig(config1, config2);
+ *
+ * console.log(mergedConfig); // { dev: { writeToDisk: true } }
+ * ```
+ *
+ * @remarks
+ *
+ * This is actually an alias of {@link https://rsbuild.dev/api/javascript-api/core#mergersbuildconfig | mergeRsbuildConfig}.
+ *
+ * @public
+ */
+export function mergeRspeedyConfig(...configs) {
+    return mergeRsbuildConfig(...configs);
+}
+//# sourceMappingURL=mergeRspeedyConfig.js.map

package/lib/config/rsbuild/index.js

@@ -40,6 +40,7 @@ export function toRsbuildConfig(config) {
             tsconfigPath: config.source?.tsconfigPath,
         },
         server: {
+            base: config.server?.base,
             headers: config.server?.headers,
             host: config.server?.host,
             port: config.server?.port,

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

@@ -3,6 +3,28 @@
  * @public
  */
 export interface Server {
+    /**
+     * Configure the base path of the server.
+     *
+     * @remarks
+     * By default, the base path of the server is `/`, and users can access lynx bundle through `http://<host>:<port>/main.lynx.bundle`
+     *
+     * If you want to access lynx bundle through `http://<host>:<port>/foo/main.lynx.bundle`, you can change `server.base` to `/foo`
+     *
+     * you can refer to {@link https://rsbuild.dev/config/server/base | server.base } for more information.
+     *
+     * @example
+     *
+     * ```js
+     * import { defineConfig } from '@lynx-js/rspeedy'
+     * export default defineConfig({
+     *   server: {
+     *     base: '/dist'
+     *   },
+     * })
+     * ```
+     */
+    base?: string | undefined;
     /**
      * Adds headers to all responses.
      *