@lynx-js/rspeedy 0.8.7 → 0.9.1

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

@@ -1,165 +0,0 @@
-import type { PerformanceConfig } from '@rsbuild/core';
-import type { ChunkSplit, ChunkSplitBySize, ChunkSplitCustom } from './chunk-split.js';
-/**
- * The type of the console method.
- *
- * @public
- */
-export type ConsoleType = 'log' | 'warn' | 'error' | 'info' | 'debug' | 'profile' | 'profileEnd' | (string & Record<never, never>);
-/**
- * {@inheritdoc Config.performance}
- *
- * @public
- */
-export interface Performance {
-    /**
-     * {@link Performance.chunkSplit} is used to configure the chunk splitting strategy.
-     */
-    chunkSplit?: ChunkSplit | ChunkSplitBySize | ChunkSplitCustom | undefined;
-    /**
-     * Whether to remove `console.[methodName]` in production build.
-     *
-     * @example
-     *
-     * - Remove all `console` methods
-     *
-     * ```ts
-     * import { defineConfig } from '@lynx-js/rspeedy'
-     *
-     * export default defineConfig({
-     *   performance: {
-     *     removeConsole: true,
-     *   },
-     * })
-     * ```
-     *
-     * @example
-     *
-     * - Remove specific `console` methods
-     *
-     * ```ts
-     * import { defineConfig } from '@lynx-js/rspeedy'
-     *
-     * export default defineConfig({
-     *   performance: {
-     *     removeConsole: ['log', 'warn']
-     *   },
-     * })
-     * ```
-     */
-    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/performance/index.js

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=index.js.map

package/lib/config/rsbuild/entry.d.ts

@@ -1,3 +0,0 @@
-import type { RsbuildEntry } from '@rsbuild/core';
-import type { Entry } from '../source/entry.js';
-export declare function toRsbuildEntry(entry: Entry | undefined): RsbuildEntry;

package/lib/config/rsbuild/entry.js

@@ -1,31 +0,0 @@
-import { debug, debugList } from '../../debug.js';
-const DEFAULT_ENTRY = './src/index.js';
-export function toRsbuildEntry(entry) {
-    // Default value
-    if (entry === undefined) {
-        debug(`Using default entry ${DEFAULT_ENTRY}`);
-        return {
-            main: DEFAULT_ENTRY,
-        };
-    }
-    // Single entry
-    if (Array.isArray(entry) || typeof entry === 'string') {
-        debug(() => `Using single entry ${[''].concat(entry).join('\n    - ')}`);
-        return { main: entry };
-    }
-    return Object.fromEntries(Object.entries(entry).map(([key, value]) => {
-        if (Array.isArray(value) || typeof value === 'string') {
-            debugList(`Using multiple entries - ${key}`, value);
-            return [key, { import: value }];
-        }
-        debugList(`Using multiple entries - ${key}`, value.import ?? DEFAULT_ENTRY);
-        if (value.import === undefined) {
-            return [
-                key,
-                { ...value, import: DEFAULT_ENTRY },
-            ];
-        }
-        return [key, value];
-    }));
-}
-//# sourceMappingURL=entry.js.map

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

@@ -1,4 +0,0 @@
-import type { RsbuildConfig } from '@rsbuild/core';
-import type { UndefinedOnPartialDeep } from 'type-fest';
-import type { Config } from '../index.js';
-export declare function toRsbuildConfig(config: Config): UndefinedOnPartialDeep<RsbuildConfig>;

package/lib/config/rsbuild/index.js

@@ -1,75 +0,0 @@
-import { toRsbuildEntry } from './entry.js';
-// This is the default value from lynx-speedy.
-// We may change it based on new benchmarks.
-const defaultDataUriLimit = 2 * 1024;
-export function toRsbuildConfig(config) {
-    return {
-        provider: config.provider,
-        dev: {
-            watchFiles: config.dev?.watchFiles,
-            // We expect to use different default writeToDisk with Rsbuild
-            writeToDisk: config.dev?.writeToDisk ?? true,
-            progressBar: config.dev?.progressBar ?? true,
-        },
-        environments: config.environments ?? { lynx: {} },
-        mode: config.mode,
-        output: {
-            assetPrefix: config.output?.assetPrefix,
-            charset: 'utf8',
-            cleanDistPath: config.output?.cleanDistPath,
-            copy: config.output?.copy,
-            cssModules: config.output?.cssModules,
-            // We expect to use different default dataUriLimit with Rsbuild
-            dataUriLimit: config.output?.dataUriLimit ?? defaultDataUriLimit,
-            distPath: config.output?.distPath,
-            filenameHash: config.output?.filenameHash,
-            // TODO(OSS): change the default value to `linked`(or `undefined`) when OSS.
-            // 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: {
-            alias: config.source?.alias,
-            assetsInclude: config.source?.assetsInclude,
-            decorators: config.source?.decorators,
-            define: config.source?.define,
-            entry: toRsbuildEntry(config.source?.entry),
-            exclude: config.source?.exclude,
-            include: config.source?.include,
-            transformImport: config.source?.transformImport,
-            tsconfigPath: config.source?.tsconfigPath,
-        },
-        server: {
-            base: config.server?.base,
-            headers: config.server?.headers,
-            host: config.server?.host,
-            port: config.server?.port,
-            strictPort: config.server?.strictPort,
-        },
-        plugins: config.plugins,
-        performance: {
-            chunkSplit: config.performance?.chunkSplit,
-            removeConsole: toRsbuildRemoveConsole(config),
-            printFileSize: config.performance?.printFileSize ?? true,
-        },
-        tools: {
-            bundlerChain: config.tools?.bundlerChain,
-            cssExtract: config.tools?.cssExtract,
-            cssLoader: config.tools?.cssLoader,
-            htmlPlugin: false,
-            rspack: config.tools?.rspack,
-            swc: config.tools?.swc,
-        },
-    };
-}
-function toRsbuildRemoveConsole(config) {
-    if (config.performance?.removeConsole === true) {
-        // Lynx use console as a parameter in the runtime-wrapper
-        // So we need to use all the console methods instead of `true` to make sure Rsbuild can remove all the console methods
-        return ['log', 'warn', 'error', 'info', 'debug', 'profile', 'profileEnd'];
-    }
-    return config.performance?.removeConsole;
-}
-//# sourceMappingURL=index.js.map

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

@@ -1,91 +0,0 @@
-/**
- * {@inheritdoc Config.server}
- * @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.
-     *
-     * @example
-     *
-     * ```js
-     * import { defineConfig } from '@lynx-js/rspeedy'
-     * export default defineConfig({
-     *   server: {
-     *     headers: {
-     *       'Access-Control-Allow-Origin': '**',
-     *     },
-     *   },
-     * })
-     * ```
-     */
-    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;
-    /**
-     * Specify the port that the Rspeedy Server listens to.
-     *
-     * @remarks
-     * By default, the server listens on port `3000` and automatically increments the port number when the port is occupied.
-     *
-     * @example
-     *
-     * Set the port to a custom value:
-     *
-     * ```js
-     * import { defineConfig } from '@lynx-js/rspeedy'
-     * export default defineConfig({
-     *   server: {
-     *     port: 3470,
-     *   },
-     * })
-     * ```
-     */
-    port?: number | undefined;
-    /**
-     * When a port is occupied, Rspeedy will automatically increment the port number until an available port is found.
-     *
-     * Set strictPort to true and Rspeedy will throw an exception when the port is occupied.
-     */
-    strictPort?: boolean | undefined;
-}

