@modern-js/main-doc 2.65.5 → 2.66.1-alpha.0

package/docs/en/plugin/plugin-system/relationship.mdx

@@ -1,119 +0,0 @@
----
-sidebar_position: 4
----
-
-# Relationship
-
-The plugin configuration object in Modern.js provides a series of fields to control plugin order, mutual exclusion, and other capabilities. The available fields are as follows:
-
-- `name`: `string`, sets the name of the current plugin.
-- `pre`: `string[]`, these plugins will be adjusted to be executed before the current plugin.
-- `post`: `string[]`, these plugins will be adjusted to be executed after the current plugin.
-- `rivals`: `string[]`, mutually exclusive plugins, an error will be thrown when encountering these plugins.
-- `required`: `string[]`, required plugins, an error will be thrown when the corresponding plugin is not found in the plugin list.
-- `usePlugin`: `CliPlugin[]`, registers other plugins.
-
-The above parameters can be used to achieve plugin front, back, mutual exclusion, and mandatory logic.
-
-## Plugin Sorting
-
-Modern.js plugins achieve plugin sorting functionality through the `pre` and `post` parameters.
-
-### Pre
-
-By default, plugins are executed in the order they are added. You can declare preceding plugins to be executed by using the `pre` field.
-
-For example, there are the following two plugins:
-
-```ts title=foo.ts
-const foo = {
-  name: 'plugin-foo',
-};
-```
-
-```ts title=bar.ts
-const bar = {
-  name: 'plugin-bar',
-  pre: ['plugin-foo'],
-};
-```
-
-The `bar` plugin configures the `foo` plugin in the `pre` field, so the'foo' plugin must be executed before the `bar` plugin.
-
-### Post
-
-Declare succeeding plugins to be executed by using the `post` field.
-
-```ts title=foo.ts
-const foo = {
-  name: 'plugin-foo',
-};
-```
-
-```ts title=bar.ts
-const bar = {
-  name: 'plugin-bar',
-  post: ['plugin-foo'],
-};
-```
-
-If you use the `post` parameter in the `bar` plugin's configuration and set it to `['foo']`, then the `foo` plugin will be executed after the `bar` plugin.
-
-## rivals
-
-The rivals field can be used to declare a mutual exclusion relationship between plugins.
-
-there are two plugin:
-
-```ts title=foo.ts
-const foo = {
-  name: 'plugin-foo',
-};
-```
-
-```ts title=bar.ts
-const bar = {
-  name: 'plugin-bar',
-  rivals: ['plugin-foo'],
-};
-```
-
-The `bar` plugin has been configured with the `foo` plugin in the `rivals` field, therefore an error will be thrown if both the `foo` and `bar` plugins are added simultaneously.
-
-## required
-
-The `required` field can be used to declare a dependency relationship between plugins.
-
-there are two plugin:
-
-```ts title=foo.ts
-const foo = {
-  name: 'plugin-foo',
-};
-```
-
-```ts title=bar.ts
-const bar = {
-  name: 'plugin-bar',
-  required: ['plugin-foo'],
-};
-```
-
-The `bar` plugin has been configured with the `foo` plugin in the `required` field. Therefore, an error will be thrown when using the `bar` plugin if the `foo` plugin is not configured.
-
-## Register Plugin
-
-When there is a dependency relationship between plugins, we can also actively register another plugin in a plugin by using `usePlugin`.
-
-```ts title=foo.ts
-const foo = () => ({
-  name: 'plugin-foo',
-});
-
-const bar = () => ({
-  name: 'plugin-bar',
-  usePlugin: [foo()],
-});
-```
-
-When the user configures the `bar` plugin, the foo plugin will also be automatically registered and activated. The user does not need to register the `foo` plugin separately.

package/docs/en/plugin/rsbuild-plugins.mdx

@@ -1,3 +0,0 @@
-# Overview
-
-- [@modern-js/plugin-esbuild](/plugin/rsbuild-plugins/plugin-esbuild): Provides esbuild compilation support.

package/docs/zh/plugin/cli-plugins.mdx

@@ -1,6 +0,0 @@
-# 概览
-
-- [@modern-js/plugin-tailwindcss](/plugin/cli-plugins/plugin-tailwind)：提供使用 Tailwind CSS 样式的能力。
-- [@modern-js/plugin-bff](/plugin/cli-plugins/plugin-bff)：提供 BFF 服务，一体化调用的能力。
-- [@modern-js/plugin-ssg](/plugin/cli-plugins/plugin-bff)：提供静态站点生成的能力。
-- [@modern-js/plugin-swc](/plugin/cli-plugins/plugin-swc)：提供 SWC 编译支持。

