@modern-js/main-doc 0.0.0-next-20221228051706 → 0.0.0-next-20221228084828

package/CHANGELOG.md

@@ -1,8 +1,8 @@
 # @modern-js/main-doc
 
-## 0.0.0-next-20221228051706
+## 0.0.0-next-20221228084828
 
 ### Patch Changes
 
 - Updated dependencies [dda38c9c3]
-  - @modern-js/builder-doc@0.0.0-next-20221228051706
+  - @modern-js/builder-doc@0.0.0-next-20221228084828

package/en/docusaurus-plugin-content-docs/current/configure/app/auto-load-plugin.md

@@ -0,0 +1,62 @@
+---
+title: autoLoadPlugins
+sidebar_position: 11
+---
+
+- Type: `boolean`
+- Default: `false`
+
+Used to configure whether Modern.js enables auto-registration of plugins.
+
+### Manual Registration Plugin
+
+By default, installing the plugin requires you to register the plugin manually in the `modern.config.ts`.
+
+```ts title="modern.config.ts"
+import AppToolsPlugin, { defineConfig } from '@modern-js/app-tools';
+import I18nPlugin from '@modern-js/plugin-i18n';
+
+default export defineConfig({
+  plugins: [AppToolsPlugin(), I18nPlugin()]
+})
+
+```
+
+### Auto Registration plugin
+
+In addition to means registration, Modern.js also provides a way to automatically register plugins: set the `autoLoadPlugin` configuration item to `true`.
+
+```ts title="modern.config.ts"
+import { defineConfig } from '@modern-js/app-tools';
+
+default export defineConfig({
+  autoLoadPlugins: true
+})
+```
+
+Modern.js will help you automatically register the plugin by following these steps
+
+1. Modern.js maintains an official list of plugins internally.
+
+```js
+const InternalPlugins = ['@modern-js/app-tools', '@modern-js/plugin-i18n', ...];
+```
+
+2. Modern.js will read your `package.json` and collect the dependency information.
+
+```json title="package.json"
+"dependencies": {
+  "@modern-js/plugin-i18n": "x.x.x"
+  ...
+},
+"devDependencies": {
+  "@modern-js/app-tools": "x.x.x"
+  ...
+}
+```
+
+3. Modern.js observes that when you install dependencies such as `@modern-js/plugin-i18n` and `@modern-js/app-tools`, automatic plugin registration will be imported.
+
+You can notice that this approach is relatively black-box and you are not even aware of the process of loading the plugin. We want to expose more details to the developer and be able to let the developer control the process.
+
+**Therefore we recommend you to register the plugin manually.**

package/package.json

@@ -11,20 +11,20 @@
     "modern",
     "modern.js"
   ],
-  "version": "0.0.0-next-20221228051706",
+  "version": "0.0.0-next-20221228084828",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/",
     "access": "public"
   },
   "peerDependencies": {
-    "@modern-js/builder-doc": "0.0.0-next-20221228051706"
+    "@modern-js/builder-doc": "0.0.0-next-20221228084828"
   },
   "devDependencies": {
     "ts-node": "^10",
     "fs-extra": "^10",
     "@types/node": "^16",
     "@types/fs-extra": "^9",
-    "@modern-js/builder-doc": "0.0.0-next-20221228051706"
+    "@modern-js/builder-doc": "0.0.0-next-20221228084828"
   },
   "scripts": {
     "build": "npx ts-node ./scripts/sync.ts"

package/zh/configure/app/auto-load-plugin.md

@@ -0,0 +1,62 @@
+---
+title: autoLoadPlugins (自动注册插件)
+sidebar_position: 11
+---
+
+- 类型：`boolean`
+- 默认值：`false`
+
+用于配置 Modern.js 是否开启自动注册插件。
+
+### 手动注册插件
+
+默认情况下，安装插件后需要你在 `modern.config.ts` 文件中手动注册插件。
+
+```ts title="modern.config.ts"
+import AppToolsPlugin, { defineConfig } from '@modern-js/app-tools';
+import I18nPlugin from '@modern-js/plugin-i18n';
+
+default export defineConfig({
+  plugins: [AppToolsPlugin(), I18nPlugin()]
+})
+
+```
+
+### 自动注册插件
+
+除了手段注册，Modern.js 还提供自动注册插件的方式: 将 `autoLoadPlugin` 配置项置为 `true`。
+
+```ts title="modern.config.ts"
+import { defineConfig } from '@modern-js/app-tools';
+
+default export defineConfig({
+  autoLoadPlugins: true
+})
+```
+
+Modern.js 将通过以下几个步骤帮你自动注册插件
+
+1. Modern.js 在内部维护一份官方插件列表。
+
+```js
+const InternalPlugins = ['@modern-js/app-tools', '@modern-js/plugin-i18n', ...];
+```
+
+2. Modern.js 将读取你的 `package.json` 文件，收集依赖信息。
+
+```json title="package.json"
+"dependencies": {
+  "@modern-js/plugin-i18n": "x.x.x"
+  ...
+},
+"devDependencies": {
+  "@modern-js/app-tools": "x.x.x"
+  ...
+}
+```
+
+3. Modern.js 观察到你安装了 `@modern-js/plugin-i18n` 和 `@modern-js/app-tools` 等依赖后，将会引入插件自动注册。
+
+可以注意到这种方式相对黑盒，你甚至对加载插件的过程是无感知的。我们希望更多的细节暴露给开发者，能让开发者去控制这一过程。
+
+**因此我们更加推荐你手动注册插件。**

package/zh/configure/app/tools/_category_.json

@@ -1,4 +1,4 @@
 {
   "label": "tools (底层配置)",
-  "position": 10
+  "position": 12
 }