@lynx-js/rspeedy 0.8.2

package/lib/plugins/resolve.plugin.d.ts

@@ -0,0 +1,2 @@
+import type { RsbuildPlugin } from '@rsbuild/core';
+export declare function pluginResolve(): RsbuildPlugin;

package/lib/plugins/resolve.plugin.js

@@ -0,0 +1,38 @@
+export function pluginResolve() {
+    return {
+        name: 'lynx:rsbuild:resolve',
+        setup(api) {
+            api.modifyBundlerChain(chain => {
+                // dprint-ignore
+                chain
+                    .resolve
+                    .aliasFields
+                    .add('browser')
+                    .end()
+                    .conditionNames
+                    .add('lynx')
+                    .add('import')
+                    .add('require')
+                    .add('browser')
+                    .end()
+                    .extensions
+                    // Rsbuild's default is ['.ts', '.tsx', '.js', '.jsx', '.mjs', '.json']
+                    // We only append `.cjs` with it.
+                    .add('.cjs')
+                    .end()
+                    .mainFields
+                    .add('lynx')
+                    .add('module')
+                    .add('main')
+                    .end()
+                    .mainFiles
+                    .add('index.lynx')
+                    .add('index')
+                    .end()
+                    .end()
+                    .end();
+            });
+        },
+    };
+}
+//# sourceMappingURL=resolve.plugin.js.map

package/lib/plugins/rsdoctor.plugin.d.ts

@@ -0,0 +1,3 @@
+import type { RsbuildPlugin } from '@rsbuild/core';
+import type { Tools } from '../config/tools/index.js';
+export declare function pluginRsdoctor(options?: Tools['rsdoctor']): RsbuildPlugin;

package/lib/plugins/rsdoctor.plugin.js

@@ -0,0 +1,41 @@
+// 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 { logger } from '@rsbuild/core';
+import { isCI } from '../utils/is-ci.js';
+export function pluginRsdoctor(options) {
+    return {
+        name: 'lynx:rsbuild:rsdoctor',
+        remove: ['rsbuild:rsdoctor'],
+        setup(api) {
+            if (process.env['RSDOCTOR'] !== 'true') {
+                return;
+            }
+            api.onBeforeCreateCompiler(async ({ bundlerConfigs }) => {
+                const { RsdoctorRspackPlugin } = await import('@rsdoctor/rspack-plugin');
+                for (const config of bundlerConfigs) {
+                    const pluginName = 'RsdoctorRspackPlugin';
+                    const registered = config.plugins?.some((plugin) => (typeof plugin === 'object'
+                        && plugin?.['isRsdoctorPlugin'] === true)
+                        || plugin?.constructor?.name === pluginName);
+                    if (registered) {
+                        continue;
+                    }
+                    config.plugins ??= [];
+                    config.plugins.push(new RsdoctorRspackPlugin({
+                        // We disable client server on CI by default.
+                        // But it can be overridden by `tools.rsdoctor`.
+                        disableClientServer: isCI(),
+                        ...options,
+                        supports: {
+                            ...options?.supports,
+                            banner: true, // We must enable `supports.banner` since we have runtime wrapper enabled
+                        },
+                    }));
+                }
+                logger.info(`Rsdoctor is enabled.`);
+            });
+        },
+    };
+}
+//# sourceMappingURL=rsdoctor.plugin.js.map

package/lib/plugins/sourcemap.plugin.d.ts

@@ -0,0 +1,2 @@
+import type { RsbuildPlugin } from '@rsbuild/core';
+export declare function pluginSourcemap(): RsbuildPlugin;

package/lib/plugins/sourcemap.plugin.js

