@lynx-js/rspeedy 0.8.7 → 0.9.1

package/lib/cli/start.js

@@ -1,88 +0,0 @@
-// 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 (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
-// See LICENSE in the project root for license information.
-import * as fs from 'node:fs';
-import * as path from 'node:path';
-import { pathToFileURL } from 'node:url';
-import { logger } from '@rsbuild/core';
-import { debug } from '../debug.js';
-var Constants;
-(function (Constants) {
-    Constants["rspeedyPackageName"] = "@lynx-js/rspeedy";
-    Constants["unmanagedParameterLongName"] = "--unmanaged";
-})(Constants || (Constants = {}));
-// Excerpted from PackageJsonLookup.tryGetPackageFolderFor()
-function tryGetPackageFolderFor(resolvedFileOrFolderPath) {
-    // Is resolvedFileOrFolderPath itself a folder with a package.json file?  If so, return it.
-    if (fs.existsSync(path.join(resolvedFileOrFolderPath, 'package.json'))) {
-        return resolvedFileOrFolderPath;
-    }
-    // Otherwise go up one level
-    const parentFolder = path.dirname(resolvedFileOrFolderPath);
-    if (!parentFolder || parentFolder === resolvedFileOrFolderPath) {
-        // We reached the root directory without finding a package.json file,
-        // so cache the negative result
-        return undefined; // no match
-    }
-    // Recurse upwards
-    return tryGetPackageFolderFor(parentFolder);
-}
-/**
- * When rspeedy is invoked via the shell path, we examine the project's package.json dependencies and try to load
- * the locally installed version of rspeedy. This avoids accidentally building using the wrong version of rspeedy.
- * Use "rspeedy --unmanaged" to bypass this feature.
- */
-export function tryStartLocalRspeedy(root = process.cwd()) {
-    if (process.argv.includes(Constants.unmanagedParameterLongName)) {
-        logger.info(`Bypassing the Rspeedy version selector because ${JSON.stringify(Constants.unmanagedParameterLongName)} was specified.`);
-        logger.info();
-        return false;
-    }
-    // The unmanaged flag could be undiscoverable if it's not in their locally installed version
-    debug(`Searching for a locally installed version of Rspeedy. Use the ${JSON.stringify(Constants.unmanagedParameterLongName)} flag if you want to avoid this.`);
-    // Find the package.json file that governs the current folder location
-    const projectFolder = tryGetPackageFolderFor(root);
-    if (projectFolder) {
-        debug(`found project at ${projectFolder}`);
-        let rspeedyEntryPoint;
-        let packageJson;
-        try {
-            const packageJsonPath = path.join(projectFolder, 'package.json');
-            const packageJsonContent = fs.readFileSync(packageJsonPath).toString();
-            try {
-                packageJson = JSON.parse(packageJsonContent);
-            }
-            catch (error) {
-                throw new Error(`Error parsing ${packageJsonPath}:${error.message}`);
-            }
-            // Does package.json have a dependency on Rspeedy?
-            if (!(packageJson.dependencies?.[Constants.rspeedyPackageName])
-                && !(packageJson.devDependencies?.[Constants.rspeedyPackageName])) {
-                // No explicit dependency on rspeedy
-                debug('The project does not have a dependency on Rspeedy');
-                return false;
-            }
-            // To avoid a loading the "resolve" NPM package, let's assume that the rspeedy dependency must be
-            // installed as "<projectFolder>/node_modules/@lynx-js/rspeedy".
-            const rspeedyFolder = path.join(projectFolder, 'node_modules', ...Constants.rspeedyPackageName.split('/'));
-            rspeedyEntryPoint = path.join(rspeedyFolder, 'lib', 'cli', 'main.js');
-            if (!fs.existsSync(rspeedyEntryPoint)) {
-                debug(`Unable to find rspeedy entry point: ${rspeedyEntryPoint}, using the unmanaged version.`);
-                return false;
-            }
-        }
-        catch (error) {
-            throw new Error(`Error probing for local rspeedy version: ${error.message}`);
-        }
-        debug(`found rspeedy entry point at ${rspeedyEntryPoint}`);
-        // We found and successfully invoked the local rspeedy
-        // Note that we are using `pathToFileURL` since absolute paths must be valid file:// URLs on Windows.
-        return import(pathToFileURL(rspeedyEntryPoint).toString()).then(({ main }) => main(process.argv));
-    }
-    debug(`no project folder found from ${process.cwd()}`);
-    // We couldn't find the package folder
-    return false;
-}
-//# sourceMappingURL=start.js.map

