@lynx-js/rspeedy 0.8.2

package/lib/config/tools/css-loader.d.ts

@@ -0,0 +1,130 @@
+import type { CssModuleLocalsConvention } from '../output/css-modules.js';
+/**
+ * {@inheritdoc Tools.cssLoader}
+ *
+ * @public
+ */
+export interface CssLoader {
+    /**
+     * The option `importLoaders` allows you to configure how many loaders before `css-loader` should be applied to `@imported` resources and CSS modules imports.
+     *
+     * @remarks
+     *
+     * The default value of `importLoaders` is:
+     *
+     * - `1` when compiling CSS files
+     *
+     * - `2` when compiling Sass or Less files
+     *
+     * See {@link https://github.com/webpack-contrib/css-loader?tab=readme-ov-file#importloaders | css-loader#import-loaders} for details.
+     */
+    importLoaders?: 0 | 1 | 2 | undefined;
+    /**
+     * The {@link CssLoaderModules | cssLoader.modules} option enables/disables the CSS Modules specification and setup basic behavior.
+     *
+     * @example
+     *
+     * Using `false` value to increase performance because we avoid parsing CSS Modules features, it will be useful for developers who use vanilla css or use other technologies.
+     *
+     * ```js
+     * import { defineConfig } from '@lynx-js/rspeedy'
+     *
+     * export default defineConfig({
+     *   tools: {
+     *     cssLoader: {
+     *       modules: false,
+     *     },
+     *   },
+     * })
+     * ```
+     *
+     * @example
+     *
+     * Using `() => true` value to enable CSS Modules for all files.
+     *
+     * ```js
+     * import { defineConfig } from '@lynx-js/rspeedy'
+     *
+     * export default defineConfig({
+     *   tools: {
+     *     cssLoader: {
+     *       modules: () => true,
+     *     },
+     *   },
+     * })
+     * ```
+     *
+     * @example
+     *
+     * Using object value to enable CSS Modules based-on {@link CssLoaderModules.auto} option and setup more configurations about CSS Modules.
+     *
+     * ```js
+     * import { defineConfig } from '@lynx-js/rspeedy'
+     *
+     * export default defineConfig({
+     *   tools: {
+     *     cssLoader: {
+     *       modules: {
+     *         namedExport: true,
+     *       },
+     *     },
+     *   },
+     * })
+     * ```
+     */
+    modules?: boolean | CssLoaderModules | undefined;
+}
+/**
+ * {@inheritdoc CssLoader.modules}
+ *
+ * @public
+ */
+export interface CssLoaderModules {
+    /**
+     * {@inheritdoc CssModules.auto}
+     */
+    auto?: boolean | RegExp | ((filename: string) => boolean) | undefined;
+    /**
+     * {@inheritdoc CssModules.exportLocalsConvention}
+     */
+    exportLocalsConvention?: CssModuleLocalsConvention | undefined;
+    /**
+     * {@inheritdoc CssModules.localIdentName}
+     */
+    localIdentName?: string | undefined;
+    /**
+     * Enables/disables ES modules named export for locals.
+     *
+     * @example
+     *
+     * - `style.css`
+     *
+     * ```css
+     * .foo-baz {
+     *   color: red;
+     * }
+     * .bar {
+     *   color: blue;
+     * }
+     * .default {
+     *   color: green;
+     * }
+     * ```
+     *
+     * - `index.js`
+     *
+     * ```js
+     * import * as styles from "./styles.css";
+     *
+     * // If using `exportLocalsConvention: "as-is"` (default value):
+     * console.log(styles["foo-baz"], styles.bar);
+     *
+     * // If using `exportLocalsConvention: "camel-case-only"`:
+     * console.log(styles.fooBaz, styles.bar);
+     *
+     * // For the `default` class name
+     * console.log(styles["_default"]);
+     * ```
+     */
+    namedExport?: boolean | undefined;
+}

package/lib/config/tools/css-loader.js

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

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

