@lynx-js/rspeedy 0.8.7 → 0.9.1

package/lib/config/loadConfig.js

@@ -1,98 +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 fs from 'node:fs';
-import { extname, isAbsolute, join } from 'node:path';
-import { pathToFileURL } from 'node:url';
-import color from 'picocolors';
-import { validate } from './validate.js';
-import { register } from '../../register/index.js';
-import { debug } from '../debug.js';
-export const resolveConfigPath = (root, customConfig) => {
-    if (customConfig) {
-        debug(`load custom config file ${customConfig} from ${root}`);
-        const customConfigPath = isAbsolute(customConfig)
-            ? customConfig
-            : join(root, customConfig);
-        if (fs.existsSync(customConfigPath)) {
-            return customConfigPath;
-        }
-        throw new Error(`Cannot find config file: ${color.dim(customConfigPath)}`);
-    }
-    const CONFIG_FILES = [
-        'lynx.config.ts',
-        'lynx.config.js',
-        'lynx.config.mts',
-        'lynx.config.mjs',
-    ];
-    for (const file of CONFIG_FILES) {
-        debug(`load default config file ${file} from ${root}`);
-        const configFile = join(root, file);
-        if (fs.existsSync(configFile)) {
-            debug(`default config ${configFile} found`);
-            return configFile;
-        }
-    }
-    throw new Error([
-        `Cannot find the default config file: ${color.dim(join(root, CONFIG_FILES[0]))}.`,
-        `Use custom config with ${color.green('`--config <config>`')} options.`,
-    ].join(' '));
-};
-/**
- * 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 async function loadConfig(loadConfigOptions) {
-    let { configPath } = loadConfigOptions;
-    if (!configPath || !isAbsolute(configPath)) {
-        configPath = resolveConfigPath(loadConfigOptions.cwd ?? process.cwd(), configPath);
-    }
-    // Note that we are using `pathToFileURL` since absolute paths must be valid file:// URLs on Windows.
-    const specifier = pathToFileURL(configPath).toString();
-    const unregister = shouldUseNativeImport(configPath)
-        ? /** noop */ () => void 0
-        : register();
-    try {
-        const exports = await import(
-        /* webpackIgnore: true */ `${specifier}?t=${Date.now()}`);
-        const content = validate('default' in exports ? exports.default : exports, configPath);
-        return {
-            configPath,
-            content,
-        };
-    }
-    finally {
-        unregister();
-    }
-}
-function shouldUseNativeImport(configPath) {
-    return isJavaScriptPath(configPath) || hasNativeTSSupport();
-}
-function hasNativeTSSupport() {
-    const { NODE_OPTIONS } = process.env;
-    if (!NODE_OPTIONS) {
-        return false;
-    }
-    return NODE_OPTIONS.includes('--experimental-transform-types')
-        || NODE_OPTIONS.includes('--experimental-strip-types');
-}
-function isJavaScriptPath(configPath) {
-    const ext = extname(configPath);
-    return ['.js', '.mjs', '.cjs'].includes(ext);
-}
-//# sourceMappingURL=loadConfig.js.map

package/lib/config/mergeRspeedyConfig.d.ts

@@ -1,36 +0,0 @@
-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

@@ -1,42 +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';
-/**
- * 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/output/css-modules.d.ts

@@ -1,84 +0,0 @@
-/**
- * {@inheritdoc Output.cssModules}
- *
- * @public
- */
-export interface CssModules {
-    /**
-     * The `auto` option allows CSS modules to be automatically enabled based on their filenames.
-     *
-     * @remarks
-     *
-     * Given the various `auto` values, the behavior is described as follows:
-     *
-     * - `true`: enable CSS modules for all files matching `/\.module\.\w+$/i.test(filename)` RegExp.
-     *
-     * - `false`: disable CSS modules.
-     *
-     * - `RegExp`: enable CSS modules for all files matching the `auto.test(filename)` RegExp.
-     *
-     * - `function`: enable CSS modules based on the filter function.
-     *
-     * See {@link https://github.com/webpack-contrib/css-loader?tab=readme-ov-file#auto | css-loader#auto} for details.
-     *
-     * @example
-     *
-     * Enable CSS module for `*.module.css` and `shared/*.css`:
-     *
-     * ```js
-     * import { defineConfig } from '@lynx-js/rspeedy'
-     * export default defineConfig({
-     *   output: {
-     *     cssModules: {
-     *       auto: (filename) => {
-     *         return filename.includes('.module.') || filename.includes('shared/')
-     *       },
-     *     },
-     *   },
-     * })
-     * ```
-     */
-    auto?: boolean | RegExp | ((filename: string) => boolean) | undefined;
-    /**
-     * Allows exporting names from global class names, so you can use them via import.
-     *
-     * @remarks
-     *
-     * See {@link https://github.com/webpack-contrib/css-loader?tab=readme-ov-file#exportglobals | css-loader#exportGlobals} for details.
-     */
-    exportGlobals?: boolean | undefined;
-    /**
-     * The style of exported class names.
-     *
-     * @remarks
-     *
-     * Given the various `exportLocalsConvention` values, the behavior is described as follows:
-     *
-     * - `'asIs'`:	Class names will be exported as is.
-     *
-     * - `'camelCase'`: Class names will be camelized, the original class name will not to be removed from the locals
-     *
-     * - `'camelCaseOnly'`: Class names will be camelized, the original class name will be removed from the locals
-     *
-     * - `'dashes'`: Only dashes in class names will be camelized
-     *
-     * - `'dashesOnly'`: Dashes in class names will be camelized, the original class name will be removed from the locals
-     *
-     * See {@link https://github.com/webpack-contrib/css-loader?tab=readme-ov-file#exportlocalsconvention | css-loader#exportLocalsConvention} for details.
-     */
-    exportLocalsConvention?: CssModuleLocalsConvention | undefined;
-    /**
-     * Sets the format of the className generated by CSS Modules after compilation.
-     *
-     * @remarks
-     *
-     * See {@link https://github.com/webpack-contrib/css-loader?tab=readme-ov-file#localIdentName | css-loader#localIdentName} for details.
-     */
-    localIdentName?: string | undefined;
-}
-/**
- * {@inheritdoc CssModules.exportLocalsConvention}
- *
- * @public
- */
-export type CssModuleLocalsConvention = 'asIs' | 'camelCase' | 'camelCaseOnly' | 'dashes' | 'dashesOnly';

