@lynx-js/config-rsbuild-plugin-canary 0.0.0 → 0.0.1

package/CHANGELOG.md

@@ -0,0 +1,23 @@
+# @lynx-js/config-rsbuild-plugin
+
+## 0.0.1
+
+### Patch Changes
+
+- Init `@lynx-js/config-rsbuild-plugin` for configuring Lynx Configs that are not exposed by DSL plugins. ([#2052](https://github.com/lynx-family/lynx-stack/pull/2052))
+
+  For example:
+
+  ```ts
+  // lynx.config.ts
+  import { pluginLynxConfig } from '@lynx-js/config-rsbuild-plugin'
+  import { defineConfig } from '@lynx-js/rspeedy'
+
+  export default defineConfig({
+    plugins: [
+      pluginLynxConfig({
+        enableCheckExposureOptimize: false,
+      }),
+    ],
+  })
+  ```

package/README.md

@@ -0,0 +1,42 @@
+<p align="center">
+  <a href="https://lynxjs.org/rspeedy" target="blank"><img src="https://lf-lynx.tiktok-cdns.com/obj/lynx-artifacts-oss-sg/lynx-website/assets/rspeedy-banner.png" alt="Rspeedy Logo" /></a>
+</p>
+
+<p>
+  <a aria-label="NPM version" href="https://www.npmjs.com/package/@lynx-js/config-rsbuild-plugin">
+    <img alt="" src="https://img.shields.io/npm/v/@lynx-js/config-rsbuild-plugin?logo=npm">
+  </a>
+  <a aria-label="License" href="https://www.npmjs.com/package/@lynx-js/config-rsbuild-plugin">
+    <img src="https://img.shields.io/badge/License-Apache--2.0-blue" alt="license" />
+  </a>
+</p>
+
+## Getting Started
+
+```bash
+npm install -D @lynx-js/config-rsbuild-plugin
+```
+
+## Usage
+
+```ts
+// lynx.config.ts
+import { pluginLynxConfig } from '@lynx-js/config-rsbuild-plugin'
+import { defineConfig } from '@lynx-js/rspeedy'
+
+export default defineConfig({
+  plugins: [
+    pluginLynxConfig({
+      enableCheckExposureOptimize: false,
+    }),
+  ],
+})
+```
+
+## Contributing
+
+Contributions to Rspeedy are welcome and highly appreciated. However, before you jump right into it, we would like you to review our [Contribution Guidelines](/CONTRIBUTING.md) to make sure you have a smooth experience contributing to this project.
+
+## License
+
+Rspeedy is Apache-2.0 licensed.

package/dist/index.d.ts

@@ -0,0 +1,96 @@
+/**
+ * @packageDocumentation
+ *
+ * An rsbuild plugin for config Lynx Config defined by `@lynx-js/type-config`.
+ *
+ * @example
+ * ```ts
+ * import { pluginLynxConfig } from '@lynx-js/config-rsbuild-plugin'
+ * import { defineConfig } from '@lynx-js/rspeedy'
+ *
+ * export default defineConfig({
+ *   plugins: [
+ *     pluginLynxConfig({
+ *       enableCheckExposureOptimize: false,
+ *     }),
+ *   ],
+ * })
+ * ```
+ */
+
+import type { CompilerOptions } from '@lynx-js/type-config';
+import type { Config as Config_2 } from '@lynx-js/type-config';
+import type { RsbuildPlugin } from '@lynx-js/rspeedy';
+
+/**
+ * A configuration interface for Lynx Config defined by `@lynx-js/type-config`.
+ *
+ * See all available options in {@link https://lynxjs.org/next/api/lynx-config/config-reference.html}.
+ *
+ * @public
+ */
+export declare interface Config extends Config_2, CompilerOptions {
+}
+
+/**
+ * Options for the Lynx Config rsbuild plugin.
+ *
+ * @public
+ */
+export declare interface Options {
+    /**
+     * The keys of compiler options to set.
+     */
+    compilerOptionsKeys?: string[];
+    /**
+     * The keys of config options to set.
+     */
+    configKeys?: string[];
+    /**
+     * Custom validation function for the Lynx config.
+     *
+     * @param input - The input to validate.
+     * @returns The validated Lynx config.
+     */
+    validate?: (input: unknown) => Config;
+    /**
+     * A map from DSL plugin name to its package name.
+     *
+     * @example
+     * ```ts
+     * {
+     *   'lynx:react': '@lynx-js/react-rsbuild-plugin',
+     * }
+     * ```
+     */
+    dslPluginName2PkgName?: Record<string, string>;
+    /**
+     * The link to upgrade Rspeedy.
+     */
+    upgradeRspeedyLink?: string;
+}
+
+/**
+ * An rsbuild plugin for config Lynx Config defined by `@lynx-js/type-config`.
+ *
+ * @param config - The Lynx config to set.
+ *
+ * @example
+ * ```ts
+ * import { pluginLynxConfig } from '@lynx-js/config-rsbuild-plugin'
+ * import { defineConfig } from '@lynx-js/rspeedy'
+ *
+ * export default defineConfig({
+ *   plugins: [
+ *     pluginLynxConfig({
+ *       enableCheckExposureOptimize: false,
+ *     }),
+ *   ],
+ * })
+ * ```
+ *
+ * @public
+ */
+export declare function pluginLynxConfig(config: Config, options?: Options): RsbuildPlugin;
+
+export { }