@@ -0,0 +1,170 @@
+import type { ToolsConfig } from '@rsbuild/core';
+import type { RsdoctorRspackPlugin } from '@rsdoctor/rspack-plugin';
+import type { CssExtract } from './css-extract.js';
+import type { CssLoader } from './css-loader.js';
+export type RsdoctorRspackPluginOptions = ConstructorParameters<typeof RsdoctorRspackPlugin<[]>>[0];
+/**
+ * {@inheritdoc Config.tools}
+ *
+ * @public
+ */
+export interface Tools {
+    /**
+     * The {@link Tools.bundlerChain} changes the options of {@link https://www.rspack.dev | Rspack} using {@link https://github.com/rspack-contrib/rspack-chain | rspack-chain}.
+     *
+     * @example
+     *
+     * ```js
+     * import { defineConfig } from '@lynx-js/rspeedy'
+     *
+     * export default defineConfig({
+     *   tools: {
+     *     bundlerChain(chain) {
+     *       chain.resolve.fullySpecified(true)
+     *     },
+     *   },
+     * })
+     * ```
+     *
+     * See {@link https://github.com/rspack-contrib/rspack-chain | rspack-chain} for details.
+     */
+    bundlerChain?: ToolsConfig['bundlerChain'] | undefined;
+    /**
+     * The {@link CssLoader} controls the options of {@link https://github.com/webpack-contrib/css-loader | css-loader}.
+     *
+     * @remarks
+     *
+     * The default option is as follow:
+     *
+     * ```js
+     * const defaultOptions = {
+     *   modules: {
+     *     auto: true,
+     *     namedExport: false,
+     *     exportLocalsConvention: 'camelCase',
+     *     localIdentName: output.cssModules.localIdentName,
+     *   },
+     *   sourceMap: output.sourceMap,
+     *   // importLoaders is `1` when compiling css files, and is `2` when compiling sass/less files
+     *   importLoaders: 1 || 2,
+     * };
+     * ```
+     */
+    cssLoader?: CssLoader | undefined;
+    /**
+     * The {@link CssExtract} controls the options of {@link https://www.rspack.dev/plugins/rspack/css-extract-rspack-plugin | CssExtractRspackPlugin}
+     */
+    cssExtract?: CssExtract | undefined;
+    /**
+     * The {@link Tools.rsdoctor} controls the options of {@link https://rsdoctor.dev/ | Rsdoctor}.
+     *
+     * @example
+     *
+     * - Use the built-in Rsdoctor.
+     *
+     * ```js
+     * import { defineConfig } from '@lynx-js/rspeedy'
+     *
+     * export default defineConfig({
+     *   tools: {
+     *     rsdoctor: {
+     *       disableClientServer: true,
+     *     },
+     *   },
+     * })
+     * ```
+     *
+     * See {@link https://rsdoctor.dev/config/options/options | Rsdoctor - Configuration} for details.
+     */
+    rsdoctor?: RsdoctorRspackPluginOptions | undefined;
+    /**
+     * The {@link Tools.rspack} controls the options of {@link https://www.rspack.dev/ | Rspack}.
+     *
+     * @example
+     *
+     * - Use object config
+     *
+     * ```js
+     * import { defineConfig } from '@lynx-js/rspeedy'
+     *
+     * export default defineConfig({
+     *   tools: {
+     *     rspack: {
+     *       resolve: {
+     *         fullySpecified: true,
+     *       },
+     *     },
+     *   },
+     * })
+     * ```
+     *
+     * See {@link https://www.rspack.dev/config/index | Rspack - Configuration} for details.
+     *
+     * @example
+     *
+     * - Use function with `env` utils
+     *
+     * ```js
+     * import { defineConfig } from '@lynx-js/rspeedy'
+     *
+     * export default defineConfig({
+     *   tools: {
+     *     rspack(config, { env }) {
+     *       if (env === 'development') {
+     *         config.devtool = 'cheap-source-map'
+     *       }
+     *       return config
+     *     },
+     *   },
+     * })
+     * ```
+     *
+     * See {@link https://rsbuild.dev/config/tools/rspack#env | Rsbuild - tools.rspack} for details.
+     *
+     * @example
+     *
+     * - Use function with `mergeConfig` utils
+     *
+     * ```js
+     * import { defineConfig } from '@lynx-js/rspeedy'
+     *
+     * export default defineConfig({
+     *   tools: {
+     *     rspack(config, { mergeConfig }) {
+     *       return mergeConfig(config, {
+     *         resolve: {
+     *           fullySpecified: true,
+     *         },
+     *       })
+     *     },
+     *   },
+     * })
+     * ```
+     *
+     * See {@link https://rsbuild.dev/config/tools/rspack#mergeconfig | Rsbuild - tools.rspack} for details.
+     *
+     * @example
+     *
+     * - Use function with `appendPlugins` utils
+     *
+     * ```js
+     * import { defineConfig } from '@lynx-js/rspeedy'
+     *
+     * export default defineConfig({
+     *   tools: {
+     *     rspack(config, { appendPlugins, rspack }) {
+     *       appendPlugins(new rspack.BannerPlugin({ banner: 'Hello, World!' }))
+     *       return config
+     *     },
+     *   },
+     * })
+     * ```
+     *
+     * See {@link https://rsbuild.dev/config/tools/rspack#appendplugins | Rsbuild - tools.rspack} for details.
+     */
+    rspack?: ToolsConfig['rspack'] | undefined;
+    /**
+     * The {@link Tools.swc} controls the options of {@link https://rspack.dev/guide/features/builtin-swc-loader | builtin:swc-loader}.
+     */
+    swc?: ToolsConfig['swc'] | undefined;
+}

package/lib/config/tools/index.js

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

package/lib/config/validate.d.ts

@@ -0,0 +1,4 @@
+import * as typia from 'typia';
+import type { Config } from './index.js';
+export declare const validateConfig: (input: unknown) => typia.IValidation<Config>;
+export declare function validate(input: unknown, configPath?: string): Config;