package/lib/config/defaults.d.ts

@@ -1,2 +0,0 @@
-import type { Config } from './index.js';
-export declare function applyDefaultRspeedyConfig(config: Config): Config;

package/lib/config/defaults.js

@@ -1,32 +0,0 @@
-// 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';
-export function applyDefaultRspeedyConfig(config) {
-    const ret = mergeRsbuildConfig(config, {
-        output: {
-            // We are applying the default filename to the config
-            // since some plugin(e.g.: `@lynx-js/qrcode-rsbuild-plugin`) will read
-            // from the `output.filename.bundle` field.
-            filename: getFilename(config.output?.filename),
-        },
-    });
-    return ret;
-}
-const DEFAULT_FILENAME = '[name].[platform].bundle';
-function getFilename(filename) {
-    if (typeof filename === 'string') {
-        return {
-            bundle: filename,
-            template: filename,
-        };
-    }
-    const finalFilename = filename?.bundle
-        ?? filename?.template
-        ?? DEFAULT_FILENAME;
-    return {
-        bundle: finalFilename,
-        template: finalFilename,
-    };
-}
-//# sourceMappingURL=defaults.js.map

package/lib/config/defineConfig.d.ts

@@ -1,22 +0,0 @@
-import type { Config } from './index.js';
-/**
- * The `defineConfig` method is a helper function used to get TypeScript intellisense.
- *
- * @param config - The config of Rspeedy.
- * @returns - The identical config as the input config.
- *
- * @example
- *
- * Use `defineConfig` in `lynx.config.ts`:
- *
- * ```ts
- * //@ts-check
- * import { defineConfig } from '@lynx-js/rspeedy'
- * export default defineConfig({
- *   // autocompletion works here!
- * })
- * ```
- *
- * @public
- */
-export declare function defineConfig(config: Config): Config;

package/lib/config/defineConfig.js

@@ -1,24 +0,0 @@
-/**
- * The `defineConfig` method is a helper function used to get TypeScript intellisense.
- *
- * @param config - The config of Rspeedy.
- * @returns - The identical config as the input config.
- *
- * @example
- *
- * Use `defineConfig` in `lynx.config.ts`:
- *
- * ```ts
- * //@ts-check
- * import { defineConfig } from '@lynx-js/rspeedy'
- * export default defineConfig({
- *   // autocompletion works here!
- * })
- * ```
- *
- * @public
- */
-export function defineConfig(config) {
-    return config;
-}
-//# sourceMappingURL=defineConfig.js.map

package/lib/config/dev/client.d.ts

@@ -1,15 +0,0 @@
-/**
- * {@inheritdoc Dev.client}
- *
- * @public
- */
-export interface Client {
-    /**
-     * The path to websocket.
-     *
-     * @remarks
-     *
-     * Defaults to `require.resolve('@lynx-js/websocket')`
-     */
-    websocketTransport?: string | undefined;
-}

package/lib/config/dev/client.js

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

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