@@ -0,0 +1,84 @@
+import invariant from 'tiny-invariant';
+import { EvalSourceMapDevToolPlugin } from '../webpack/EvalSourceMapDevToolPlugin.js';
+import { SourceMapDevToolPlugin } from '../webpack/SourceMapDevToolPlugin.js';
+export function pluginSourcemap() {
+    return {
+        name: 'lynx:rsbuild:sourcemap',
+        pre: ['lynx:rsbuild:dev'],
+        setup(api) {
+            api.modifyBundlerChain((chain, { isDev }) => {
+                const { dev, output, server } = api.getRsbuildConfig('current');
+                const publicPath = isDev ? dev?.assetPrefix : output?.assetPrefix;
+                if (publicPath === false) {
+                    // `dev.assetPrefix === false`
+                    // We do not modify the devtool option
+                    return;
+                }
+                // If `dev.assetPrefix === true`, it should have been replaced by the `lynx:rsbuild:dev` plugin.
+                invariant(typeof publicPath === 'string' || publicPath === undefined, `dev.assetPrefix should be normalized to string, got ${dev?.assetPrefix}`);
+                applySourceMapPlugin(chain, getDevtoolFromSourceMap(), publicPath?.replaceAll('<port>', String(api.context.devServer?.port ?? server?.port)));
+                function getDevtoolFromSourceMap() {
+                    const DEFAULT_DEV_DEVTOOL = 'cheap-module-source-map';
+                    switch (typeof output?.sourceMap) {
+                        case 'boolean': {
+                            if (output.sourceMap) {
+                                return isDev ? DEFAULT_DEV_DEVTOOL : 'source-map';
+                            }
+                            else {
+                                return false;
+                            }
+                        }
+                        case 'undefined':
+                        case 'object': {
+                            return output?.sourceMap?.js
+                                ?? (isDev ? DEFAULT_DEV_DEVTOOL : false);
+                        }
+                    }
+                }
+            });
+        },
+    };
+}
+function applySourceMapPlugin(chain, devtool, publicPath) {
+    if (devtool === false) {
+        return;
+    }
+    const CHAIN_ID_DEV_SOURCEMAP = 'lynx:sourcemap';
+    const output = chain.get('output');
+    if (devtool.includes('source-map')) {
+        const hidden = devtool.includes('hidden');
+        const inline = devtool.includes('inline');
+        const evalWrapped = devtool.includes('eval');
+        const cheap = devtool.includes('cheap');
+        const moduleMaps = devtool.includes('module');
+        const noSources = devtool.includes('nosources'); // cSpell:disable-line
+        const options = {
+            filename: inline
+                ? null
+                : (output?.sourceMapFilename ?? '[file].map[query]'),
+            moduleFilenameTemplate: output?.devtoolModuleFilenameTemplate
+                ?? 'file://[absolute-resource-path]',
+            fallbackModuleFilenameTemplate: output
+                ?.devtoolFallbackModuleFilenameTemplate
+                ?? 'file://[absolute-resource-path]?[hash]',
+            append: hidden ? false : undefined,
+            module: moduleMaps ? true : !cheap,
+            columns: !cheap,
+            noSources,
+            namespace: output?.devtoolNamespace,
+            publicPath,
+        };
+        chain
+            // If you want to use a custom configuration for this plugin in development mode
+            // Make sure to disable the default one. I.e. set `devtool: false`.
+            // See: https://webpack.js.org/plugins/source-map-dev-tool-plugin/
+            .devtool(false)
+            .plugin(CHAIN_ID_DEV_SOURCEMAP)
+            .when(evalWrapped, plugin => plugin.use(EvalSourceMapDevToolPlugin, [
+            options,
+        ]), plugin => plugin.use(SourceMapDevToolPlugin, [
+            options,
+        ]));
+    }
+}
+//# sourceMappingURL=sourcemap.plugin.js.map

package/lib/plugins/stats.plugin.d.ts

@@ -0,0 +1,2 @@
+import type { RsbuildPlugin } from '@rsbuild/core';
+export declare function pluginStats(): RsbuildPlugin;

package/lib/plugins/stats.plugin.js