package/lib/config/output/css-modules.js

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

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

@@ -1,19 +0,0 @@
-import type { DistPathConfig } from '@rsbuild/core';
-/**
- * {@inheritdoc Output.distPath}
- *
- * @public
- */
-export interface DistPath extends DistPathConfig {
-    /**
-     * The output directory of the intermediate files.
-     *
-     * @remarks
-     *
-     * Default value:
-     *
-     * - `'.rspeedy'`
-     */
-    intermediate?: string | undefined;
-}
-export declare const DEFAULT_DIST_PATH_INTERMEDIATE = ".rspeedy";

package/lib/config/output/dist-path.js

@@ -1,2 +0,0 @@
-export const DEFAULT_DIST_PATH_INTERMEDIATE = '.rspeedy';
-//# sourceMappingURL=dist-path.js.map

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

@@ -1,167 +0,0 @@
-/**
- * {@inheritdoc Output.filename}
- *
- * @public
- */
-export interface Filename {
-    /**
-     * The name of the bundle files.
-     *
-     * @remarks
-     *
-     * Default values:
-     *
-     * - `'[name].[platform].bundle'`
-     *
-     * The following placeholder is supported:
-     *
-     * - `[name]`: the name of the entry.
-     * - `[contenthash]`: the contenthash of the bundle.
-     * - `[platform]`: the environment name of the bundle.
-     *
-     * @example
-     *
-     * - Using content hash in bundle filename:
-     *
-     * ```js
-     * import { defineConfig } from '@lynx-js/rspeedy'
-     *
-     * export default defineConfig({
-     *   output: {
-     *     filename: {
-     *       bundle: '[name].[contenthash].bundle',
-     *     },
-     *   },
-     * })
-     * ```
-     *
-     * @example
-     *
-     * - Using content hash with length in bundle filename:
-     *
-     * ```js
-     * import { defineConfig } from '@lynx-js/rspeedy'
-     *
-     * export default defineConfig({
-     *   output: {
-     *     filename: {
-     *       bundle: '[name].[contenthash:8].bundle',
-     *     },
-     *   },
-     * })
-     * ```
-     */
-    bundle?: string | undefined;
-    /**
-     * The name of the template files.
-     *
-     * @deprecated
-     *
-     * Use {@link Filename.bundle} instead.
-     *
-     * @remarks
-     *
-     * Default values:
-     *
-     * - `'[name].lynx.bundle'`
-     *
-     * The following placeholder is supported:
-     *
-     * - `[name]`: the name of the entry.
-     * - `[contenthash]`: the contenthash of the template.
-     *
-     * @example
-     *
-     * - Using content hash in bundle filename:
-     *
-     * ```js
-     * import { defineConfig } from '@lynx-js/rspeedy'
-     *
-     * export default defineConfig({
-     *   output: {
-     *     filename: {
-     *       template: '[name].[contenthash].bundle',
-     *     },
-     *   },
-     * })
-     * ```
-     *
-     * @example
-     *
-     * - Using content hash with length in bundle filename:
-     *
-     * ```js
-     * import { defineConfig } from '@lynx-js/rspeedy'
-     *
-     * export default defineConfig({
-     *   output: {
-     *     filename: {
-     *       template: '[name].[contenthash:8].bundle',
-     *     },
-     *   },
-     * })
-     * ```
-     */
-    template?: string | undefined;
-    /**
-     * The name of the JavaScript files.
-     *
-     * @remarks
-     *
-     * Default values:
-     *
-     * - Development: `'[name].js'`
-     * - Production: `'[name].[contenthash:8].js'`
-     */
-    js?: string | undefined;
-    /**
-     * The name of the CSS files.
-     *
-     * @remarks
-     *
-     * Default values:
-     *
-     * - `'[name].css'`
-     */
-    css?: string | undefined;
-    /**
-     * The name of the SVG images.
-     *
-     * @remarks
-     *
-     * Default values:
-     *
-     * - `'[name].[contenthash:8].svg'`
-     */
-    svg?: string | undefined;
-    /**
-     * The name of the font files.
-     *
-     * @remarks
-     *
-     * Default values:
-     *
-     * - `'[name].[contenthash:8][ext]'`
-     */
-    font?: string | undefined;
-    /**
-     * The name of non-SVG images.
-     *
-     * @remarks
-     *
-     * Default values:
-     *
-     * - `'[name].[contenthash:8][ext]'`
-     */
-    image?: string | undefined;
-    /**
-     * The name of media assets, such as video.
-     *
-     * @remarks
-     *
-     * Default values:
-     *
-     * - `'[name].[contenthash:8][ext]'`
-     */
-    media?: string | undefined;
-}

package/lib/config/output/filename.js

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