@@ -1,173 +0,0 @@
-import type { WatchFiles } from '@rsbuild/core';
-import type { Client } from './client.js';
-/**
- * {@inheritdoc Config.dev}
- * @public
- */
-export interface Dev {
-    /**
-     * The {@link Dev.assetPrefix} is used to set the URL prefix for static assets during development.
-     * @remarks
-     *
-     * The functionality of {@link Dev.assetPrefix} is basically the same as the {@link https://www.rspack.dev/config/output#outputpublicpath | output.publicPath}
-     * config in Rspack. With the following differences:
-     *
-     * - `dev.assetPrefix` only takes effect during development.
-     *
-     * - `dev.assetPrefix` automatically appends a trailing `/` by default.
-     *
-     * - The value of `dev.assetPrefix` is written to the `process.env.ASSET_PREFIX` environment variable.
-     *
-     * @example
-     *
-     * If `dev.assetPrefix` is set to true, the URL prefix will be `http://<host>:<port>/`:
-     *
-     * ```js
-     * import { defineConfig } from '@lynx-js/rspeedy'
-     * export default defineConfig({
-     *   dev: {
-     *     assetPrefix: true,
-     *   },
-     * })
-     * ```
-     *
-     * @example
-     *
-     * If `dev.assetPrefix` is set to a string, the value will be used as a prefix and automatically appended to the static resource URL.
-     *
-     * ```js
-     * import { defineConfig } from '@lynx-js/rspeedy'
-     * export default defineConfig({
-     *   dev: {
-     *     assetPrefix: 'https://example.com/assets/',
-     *   },
-     * })
-     * ```
-     *
-     * @example
-     *
-     * The port number that Rspeedy server listens on may change. For example, if the port is in use, Rspeedy will automatically increment the port number until it finds an available port.
-     *
-     * To avoid `dev.assetPrefix` becoming invalid due to port changes, you can use one of the following methods:
-     *
-     * - Enable `server.strictPort`.
-     *
-     * - Use the `<port>` placeholder to refer to the current port number. Rspeedy will replace the placeholder with the actual port number it is listening on.
-     *
-     * ```js
-     * import { defineConfig } from '@lynx-js/rspeedy'
-     * export default defineConfig({
-     *   dev: {
-     *     assetPrefix: 'https://example.com:<port>/assets/',
-     *   },
-     * })
-     * ```
-     */
-    assetPrefix?: string | boolean | undefined;
-    /**
-     * Configuration of the development client.
-     */
-    client?: Client | undefined;
-    /**
-     * Watch specified files and directories for changes. When a file change is detected, it can trigger a page reload or restart the dev server.
-     *
-     * @example
-     *
-     * - Specify the files and directories watched for changes.
-     *
-     * ```js
-     * import { defineConfig } from '@lynx-js/rspeedy'
-     *
-     * export default defineConfig({
-     *   dev: {
-     *     watchFiles: {
-     *       paths: ['src/**', 'public/**'],
-     *     },
-     *   },
-     * })
-     * ```
-     *
-     * @example
-     *
-     * - Use {@link https://github.com/paulmillr/chokidar#api | chokidar} options for watching.
-     *
-     * ```js
-     * import { defineConfig } from '@lynx-js/rspeedy'
-     *
-     * export default defineConfig({
-     *   dev: {
-     *     watchFiles: {
-     *       paths: ['src/**', 'public/**'],
-     *       options: { usePolling: false },
-     *     },
-     *   },
-     * })
-     * ```
-     */
-    watchFiles?: WatchFiles | WatchFiles[] | undefined;
-    /**
-     * Used to control whether the build artifacts of the development environment are written to the disk.
-     *
-     * @remarks
-     *
-     * This is bypassed to {@link https://github.com/webpack/webpack-dev-middleware?tab=readme-ov-file#writetodisk | `webpack-dev-middleware`}.
-     *
-     * Setting `writeToDisk: true` won't change the behavior of the `webpack-dev-middleware`, and bundle files accessed through the browser will still be served from memory.
-     *
-     * This option also accepts a `Function` value, which can be used to filter which files are written to disk.
-     *
-     * The function follows the same premise as `Array#filter` in which a return value of `false` will not write the file, and a return value of `true` will write the file to disk.
-     *
-     * @example
-     * ```js
-     * // lynx.config.ts
-     * import { defineConfig } from '@lynx-js/rspeedy'
-     * export default defineConfig({
-     *   dev: {
-     *     writeToDisk: (filePath) => /superman\.css$/.test(filePath),
-     *   },
-     * })
-     * ```
-     */
-    writeToDisk?: boolean | ((filename: string) => boolean) | undefined;
-    /**
-     * Whether to display progress bar during compilation.
-     *
-     * Defaults to `true`.
-     *
-     * @example
-     *
-     * Disable the progress bar.
-     *
-     * ```js
-     * import { defineConfig } from '@lynx-js/rspeedy'
-     *
-     * export default defineConfig({
-     *   dev: {
-     *     progressBar: false,
-     *   },
-     * })
-     * ```
-     *
-     * @example
-     *
-     * Modify the progress bar `id`
-     *
-     * To modify the text displayed on the left side of the progress bar, set the `id` option:
-     *
-     * ```js
-     * import { defineConfig } from '@lynx-js/rspeedy'
-     *
-     * export default defineConfig({
-     *   dev: {
-     *     progressBar: {
-     *       id: 'Some Text'
-     *     },
-     *   },
-     * })
-     * ```
-     */
-    progressBar?: boolean | {
-        id?: string;
-    } | undefined;
-}

