fix: type error when registering Rsbuild plugins (#6018)

web-infra-dev · Jul 30, 2024 · f19b9dc · f19b9dc
1 parent ce9c43a
commit f19b9dc
Show file tree

Hide file tree

Showing 4 changed files with 18 additions and 3 deletions.
diff --git a/.changeset/mighty-mails-reply.md b/.changeset/mighty-mails-reply.md
@@ -0,0 +1,5 @@
+---
+'@modern-js/app-tools': patch
+---
+
+fix: type error when registering Rsbuild plugins
diff --git a/packages/cli/uni-builder/src/index.ts b/packages/cli/uni-builder/src/index.ts
@@ -17,6 +17,7 @@ export type {
 export type {
   UniBuilderConfig,
   UniBuilderPlugin,
+  LooseRsbuildPlugin,
   BundlerType,
   MetaOptions,
   Stats,

diff --git a/packages/cli/uni-builder/src/types.ts b/packages/cli/uni-builder/src/types.ts
@@ -14,6 +14,7 @@ import type {
   RequestHandler,
   NodeEnv,
   HtmlTagDescriptor,
+  RsbuildPlugin,
 } from '@rsbuild/core';
 import type { PluginAssetsRetryOptions } from '@rsbuild/plugin-assets-retry';
 import type { PluginStyledComponentsOptions } from '@rsbuild/plugin-styled-components';
@@ -368,7 +369,7 @@ export type SriOptions = {
 
 export type OverridesUniBuilderInstance = {
   addPlugins: (
-    plugins: UniBuilderPlugin[],
+    plugins: Array<UniBuilderPlugin | LooseRsbuildPlugin>,
     options?: {
       before?: string;
     },
@@ -419,6 +420,11 @@ export type UniBuilderPlugin = {
   remove?: string[];
 };
 
+// Support for registering any version Rsbuild plugins
+export type LooseRsbuildPlugin = Omit<RsbuildPlugin, 'setup'> & {
+  setup: (api: any) => Promise<void> | void;
+};
+
 export type DistPath = DistPathConfig & {
   server?: string;
   worker?: string;

diff --git a/packages/solutions/app-tools/src/types/config/index.ts b/packages/solutions/app-tools/src/types/config/index.ts
@@ -1,5 +1,8 @@
 import type { ServerUserConfig, BffUserConfig } from '@modern-js/server-core';
-import type { UniBuilderPlugin } from '@modern-js/uni-builder';
+import type {
+  UniBuilderPlugin,
+  LooseRsbuildPlugin,
+} from '@modern-js/uni-builder';
 import type { RsbuildConfig } from '@rsbuild/core';
 import type { Bundler } from '../utils';
 import type { OutputUserConfig } from './output';
@@ -41,7 +44,7 @@ export interface AppToolsUserConfig<B extends Bundler> {
   tools?: ToolsUserConfig<B>;
   security?: SecurityUserConfig;
   testing?: TestingUserConfig;
-  builderPlugins?: UniBuilderPlugin[];
+  builderPlugins?: Array<LooseRsbuildPlugin | UniBuilderPlugin>;
   performance?: PerformanceUserConfig;
   devtools?: any;
   environments?: RsbuildConfig['environments'];