package/lib/config/server/index.js

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=index.js.map

package/lib/config/source/decorators.d.ts

@@ -1,43 +0,0 @@
-/**
- * {@inheritdoc Source.decorators}
- *
- * @public
- */
-export interface Decorators {
-    /**
-     * Specify the decorator syntax version to be used.
-     *
-     * @remarks
-     *
-     * If you want to know the differences between different decorators versions, you can refer to: {@link https://github.com/tc39/proposal-decorators?tab=readme-ov-file#how-does-this-proposal-compare-to-other-versions-of-decorators | How does this proposal compare to other versions of decorators?}
-     *
-     * @example
-     *
-     * `'2022-03'` corresponds to the Stage 3 decorator proposal, equivalent to the decorator syntax supported by TypeScript 5.0 by default.
-     *
-     * ```js
-     * import { defineConfig } from '@lynx-js/rspeedy'
-     *
-     * export default defineConfig({
-     *   source: {
-     *     decorators: { version: '2022-03' },
-     *   },
-     * })
-     * ```
-     *
-     * @example
-     *
-     * `'legacy'` corresponds to TypeScript's `experimentalDecorators: true`.
-     *
-     * ```js
-     * import { defineConfig } from '@lynx-js/rspeedy'
-     *
-     * export default defineConfig({
-     *   source: {
-     *     decorators: { version: 'legacy' },
-     *   },
-     * })
-     * ```
-     */
-    version?: 'legacy' | '2022-03';
-}