package/lib/config/dev/index.js

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

package/lib/config/index.d.ts

@@ -1,172 +0,0 @@
-import type { RsbuildConfig, RsbuildPlugins } from '@rsbuild/core';
-import type { Dev } from './dev/index.js';
-import type { Output } from './output/index.js';
-import type { Performance } from './performance/index.js';
-import type { Server } from './server/index.js';
-import type { Source } from './source/index.js';
-import type { Tools } from './tools/index.js';
-/**
- * The `Config` is the configuration that `rspeedy` uses.
- *
- * @public
- */
-export interface Config {
-    /**
-     * The Rsbuild provider.
-     *
-     * @example
-     * You can switch from Rspack to Webpack by:
-     *
-     * - Use `webpackProvider` from `@rsbuild/webpack`
-     * - Add `pluginSwc` from `@rsbuild/plugin-webpack-swc` for TypeScript transpilation
-     *
-     * ```ts
-     * import { defineConfig } from '@lynx-js/rspeedy'
-     * import { webpackProvider } from '@rsbuild/webpack'
-     * import { pluginSwc } from '@rsbuild/plugin-webpack-swc'
-     *
-     * export default defineConfig({
-     *   provider: webpackProvider,
-     *   plugins: [
-     *     pluginSwc(),
-     *   ],
-     * })
-     * ```
-     *
-     * @alpha
-     */
-    provider?: RsbuildConfig['provider'];
-    /**
-     * The {@link Dev} option is used to control the behavior related with development. Including: HMR, DevServer, etc.
-     */
-    dev?: Dev | undefined;
-    /**
-     * The {@link Config.environments} option is used to set the output environment.
-     *
-     * @remarks
-     *
-     * Normally you don't need this if you are not using Lynx for Web.
-     *
-     * @example
-     *
-     * - Using different entries for Lynx and Web.
-     *
-     * ```ts
-     * import { defineConfig } from '@lynx-js/rspeedy'
-     *
-     * export default defineConfig({
-     *   environments: {
-     *     lynx: {},
-     *     web: {
-     *       source: { entry: { web: './src/index.web.jsx' } },
-     *     },
-     *   },
-     *   source: {
-     *     entry: './src/index.jsx',
-     *   },
-     * })
-     * ```
-     *
-     * @example
-     *
-     * - Building Web-only outputs.
-     *
-     * ```ts
-     * import { defineConfig } from '@lynx-js/rspeedy'
-     *
-     * export default defineConfig({
-     *   environments: {
-     *     web: {
-     *       source: { entry: { web: './src/index.web.jsx' } },
-     *     },
-     *   },
-     * })
-     * ```
-     */
-    environments?: RsbuildConfig['environments'] | undefined;
-    /**
-     * Specify the build mode for Rsbuild and Rspack, as each mode has different default behavior and optimizations.
-     *
-     * @remarks
-     *
-     * The default value of mode depends on the `process.env.NODE_ENV` environment variable:
-     *
-     * - If `NODE_ENV` is production, the default value is production.
-     *
-     * - If `NODE_ENV` is development, the default value is development.
-     *
-     * - If `NODE_ENV` has any other value, the default value is none.
-     *
-     * - If you set the value of mode, the value of `NODE_ENV` will be ignored.
-     *
-     * When using Rspeedy's CLI:
-     *
-     * - `rspeedy dev` and `rspeedy preview` will set the default values of `NODE_ENV` and `mode` to `'development'`.
-     *
-     * - `rspeedy build` will set the default values of `NODE_ENV` and `mode` to `'production'`.
-     *
-     * @example
-     *
-     * If the value of `mode` is `'development'`:
-     *
-     * - Enable HMR and register the {@link https://rspack.dev/plugins/webpack/hot-module-replacement-plugin | HotModuleReplacementPlugin}.
-     *
-     * - Generate JavaScript source maps, but do not generate CSS source maps. See {@link Output.sourceMap} for details.
-     *
-     * - The `process.env.NODE_ENV` in the source code will be replaced with `'development'`.
-     *
-     * - The `import.meta.env.MODE` in the source code will be replaced with `'development'`.
-     *
-     * - The `import.meta.env.DEV` in the source code will be replaced with `true`.
-     *
-     * - The `import.meta.env.PROD` in the source code will be replaced with `false`.
-     *
-     * @example
-     *
-     * If the value of `mode` is `'production'`:
-     *
-     * - Enable JavaScript code minification and register the {@link https://rspack.dev/plugins/rspack/swc-js-minimizer-rspack-plugin | SwcJsMinimizerRspackPlugin}.
-     *
-     * - Generated JavaScript and CSS filenames will have hash suffixes, see {@link Output.filenameHash}.
-     *
-     * - Generated CSS Modules classnames will be shorter, see {@link CssModules.localIdentName}.
-     *
-     * - Do not generate JavaScript and CSS source maps, see {@link Output.sourceMap}.
-     *
-     * - The `process.env.NODE_ENV` in the source code will be replaced with `'production'`.
-     *
-     * - The `import.meta.env.MODE` in the source code will be replaced with `'production'`.
-     *
-     * - The `import.meta.env.DEV` in the source code will be replaced with `false`.
-     *
-     * - The `import.meta.env.PROD` in the source code will be replaced with `true`.
-     */
-    mode?: 'development' | 'production' | 'none' | undefined;
-    /**
-     * The {@link Output} option is used to set how and where should the bundles and assets output.
-     */
-    output?: Output | undefined;
-    /**
-     * The {@link Performance} option is used to
-     */
-    performance?: Performance | undefined;
-    /**
-     * The {@link Server} option changes the behavior of dev-server.
-     */
-    server?: Server | undefined;
-    /**
-     * The {@link Source} option changes the behavior of source files.
-     */
-    source?: Source | undefined;
-    /**
-     * The {@link Tools} options changes the behavior of various building tools.
-     */
-    tools?: Tools | undefined;
-    /**
-     * The `plugins` option is used to customize the build process in a variety of ways.
-     *
-     * @remarks
-     * Rspeedy use the plugin APIs from {@link https://rsbuild.dev/plugins/dev/index | Rsbuild}. See the corresponding document for developing a plugin.
-     */
-    plugins?: RsbuildPlugins | undefined;
-}