@@ -0,0 +1,20 @@
+export function pluginStats() {
+    return {
+        name: 'lynx:rsbuild:stats',
+        setup(api) {
+            api.modifyRsbuildConfig((config, { mergeRsbuildConfig }) => {
+                return mergeRsbuildConfig(config, {
+                    performance: {
+                        bundleAnalyze: {
+                            // Failed to parse background.js, so analyzerMode is disabled here.
+                            // Please use Webpack Bundle Analyzer in rsdoctor.
+                            analyzerMode: 'disabled',
+                            generateStatsFile: true,
+                        },
+                    },
+                });
+            });
+        },
+    };
+}
+//# sourceMappingURL=stats.plugin.js.map

package/lib/plugins/swc.plugin.d.ts

@@ -0,0 +1,2 @@
+import type { RsbuildPlugin } from '@rsbuild/core';
+export declare function pluginSwc(): RsbuildPlugin;

package/lib/plugins/swc.plugin.js

@@ -0,0 +1,21 @@
+import { getESVersionTarget } from '../utils/getESVersionTarget.js';
+export function pluginSwc() {
+    return {
+        name: 'lynx:rsbuild:swc',
+        setup(api) {
+            api.modifyRsbuildConfig((config, { mergeRsbuildConfig }) => {
+                return mergeRsbuildConfig(config, {
+                    tools: {
+                        swc(config) {
+                            delete config.env;
+                            config.jsc ??= {};
+                            // TODO(target): use configuration
+                            config.jsc.target = getESVersionTarget();
+                        },
+                    },
+                });
+            });
+        },
+    };
+}
+//# sourceMappingURL=swc.plugin.js.map

package/lib/plugins/target.plugin.d.ts

@@ -0,0 +1,2 @@
+import type { RsbuildPlugin } from '@rsbuild/core';
+export declare function pluginTarget(): RsbuildPlugin;

package/lib/plugins/target.plugin.js

@@ -0,0 +1,12 @@
+import { getESVersionTarget } from '../utils/getESVersionTarget.js';
+export function pluginTarget() {
+    return {
+        name: 'lynx:rsbuild:target',
+        setup(api) {
+            api.modifyBundlerChain((options) => {
+                options.target([getESVersionTarget()]);
+            });
+        },
+    };
+}
+//# sourceMappingURL=target.plugin.js.map

package/lib/utils/getESVersionTarget.d.ts

@@ -0,0 +1 @@
+export declare function getESVersionTarget(): 'es2015' | 'es2019';

package/lib/utils/getESVersionTarget.js

@@ -0,0 +1,7 @@
+// 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.
+export function getESVersionTarget() {
+    return process.env['NODE_ENV'] === 'production' ? 'es2015' : 'es2019';
+}
+//# sourceMappingURL=getESVersionTarget.js.map

package/lib/utils/is-ci.d.ts

@@ -0,0 +1 @@
+export declare function isCI(): boolean;

package/lib/utils/is-ci.js

@@ -0,0 +1,7 @@
+// 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.
+export function isCI() {
+    return !!process.env['CI'] && process.env['CI'] !== 'false';
+}
+//# sourceMappingURL=is-ci.js.map

package/lib/version.d.ts

@@ -0,0 +1,4 @@
+declare const version: string;
+export declare const rspackVersion: string;
+export { version };
+export { version as rsbuildVersion } from '@rsbuild/core';

package/lib/version.js

@@ -0,0 +1,15 @@
+// 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 { createRequire } from 'node:module';
+import { rspack } from '@rsbuild/core';
+const require = createRequire(import.meta.url);
+// Using `import('../package.json', { with: { type: 'json' } })` will cause NodeJS print a
+// experimental warning.
+// eslint-disable-next-line import/no-commonjs
+const pkg = require('../package.json');
+const version = pkg.version;
+export const rspackVersion = rspack.rspackVersion;
+export { version };
+export { version as rsbuildVersion } from '@rsbuild/core';
+//# sourceMappingURL=version.js.map

package/lib/webpack/CompilationIdPlugin.d.ts

@@ -0,0 +1,4 @@
+import type { Rspack } from '@rsbuild/core';
+export declare class CompilationIdPlugin {
+    apply(compiler: Rspack.Compiler): void;
+}

package/lib/webpack/CompilationIdPlugin.js