package/lib/config/source/decorators.js

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=decorators.js.map

package/lib/config/source/entry.d.ts

@@ -1,84 +0,0 @@
-/**
- * The `EntryDescription` describes a entry. It is useful when the project has multiple entries with different configuration.
- *
- * @remarks
- * It is similar with the {@link https://www.rspack.dev/config/entry#entry-description-object | Entry Description Object} of Rspack.
- * But only a few properties that Lynx supports is allowed.
- *
- * @public
- */
-export interface EntryDescription {
-    /**
-     * The path to the entry module(s).
-     *
-     * @remarks
-     *
-     * If no value is provided, the default value `src/index.js` will be used.
-     *
-     * @defaultValue `'./src/index.js'`
-     */
-    import?: string | string[] | undefined;
-    /**
-     * This is an important option when using on-demand-loading or loading external resources like images, files, etc. If an incorrect value is specified you'll receive 404 errors while loading these resources.
-     *
-     * @see https://webpack.js.org/configuration/output/#outputpublicpath
-     */
-    publicPath?: string | undefined;
-}
-/**
- * {@inheritdoc Source.entry}
- *
- * @example
- *
- * - Use a single entry:
- *
- * ```js
- * import { defineConfig } from '@lynx-js/rspeedy'
- * export default defineConfig({
- *   entry: './src/pages/main/index.js',
- * })
- * ```
- *
- * @example
- *
- * - Use a single entry with multiple entry modules:
- *
- * ```js
- * import { defineConfig } from '@lynx-js/rspeedy'
- * export default defineConfig({
- *   entry: ['./src/prefetch.js', './src/pages/main/index.js'],
- * })
- * ```
- *
- * @example
- *
- * - Use multiple entries(with multiple entry modules):
- *
- * ```js
- * import { defineConfig } from '@lynx-js/rspeedy'
- * export default defineConfig({
- *   entry: {
- *     foo: './src/pages/foo/index.js',
- *     bar: ['./src/pages/bar/index.js', './src/post.js'], // multiple entry modules is allowed
- *   },
- * })
- * ```
- *
- * @example
- *
- * - Use multiple entries with {@link EntryDescription}:
- *
- * ```js
- * import { defineConfig } from '@lynx-js/rspeedy'
- * export default defineConfig({
- *   entry: {
- *     foo: './src/pages/foo/index.js',
- *     bar: {
- *       import: ['./src/prefetch.js', './src/pages/bar'],
- *     },
- *   },
- * })
- * ```
- * @public
- */
-export type Entry = string | string[] | Record<string, string | string[] | EntryDescription>;

package/lib/config/source/entry.js

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=entry.js.map