package/docs/zh/plugin/plugin-system/_meta.json

@@ -1,10 +0,0 @@
-[
-  "introduction",
-  "lifecycle",
-  "hook",
-  "implement",
-  "relationship",
-  "extend",
-  "plugin-api",
-  "hook-list"
-]

package/docs/zh/plugin/plugin-system/extend.mdx

@@ -1,163 +0,0 @@
----
-sidebar_position: 5
----
-
-# 扩展插件 Hook
-
-本小节介绍如何通过动态注册 [Hook 模型](/plugin/plugin-system/hook) 的方式来扩展插件 Hook。
-
-## 示例
-
-这里我们用一个简单的例子演示一下。假设我们要添加一些管理控制台输出信息的 Hook。
-
-首先我们初始化一个空的项目文件，并添加基础依赖：
-
-```bash
-$ npx @modern-js/create@latest modern-js-demo
-```
-
-### 创建 Hook
-
-我们先创建一个 Hook 模型：
-
-```ts title=config/plugin/myPlugin.ts
-import { createWaterfall } from '@modern-js/plugin';
-
-const message = createWaterfall<string[]>();
-```
-
-然后注册它：
-
-```ts title=config/plugin/myPlugin.ts
-import type { CliPlugin } from '@modern-js/core';
-
-export const myPlugin = (): CliPlugin => ({
-  name: 'my-plugin',
-
-  registerHook: {
-    message,
-  },
-});
-```
-
-添加 Hook 类型：
-
-```ts title=config/plugin/myPlugin.ts
-declare module '@modern-js/core' {
-  export interface Hooks {
-    message: typeof message;
-  }
-}
-```
-
-### 使用 Hook
-
-创建插件，通过 `commands` Hook 函数，添加命令处理逻辑：
-
-```ts title=config/plugin/myPlugin.ts
-import type { CliPlugin } from '@modern-js/core';
-
-export const myPlugin = (): CliPlugin => ({
-  name: 'my-plugin',
-
-  setup(api) {
-    return {
-      commands({ program }) {
-        program.command('message').action(async () => {
-          const hookRunners = api.useHookRunners();
-          const messages = hookRunners.message([]);
-          console.log(messages.join('\n'));
-        });
-      },
-    };
-  },
-});
-```
-
-最后 `config/plugin/myPlugin.ts` 的状态是：
-
-```ts title=config/plugin/myPlugin.ts
-import { createWaterfall } from '@modern-js/plugin';
-import type { CliPlugin } from '@modern-js/core';
-
-const message = createWaterfall<string[]>();
-
-export const myPlugin = (): CliPlugin => ({
-  name: 'my-plugin',
-
-  registerHook: {
-    message,
-  },
-
-  setup(api) {
-    return {
-      commands({ program }) {
-        program.command('message').action(async () => {
-          const hookRunners = api.useHookRunners();
-          const messages = hookRunners.message([]);
-          console.log(messages.join('\n'));
-        });
-      },
-    };
-  },
-});
-
-declare module '@modern-js/core' {
-  export interface Hooks {
-    message: typeof message;
-  }
-}
-```
-
-然后在 `modern.config.ts` 中添加这个插件：
-
-```ts title="modern.config.ts"
-import { defineConfig } from '@modern-js/app-tools';
-import { myPlugin } from './config/plugin/myPlugin';
-
-export default defineConfig({
-  plugins: [myPlugin()],
-});
-```
-
-这时运行 `npx modern message` 就会执行相关逻辑，但由于没有收集到任何信息，所以控制台输出为空。
-
-那这里我们添加一个：
-
-```ts title=config/plugin/otherPlugin.ts
-import type { CliPlugin } from '@modern-js/core';
-
-export const otherPlugin = (): CliPlugin => ({
-  name: 'other-plugin',
-
-  setup(api) {
-    return {
-      message(list) {
-        return [...list, '[foo] line 0', '[foo] line 1'];
-      },
-    };
-  },
-});
-```
-
-将它添加到配置中：
-
-```ts title="modern.config.ts"
-import { defineConfig } from '@modern-js/app-tools';
-import { myPlugin } from './config/plugin/myPlugin';
-import { otherPlugin } from './config/plugin/otherPlugin';
-
-export default defineConfig({
-  plugins: [myPlugin(), otherPlugin()],
-});
-```
-
-这时运行 `npx modern message` 就可以在控制台看到信息了：
-
-```bash
-$ modern message
-[foo] line 0
-[foo] line 1
-```
-
-以上面这种方式就可以扩展出拥有各种能力的插件 Hook。