@@ -0,0 +1,20 @@
+export class CompilationIdPlugin {
+    apply(compiler) {
+        // We need `compiler.name` and `compiler.options.output.uniqueName` to be set
+        // before we can get the compilation id
+        compiler.hooks.initialize.tap('CompilationIdPlugin', () => {
+            const { DefinePlugin } = compiler.webpack;
+            new DefinePlugin({
+                RSPEEDY_COMPILATION_ID: JSON.stringify(getCompilationId(compiler)),
+            }).apply(compiler);
+        });
+    }
+}
+// Copied from https://github.com/web-infra-dev/rsbuild/blob/ce031b589a0f97f04454be5c2159d72ce5deea61/packages/core/src/server/helper.ts#L448-L455
+// A unique name for WebSocket communication
+const COMPILATION_ID_REGEX = /[^\w-]/g;
+function getCompilationId(compiler) {
+    const uniqueName = compiler.options.output.uniqueName ?? '';
+    return `${compiler.name ?? ''}_${uniqueName.replace(COMPILATION_ID_REGEX, '_')}`;
+}
+//# sourceMappingURL=CompilationIdPlugin.js.map

package/lib/webpack/EvalSourceMapDevToolPlugin.d.ts

@@ -0,0 +1,9 @@
+import type { Rspack } from '@rsbuild/core';
+/**
+ * A shim to `webpack.EvalSourceMapDevToolPlugin`. Can be used in both webpack & rspack.
+ */
+export declare class EvalSourceMapDevToolPlugin {
+    options: Rspack.SourceMapDevToolPluginOptions;
+    constructor(options: Rspack.SourceMapDevToolPluginOptions);
+    apply(compiler: Rspack.Compiler): void;
+}

package/lib/webpack/EvalSourceMapDevToolPlugin.js

@@ -0,0 +1,15 @@
+/**
+ * A shim to `webpack.EvalSourceMapDevToolPlugin`. Can be used in both webpack & rspack.
+ */
+export class EvalSourceMapDevToolPlugin {
+    options;
+    constructor(options) {
+        this.options = options;
+    }
+    // Using `webpack.Compiler` to get typescript check in webpack-chain of rsbuild
+    apply(compiler) {
+        const { EvalSourceMapDevToolPlugin } = compiler.webpack;
+        new EvalSourceMapDevToolPlugin(this.options).apply(compiler);
+    }
+}
+//# sourceMappingURL=EvalSourceMapDevToolPlugin.js.map

package/lib/webpack/ProvidePlugin.d.ts

@@ -0,0 +1,9 @@
+import type { Rspack } from '@rsbuild/core';
+/**
+ * A shim to `webpack.ProvidePlugin`. Can be used in both webpack & rspack.
+ */
+export declare class ProvidePlugin {
+    definitions: Record<string, string | string[]>;
+    constructor(definitions: Record<string, string | string[]>);
+    apply(compiler: Rspack.Compiler): void;
+}

package/lib/webpack/ProvidePlugin.js

@@ -0,0 +1,15 @@
+/**
+ * A shim to `webpack.ProvidePlugin`. Can be used in both webpack & rspack.
+ */
+export class ProvidePlugin {
+    definitions;
+    constructor(definitions) {
+        this.definitions = definitions;
+    }
+    // Using `webpack.Compiler` to get typescript check in webpack-chain of rsbuild
+    apply(compiler) {
+        const { ProvidePlugin } = compiler.webpack;
+        new ProvidePlugin(this.definitions).apply(compiler);
+    }
+}
+//# sourceMappingURL=ProvidePlugin.js.map

package/lib/webpack/SourceMapDevToolPlugin.d.ts

@@ -0,0 +1,9 @@
+import type { Rspack } from '@rsbuild/core';
+/**
+ * A shim to `webpack.SourceMapDevToolPlugin`. Can be used in both webpack & rspack.
+ */
+export declare class SourceMapDevToolPlugin {
+    options: Rspack.SourceMapDevToolPluginOptions;
+    constructor(options: Rspack.SourceMapDevToolPluginOptions);
+    apply(compiler: Rspack.Compiler): void;
+}