package/lib/config/index.js

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

package/lib/config/loadConfig.d.ts

@@ -1,50 +0,0 @@
-import type { Config } from './index.js';
-export declare const resolveConfigPath: (root: string, customConfig?: string) => string;
-/**
- * The options of loadConfig.
- *
- * @public
- */
-export interface LoadConfigOptions {
-    configPath?: string | undefined;
-    cwd?: string | undefined;
-}
-/**
- * The result of {@link loadConfig}.
- *
- * @public
- */
-export interface LoadConfigResult {
-    /**
-     * The configuration object that exported from the configuration file.
-     *
-     * @remarks
-     *
-     * The returned object has already been validated.
-     */
-    content: Config;
-    /**
-     * The configuration path that has been loaded.
-     */
-    configPath: string;
-}
-/**
- * Load the build config by the config path.
- *
- * @param loadConfigOptions - the options of `loadConfig` method.
- * @returns Build config.
- *
- * @example
- *
- * ```ts
- * import { loadConfig } from '@lynx-js/rspeedy'
- *
- * void async function () {
- *   const config = await loadConfig({ configPath: './lynx.config.js' })
- *   console.log(config);
- * }()
- * ```
- *
- * @public
- */
-export declare function loadConfig(loadConfigOptions: LoadConfigOptions): Promise<LoadConfigResult>;