chore(builder-related): add deprecated warning (#5204)

Co-authored-by: neverland <chenjiahan.jait@bytedance.com>
web-infra-dev · Jan 10, 2024 · 22d9635 · 22d9635
1 parent 54f749c
commit 22d9635
Show file tree

Hide file tree

Showing 20 changed files with 36 additions and 9 deletions.
diff --git a/.changeset/mighty-lies-lie.md b/.changeset/mighty-lies-lie.md
@@ -2,6 +2,6 @@
 '@modern-js/builder-cli': patch
 ---
 
-chore(builder-cli): add deprecated warning, please use rsbuild instead
+chore(builder-related): add deprecated warning for builder related packages, please use rsbuild instead
 
-chore(builder-cli): 添加废弃声明，推荐使用 rsbuild 代替
+chore(builder-related): 为 builder 相关包添加废弃声明，推荐使用 rsbuild 代替
diff --git a/packages/builder/builder-cli/README.md b/packages/builder/builder-cli/README.md
@@ -1,3 +1,4 @@
+> DEPRECATED: use [Rsbuild](https://github.com/web-infra-dev/rsbuild) instead.
 
 <p align="center">
   <a href="https://modernjs.dev" target="blank"><img src="https://lf3-static.bytednsdoc.com/obj/eden-cn/ylaelkeh7nuhfnuhf/modernjs-cover.png" width="300" alt="Modern.js Logo" /></a>

diff --git a/packages/builder/builder-rspack-provider/README.md b/packages/builder/builder-rspack-provider/README.md
@@ -1,3 +1,4 @@
+> DEPRECATED: use [Rsbuild](https://github.com/web-infra-dev/rsbuild) instead.
 
 <p align="center">
   <a href="https://modernjs.dev" target="blank"><img src="https://lf3-static.bytednsdoc.com/obj/eden-cn/ylaelkeh7nuhfnuhf/modernjs-cover.png" width="300" alt="Modern.js Logo" /></a>

diff --git a/packages/builder/builder-shared/README.md b/packages/builder/builder-shared/README.md
@@ -1,3 +1,4 @@
+> DEPRECATED: use [Rsbuild](https://github.com/web-infra-dev/rsbuild) instead.
 
 <p align="center">
   <a href="https://modernjs.dev" target="blank"><img src="https://lf3-static.bytednsdoc.com/obj/eden-cn/ylaelkeh7nuhfnuhf/modernjs-cover.png" width="300" alt="Modern.js Logo" /></a>

diff --git a/packages/builder/builder-webpack-provider/README.md b/packages/builder/builder-webpack-provider/README.md
@@ -1,3 +1,4 @@
+> DEPRECATED: use [Rsbuild](https://github.com/web-infra-dev/rsbuild) instead.
 
 <p align="center">
   <a href="https://modernjs.dev" target="blank"><img src="https://lf3-static.bytednsdoc.com/obj/eden-cn/ylaelkeh7nuhfnuhf/modernjs-cover.png" width="300" alt="Modern.js Logo" /></a>

diff --git a/packages/builder/builder/README.md b/packages/builder/builder/README.md
@@ -1,3 +1,4 @@
+> DEPRECATED: use [Rsbuild](https://github.com/web-infra-dev/rsbuild) instead.
 
 <p align="center">
   <a href="https://modernjs.dev" target="blank"><img src="https://lf3-static.bytednsdoc.com/obj/eden-cn/ylaelkeh7nuhfnuhf/modernjs-cover.png" width="300" alt="Modern.js Logo" /></a>

diff --git a/packages/builder/plugin-esbuild/README.md b/packages/builder/plugin-esbuild/README.md
@@ -1,3 +1,5 @@
+> DEPRECATED: use [Rsbuild](https://github.com/web-infra-dev/rsbuild) instead.
+
 <p align="center">
   <a href="https://modernjs.dev" target="blank"><img src="https://lf3-static.bytednsdoc.com/obj/eden-cn/ylaelkeh7nuhfnuhf/modernjs-cover.png" width="300" alt="Modern.js Logo" /></a>
 </p>

diff --git a/packages/builder/plugin-esbuild/src/index.ts b/packages/builder/plugin-esbuild/src/index.ts
@@ -15,6 +15,9 @@ export interface PluginEsbuildOptions {
   minimize?: false | MinifyPluginOptions;
 }
 
+/**
+ * @deprecated Using @rsbuild/plugin-esbuild instead.
+ * */
 export function builderPluginEsbuild(
   userOptions: PluginEsbuildOptions = {},
 ): BuilderPlugin<BuilderPluginAPI> {

diff --git a/packages/builder/plugin-image-compress/README.md b/packages/builder/plugin-image-compress/README.md
@@ -1,3 +1,4 @@
+> DEPRECATED: use [Rsbuild](https://github.com/web-infra-dev/rsbuild) instead.
 
 <p align="center">
   <a href="https://modernjs.dev" target="blank"><img src="https://lf3-static.bytednsdoc.com/obj/eden-cn/ylaelkeh7nuhfnuhf/modernjs-cover.png" width="300" alt="Modern.js Logo" /></a>

diff --git a/packages/builder/plugin-image-compress/src/index.ts b/packages/builder/plugin-image-compress/src/index.ts
@@ -33,7 +33,11 @@ const normalizeOptions = (options: Options[]) => {
   return normalized;
 };
 
-/** Options enable by default: {@link DEFAULT_OPTIONS} */
+/**
+ * @deprecated Using [@rsbuild/plugin-image-compress](https://rsbuild.dev/plugins/list/plugin-image-compress) instead.
+ *
+ * Options enable by default: {@link DEFAULT_OPTIONS}
+ * */
 export const builderPluginImageCompress: IPluginImageCompress = (
   ...args
 ): BuilderPlugin => ({

diff --git a/packages/builder/plugin-node-polyfill/README.md b/packages/builder/plugin-node-polyfill/README.md
@@ -1,3 +1,4 @@
+> DEPRECATED: use [Rsbuild](https://github.com/web-infra-dev/rsbuild) instead.
 
 <p align="center">
   <a href="https://modernjs.dev" target="blank"><img src="https://lf3-static.bytednsdoc.com/obj/eden-cn/ylaelkeh7nuhfnuhf/modernjs-cover.png" width="300" alt="Modern.js Logo" /></a>

diff --git a/packages/builder/plugin-node-polyfill/src/index.ts b/packages/builder/plugin-node-polyfill/src/index.ts
@@ -27,12 +27,8 @@ const getProvideLibs = async () => {
 };
 
 /**
- * Usage:
- *
- *   const { builderPluginNodePolyfill } = await import('@modern-js/builder-plugin-node-polyfill');
- *
- *   builder.addPlugins([ builderPluginNodePolyfill() ]);
- */
+ * @deprecated Using [@rsbuild/plugin-node-polyfill](https://rsbuild.dev/plugins/list/plugin-node-polyfill) instead.
+ * */
 export function builderPluginNodePolyfill(): BuilderPlugin<
   WebpackBuilderPluginAPI | RspackBuilderPluginAPI
 > {

diff --git a/packages/builder/plugin-stylus/README.md b/packages/builder/plugin-stylus/README.md
@@ -1,3 +1,4 @@
+> DEPRECATED: use [Rsbuild](https://github.com/web-infra-dev/rsbuild) instead.
 
 <p align="center">
   <a href="https://modernjs.dev" target="blank"><img src="https://lf3-static.bytednsdoc.com/obj/eden-cn/ylaelkeh7nuhfnuhf/modernjs-cover.png" width="300" alt="Modern.js Logo" /></a>

diff --git a/packages/builder/plugin-stylus/src/index.ts b/packages/builder/plugin-stylus/src/index.ts
@@ -18,6 +18,9 @@ type StylusLoaderOptions = {
 
 export type PluginStylusOptions = StylusLoaderOptions;
 
+/**
+ * @deprecated Using [@rsbuild/plugin-stylus](https://rsbuild.dev/plugins/list/plugin-stylus) instead.
+ * */
 export function builderPluginStylus(
   options?: PluginStylusOptions,
 ): BuilderPlugin<BuilderPluginAPI> {

diff --git a/packages/builder/plugin-swc/README.md b/packages/builder/plugin-swc/README.md
@@ -1,3 +1,4 @@
+> DEPRECATED: use [Rsbuild](https://github.com/web-infra-dev/rsbuild) instead.
 
 <p align="center">
   <a href="https://modernjs.dev" target="blank"><img src="https://lf3-static.bytednsdoc.com/obj/eden-cn/ylaelkeh7nuhfnuhf/modernjs-cover.png" width="300" alt="Modern.js Logo" /></a>

diff --git a/packages/builder/plugin-swc/src/plugin.ts b/packages/builder/plugin-swc/src/plugin.ts
@@ -16,6 +16,8 @@ import { SwcMinimizerPlugin } from './minizer';
 const PLUGIN_NAME = 'builder-plugin-swc';
 
 /**
+ * @deprecated Using \@rsbuild/plugin-swc instead.
+ *
  * In this plugin, we do:
  * - Remove Babel loader if exists
  * - Add our own swc loader

diff --git a/packages/builder/plugin-vue/README.md b/packages/builder/plugin-vue/README.md
@@ -1,3 +1,4 @@
+> DEPRECATED: use [Rsbuild](https://github.com/web-infra-dev/rsbuild) instead.
 
 <p align="center">
   <a href="https://modernjs.dev" target="blank"><img src="https://lf3-static.bytednsdoc.com/obj/eden-cn/ylaelkeh7nuhfnuhf/modernjs-cover.png" width="300" alt="Modern.js Logo" /></a>

diff --git a/packages/builder/plugin-vue/src/index.ts b/packages/builder/plugin-vue/src/index.ts
@@ -10,6 +10,9 @@ export type PluginVueOptions = {
   vueLoaderOptions?: VueLoaderOptions;
 };
 
+/**
+ * @deprecated Using [@rsbuild/plugin-vue](https://rsbuild.dev/plugins/list/plugin-vue) instead.
+ * */
 export function builderPluginVue(
   options: PluginVueOptions = {},
 ): BuilderPlugin<BuilderPluginAPI> {

diff --git a/packages/builder/plugin-vue2/README.md b/packages/builder/plugin-vue2/README.md
@@ -1,3 +1,4 @@
+> DEPRECATED: use [Rsbuild](https://github.com/web-infra-dev/rsbuild) instead.
 
 <p align="center">
   <a href="https://modernjs.dev" target="blank"><img src="https://lf3-static.bytednsdoc.com/obj/eden-cn/ylaelkeh7nuhfnuhf/modernjs-cover.png" width="300" alt="Modern.js Logo" /></a>

diff --git a/packages/builder/plugin-vue2/src/index.ts b/packages/builder/plugin-vue2/src/index.ts
@@ -18,6 +18,9 @@ export type PluginVueOptions = {
   vueLoaderOptions?: VueLoaderOptions;
 };
 
+/**
+ * @deprecated Using [@rsbuild/plugin-vue2](https://rsbuild.dev/plugins/list/plugin-vue2) instead.
+ * */
 export function builderPluginVue2(
   options: PluginVueOptions = {},
 ): BuilderPlugin<BuilderPluginAPI> {