package/lib/webpack/SourceMapDevToolPlugin.js

@@ -0,0 +1,15 @@
+/**
+ * A shim to `webpack.SourceMapDevToolPlugin`. Can be used in both webpack & rspack.
+ */
+export class SourceMapDevToolPlugin {
+    options;
+    constructor(options) {
+        this.options = options;
+    }
+    // Using `webpack.Compiler` to get typescript check in webpack-chain of rsbuild
+    apply(compiler) {
+        const { SourceMapDevToolPlugin } = compiler.webpack;
+        new SourceMapDevToolPlugin(this.options).apply(compiler);
+    }
+}
+//# sourceMappingURL=SourceMapDevToolPlugin.js.map

package/package.json

@@ -0,0 +1,83 @@
+{
+  "name": "@lynx-js/rspeedy",
+  "version": "0.8.2",
+  "description": "A webpack/rspack-based frontend toolchain for Lynx",
+  "keywords": [
+    "webpack",
+    "rspack",
+    "Lynx",
+    "ReactLynx"
+  ],
+  "license": "Apache-2.0",
+  "author": {
+    "name": "Qingyu Wang",
+    "email": "colinwang.0616@gmail.com"
+  },
+  "type": "module",
+  "exports": {
+    ".": {
+      "types": "./lib/index.d.ts",
+      "import": "./lib/index.js"
+    },
+    "./client": {
+      "types": "./client.d.ts"
+    },
+    "./register": {
+      "types": "./register/index.d.ts",
+      "import": "./register/index.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "types": "./lib/index.d.ts",
+  "bin": {
+    "rspeedy": "./bin/rspeedy.js"
+  },
+  "files": [
+    "bin",
+    "client",
+    "lib",
+    "!lib/**/*.js.map",
+    "register",
+    "client.d.ts",
+    "CHANGELOG.md",
+    "README.md"
+  ],
+  "dependencies": {
+    "@microsoft/api-extractor": "7.51.0",
+    "@rsbuild/core": "1.2.11",
+    "@rsbuild/plugin-css-minimizer": "1.0.2",
+    "@rsdoctor/rspack-plugin": "^0.4.13",
+    "chokidar": "^4.0.3",
+    "commander": "^13.1.0",
+    "default-gateway": "^7.2.2",
+    "exit-hook": "^4.0.0",
+    "ipaddr.js": "^2.2.0",
+    "javascript-stringify": "^2.1.0",
+    "picocolors": "^1.1.1",
+    "tiny-invariant": "^1.3.3",
+    "ts-blank-space": "^0.6.0",
+    "typia": "7.6.4",
+    "@lynx-js/chunk-loading-webpack-plugin": "^0.1.6",
+    "@lynx-js/webpack-dev-transport": "^0.1.0",
+    "@lynx-js/websocket": "^0.0.3"
+  },
+  "devDependencies": {
+    "@rollup/plugin-typescript": "^12.1.2",
+    "@rsbuild/webpack": "1.2.3",
+    "@types/default-gateway": "^7.2.2",
+    "eventemitter3": "^5.0.1",
+    "type-fest": "^4.35.0",
+    "vitest": "^3.0.7",
+    "webpack": "^5.98.0",
+    "@lynx-js/vitest-setup": "0.0.0"
+  },
+  "engines": {
+    "node": ">=18"
+  },
+  "tsdocMetadata": "./lib/tsdoc-metadata.json",
+  "scripts": {
+    "api-extractor": "api-extractor run --verbose",
+    "test": "pnpm -w run test --project rspeedy",
+    "test:type": "vitest --typecheck.only"
+  }
+}

package/register/data.d.ts

@@ -0,0 +1,9 @@
+// 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 type { MessagePort } from 'node:worker_threads'
+
+export interface Data {
+  port: MessagePort
+}

package/register/hooks.js

@@ -0,0 +1,146 @@
+// 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.
+
+// Copyright 2024 Bloomberg Finance L.P.
+// Distributed under the terms of the Apache 2.0 license.
+
+// @ts-check
+
+import { URL } from 'node:url'
+
+import tsBlankSpace from 'ts-blank-space'
+
+/**
+ * @type {{ active: boolean; port: import('worker_threads').MessagePort | null }}
+ */
+const state = {
+  active: true,
+  port: null,
+}
+
+/**
+ * @typedef {import('./data').Data} Data
+ */
+
+/**
+ * The `initialize` hook provides a way to define a custom function that runs in the hooks thread
+ * when the hooks module is initialized. Initialization happens when the hooks module is registered via `register`.
+ *
+ * This hook can receive data from a `register` invocation, including ports and other transferrable objects.
+ * The return value of `initialize` can be a `Promise`, in which case it will be awaited before the main application thread execution resumes.
+ *
+ * @type {import('module').InitializeHook<Data>}
+ */
+export const initialize = function initialize(
+  data,
+) {
+  state.port = data.port
+  data.port.on('message', onMessage)
+}
+
+/**
+ * The `resolve` hook chain is responsible for resolving file URL for a given module specifier and parent URL, and optionally its format (such as `'module'`) as a hint to the `load` hook.
+ * If a format is specified, the load hook is ultimately responsible for providing the final `format` value (and it is free to ignore the hint provided by `resolve`);
+ * if `resolve` provides a format, a custom `load` hook is required even if only to pass the value to the Node.js default `load` hook.
+ *
+ * @type {import('module').ResolveHook}
+ */
+export const resolve = async function resolve(
+  specifier,
+  context,
+  nextResolve,
+) {
+  try {
+    return await nextResolve(specifier, context)
+  } catch (err) {
+    const url = parseURL(err?.url)
+    if (
+      state.active && url?.pathname.endsWith('.js')
+    ) {
+      try {
+        return await nextResolve(
+          // Try `.ts` when resolve failed.
+          url.pathname.slice(0, -'.js'.length) + '.ts',
+          context,
+        )
+      } catch {
+        // Can't not resolve `.ts`, too.
+        // Throw the original error.
+        throw err
+      }
+    }
+    throw err
+  }
+}
+
+/**
+ * The `load` hook provides a way to define a custom method of determining how a URL should be interpreted, retrieved, and parsed.
+ * It is also in charge of validating the import assertion.
+ *
+ * @type {import('module').LoadHook}
+ */
+export const load = async function load(url, context, nextLoad) {
+  const fullURL = parseURL(url)
+
+  if (!fullURL) {
+    return nextLoad(url, context)
+  }
+
+  const { pathname } = fullURL
+
+  const isCts = pathname.endsWith('.cts')
+
+  if (
+    !(pathname.endsWith('.ts')
+      || pathname.endsWith('.mts')
+      || isCts)
+    || !state.active
+  ) {
+    return nextLoad(url, context)
+  }
+
+  const result = await nextLoad(url, { ...context, format: 'module' })
+  const transformedSource = tsBlankSpace(
+    // @ts-expect-error result.source should not be `undefined`
+    result.source.toString(),
+  )
+
+  return {
+    format: isCts ? 'commonjs' : 'module',
+    shortCircuit: true,
+    source: transformedSource + '\n//# sourceURL=' + url,
+  }
+}
+
+/**
+ * The callback of the `onmessage` of worker_thread.
+ *
+ * @param {string} message - The posted message from main-thread
+ */
+function onMessage(message) {
+  if (message === 'deactivate') {
+    state.active = false
+  }
+  state.port?.off('message', onMessage)
+}
+
+/**
+ * Similar with `URL.parse(url, 'file://')`.
+ *
+ * We are doing this since `URL.parse` is only supported in NodeJS 22.
+ *
+ * @param {string | undefined | null} url - The url string.
+ * @returns {URL | null} The URL parsed by `new URL`
+ */
+function parseURL(url) {
+  if (url === null || url === undefined) {
+    return null
+  }
+
+  try {
+    return new URL(url, 'file://')
+  } catch {
+    return null
+  }
+}

package/register/index.d.ts

@@ -0,0 +1,4 @@
+// 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.
+export function register(): () => void