@modern-js/main-doc 2.0.0-beta.0 → 2.0.0-beta.1

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

@@ -0,0 +1,92 @@
+---
+sidebar_position: 0
+---
+
+# Configure to use
+
+There are two configurations in the Modern.js, a compile configuration and a server runtime configuration.
+
+The compile configuration can be configured in two places:
+
+- `package.json` file
+- `modern.config.t(j)s` file in the root path
+
+:::warning Warning
+Configurations in both `package.json` and `modern.config.t(j)s` file are not supported for the same configuration. Configuration in `modern.config. t(j)s` is recommended.
+:::
+
+Server runtime configuration can be configured in the `modern.server-runtime.config.t(j)s` file in the root path.
+
+## Configure in the configuration file
+
+Modern.js configuration files are defined in the root path of the project, and both `.js` and `.ts` formats are supported:
+
+- `modern.config.js`
+- `modern.config.ts`
+
+### modern.config.js
+
+You can use JavaScript syntax in the `modern.config.js` file and it is more flexible than in the `package.json` file.
+
+For example, you can define configuration options for function types in `modern.config.js`:
+
+```js title="modern.config.js"
+export default {
+  source: {
+    alias: opts => {
+      opts['@common'] = './src/common';
+    },
+  },
+};
+```
+
+You can also dynamically set it with `process.env.NODE _ENV`:
+
+```js title="modern.config.js"
+export default {
+  server: {
+    ssr: process.env.NODE_ENV === 'development',
+  },
+};
+```
+
+### modern.config.ts
+
+We recommend using configuration files in `.ts` format, which provides friendly TypeScript type hints to help you avoid configuration errors.
+
+Import the `defineConfig` tool function from `@modern-js/app-tools`, which will help you with configuration type derivation and type completion:
+
+```ts title="modern.config.ts"
+import { defineConfig } from '@modern-js/app-tools';
+
+export default defineConfig({
+  source: {
+    alias: {
+      '@common': './src/common',
+    },
+  },
+});
+```
+
+## Configure in package.json (not recommended)
+
+In addition to configuration files, configuration options can also be set the `modernConfig` field in the `package.json`, such as:
+
+```json title="package.json"
+{
+  "modernConfig": {
+    "source": {
+      "alias": {
+        "@common": "./src/common"
+      }
+    }
+  }
+}
+```
+
+Due to the limitation of the JSON file format, only simple types such as numbers, strings, boolean values, arrays, etc. can be defined in `package.json`. When we need to set the value of the function type, it is recommended to set it in the Modern.js configuration file.
+
+## Note
+
+- It is not recommended to use both `package.json` and `modern.config.t[j]s` for configuration. If both are used and a configuration conflict occurs, Modern.js will prompt error on the command line.
+- `@modern-js/runtime` exports the [defineConfig](/docs/apis/app/runtime/app/define-config) API of the same name, please pay attention to the distinction.

package/en/docusaurus-plugin-content-docs/current.json

@@ -0,0 +1,262 @@
+{
+  "version.label": {
+    "message": "Next",
+    "description": "The label for version current"
+  },
+  "sidebar.tutorialsSidebar.category.基础": {
+    "message": "基础",
+    "description": "The label for category 基础 in sidebar tutorialsSidebar"
+  },
+  "sidebar.tutorialsSidebar.category.创建第一个应用": {
+    "message": "创建第一个应用",
+    "description": "The label for category 创建第一个应用 in sidebar tutorialsSidebar"
+  },
+  "sidebar.tutorialsSidebar.category.1: 手动创建应用工程": {
+    "message": "1: 手动创建应用工程",
+    "description": "The label for category 1: 手动创建应用工程 in sidebar tutorialsSidebar"
+  },
+  "sidebar.tutorialsSidebar.category.2: 自动创建应用工程": {
+    "message": "2: 自动创建应用工程",
+    "description": "The label for category 2: 自动创建应用工程 in sidebar tutorialsSidebar"
+  },
+  "sidebar.tutorialsSidebar.category.3: 确认编程环境": {
+    "message": "3: 确认编程环境",
+    "description": "The label for category 3: 确认编程环境 in sidebar tutorialsSidebar"
+  },
+  "sidebar.tutorialsSidebar.category.4: 写 JS 代码": {
+    "message": "4: 写 JS 代码",
+    "description": "The label for category 4: 写 JS 代码 in sidebar tutorialsSidebar"
+  },
+  "sidebar.tutorialsSidebar.category.5: 使用 UI 组件": {
+    "message": "5: 使用 UI 组件",
+    "description": "The label for category 5: 使用 UI 组件 in sidebar tutorialsSidebar"
+  },
+  "sidebar.tutorialsSidebar.category.6: 添加 UI 组件": {
+    "message": "6: 添加 UI 组件",
+    "description": "The label for category 6: 添加 UI 组件 in sidebar tutorialsSidebar"
+  },
+  "sidebar.tutorialsSidebar.category.7: 添加应用入口": {
+    "message": "7: 添加应用入口",
+    "description": "The label for category 7: 添加应用入口 in sidebar tutorialsSidebar"
+  },
+  "sidebar.tutorialsSidebar.category.8: 添加客户端路由": {
+    "message": "8: 添加客户端路由",
+    "description": "The label for category 8: 添加客户端路由 in sidebar tutorialsSidebar"
+  },
+  "sidebar.tutorialsSidebar.category.9: 添加 BFF": {
+    "message": "9: 添加 BFF",
+    "description": "The label for category 9: 添加 BFF in sidebar tutorialsSidebar"
+  },
+  "sidebar.tutorialsSidebar.category.10: 添加业务模型": {
+    "message": "10: 添加业务模型",
+    "description": "The label for category 10: 添加业务模型 in sidebar tutorialsSidebar"
+  },
+  "sidebar.tutorialsSidebar.category.11: 添加容器组件": {
+    "message": "11: 添加容器组件",
+    "description": "The label for category 11: 添加容器组件 in sidebar tutorialsSidebar"
+  },
+  "sidebar.guidesSidebar.category.开始": {
+    "message": "开始",
+    "description": "The label for category 开始 in sidebar guidesSidebar"
+  },
+  "sidebar.guidesSidebar.category.核心概念": {
+    "message": "核心概念",
+    "description": "The label for category 核心概念 in sidebar guidesSidebar"
+  },
+  "sidebar.guidesSidebar.category.基础功能": {
+    "message": "基础功能",
+    "description": "The label for category 基础功能 in sidebar guidesSidebar"
+  },
+  "sidebar.guidesSidebar.category.CSS 开发方案": {
+    "message": "CSS 开发方案",
+    "description": "The label for category CSS 开发方案 in sidebar guidesSidebar"
+  },
+  "sidebar.guidesSidebar.category.进阶功能": {
+    "message": "进阶功能",
+    "description": "The label for category 进阶功能 in sidebar guidesSidebar"
+  },
+  "sidebar.guidesSidebar.category.BFF": {
+    "message": "BFF",
+    "description": "The label for category BFF in sidebar guidesSidebar"
+  },
+  "sidebar.guidesSidebar.category.专题详解": {
+    "message": "专题详解",
+    "description": "The label for category 专题详解 in sidebar guidesSidebar"
+  },
+  "sidebar.guidesSidebar.category.Reduck 状态管理": {
+    "message": "Reduck 状态管理",
+    "description": "The label for category Reduck 状态管理 in sidebar guidesSidebar"
+  },
+  "sidebar.guidesSidebar.category.微前端": {
+    "message": "微前端",
+    "description": "The label for category 微前端 in sidebar guidesSidebar"
+  },
+  "sidebar.guidesSidebar.category.Monorepo": {
+    "message": "Monorepo",
+    "description": "The label for category Monorepo in sidebar guidesSidebar"
+  },
+  "sidebar.guidesSidebar.category.包版本管理": {
+    "message": "包版本管理",
+    "description": "The label for category 包版本管理 in sidebar guidesSidebar"
+  },
+  "sidebar.guidesSidebar.category.自定义插件": {
+    "message": "自定义插件",
+    "description": "The label for category 自定义插件 in sidebar guidesSidebar"
+  },
+  "sidebar.guidesSidebar.category.自定义生成器插件": {
+    "message": "自定义生成器插件",
+    "description": "The label for category 自定义生成器插件 in sidebar guidesSidebar"
+  },
+  "sidebar.guidesSidebar.category.常见问题": {
+    "message": "常见问题",
+    "description": "The label for category 常见问题 in sidebar guidesSidebar"
+  },
+  "sidebar.apisAppSidebar.category.文件约定": {
+    "message": "Convention",
+    "description": "The label for category convention in sidebar apisAppSidebar"
+  },
+  "sidebar.apisAppSidebar.category.src/": {
+    "message": "src/",
+    "description": "The label for category src/ in sidebar apisAppSidebar"
+  },
+  "sidebar.apisAppSidebar.category.api/": {
+    "message": "api/",
+    "description": "The label for category api/ in sidebar apisAppSidebar"
+  },
+  "sidebar.apisAppSidebar.category.函数写法": {
+    "message": "Function",
+    "description": "The label for category Function in sidebar apisAppSidebar"
+  },
+  "sidebar.apisAppSidebar.category.框架写法": {
+    "message": "Framework",
+    "description": "The label for category Framework in sidebar apisAppSidebar"
+  },
+  "sidebar.apisAppSidebar.category.server/": {
+    "message": "server/",
+    "description": "The label for category server/ in sidebar apisAppSidebar"
+  },
+  "sidebar.apisAppSidebar.category.config/": {
+    "message": "config/",
+    "description": "The label for category config/ in sidebar apisAppSidebar"
+  },
+  "sidebar.apisAppSidebar.category.命令": {
+    "message": "Commands",
+    "description": "The label for category command in sidebar apisAppSidebar"
+  },
+  "sidebar.apisAppSidebar.category.运行时": {
+    "message": "Runtime",
+    "description": "The label for category runtime in sidebar apisAppSidebar"
+  },
+  "sidebar.apisAppSidebar.category.核心 API": {
+    "message": "Core API",
+    "description": "The label for category Core API in sidebar apisAppSidebar"
+  },
+  "sidebar.apisAppSidebar.category.App API": {
+    "message": "App API",
+    "description": "The label for category App API in sidebar apisAppSidebar"
+  },
+  "sidebar.apisAppSidebar.category.BFF Server API": {
+    "message": "BFF Server API",
+    "description": "The label for category BFF Server API in sidebar apisAppSidebar"
+  },
+  "sidebar.apisAppSidebar.category.Model API": {
+    "message": "Model API",
+    "description": "The label for category Model API in sidebar apisAppSidebar"
+  },
+  "sidebar.apisAppSidebar.category.Container API": {
+    "message": "Container API",
+    "description": "The label for category Container API in sidebar apisAppSidebar"
+  },
+  "sidebar.apisAppSidebar.category.Testing API": {
+    "message": "Testing API",
+    "description": "The label for category Testing API in sidebar apisAppSidebar"
+  },
+  "sidebar.apisAppSidebar.category.Web Server API": {
+    "message": "Web Server API",
+    "description": "The label for category Web Server API in sidebar apisAppSidebar"
+  },
+  "sidebar.apisAppSidebar.category.Utility API": {
+    "message": "Utility API",
+    "description": "The label for category Utility API in sidebar apisAppSidebar"
+  },
+  "sidebar.apisAppSidebar.category.loadable": {
+    "message": "loadable",
+    "description": "The label for category loadable in sidebar apisAppSidebar"
+  },
+  "sidebar.apisAppSidebar.category.插件 API": {
+    "message": "插件 API",
+    "description": "The label for category 插件 API in sidebar apisAppSidebar"
+  },
+  "sidebar.apisMonorepoSidebar.category.文件约定": {
+    "message": "Convention",
+    "description": "The label for category convention in sidebar apisMonorepoSidebar"
+  },
+  "sidebar.apisMonorepoSidebar.category.命令": {
+    "message": "命令",
+    "description": "The label for category 命令 in sidebar apisMonorepoSidebar"
+  },
+  "sidebar.apisGeneratorSidebar.category.生成器插件 API": {
+    "message": "生成器插件 API",
+    "description": "The label for category 生成器插件 API in sidebar apisGeneratorSidebar"
+  },
+  "sidebar.apisGeneratorSidebar.category.自定义输入 API": {
+    "message": "自定义输入 API",
+    "description": "The label for category 自定义输入 API in sidebar apisGeneratorSidebar"
+  },
+  "sidebar.apisGeneratorSidebar.category.获取信息 API": {
+    "message": "获取信息 API",
+    "description": "The label for category 获取信息 API in sidebar apisGeneratorSidebar"
+  },
+  "sidebar.apisGeneratorSidebar.category.Hook 函数 API": {
+    "message": "Hook 函数 API",
+    "description": "The label for category Hook 函数 API in sidebar apisGeneratorSidebar"
+  },
+  "sidebar.apisGeneratorSidebar.category.文件操作 API": {
+    "message": "文件操作 API",
+    "description": "The label for category 文件操作 API in sidebar apisGeneratorSidebar"
+  },
+  "sidebar.apisGeneratorSidebar.category.启用功能 API": {
+    "message": "启用功能 API",
+    "description": "The label for category 启用功能 API in sidebar apisGeneratorSidebar"
+  },
+  "sidebar.apisGeneratorSidebar.category.NPM API": {
+    "message": "NPM API",
+    "description": "The label for category NPM API in sidebar apisGeneratorSidebar"
+  },
+  "sidebar.apisGeneratorSidebar.category.GIT API": {
+    "message": "GIT API",
+    "description": "The label for category GIT API in sidebar apisGeneratorSidebar"
+  },
+  "sidebar.configsAppSidebar.category.source (源文件)": {
+    "message": "source",
+    "description": "The label for category source in sidebar configsAppSidebar"
+  },
+  "sidebar.configsAppSidebar.category.output (构建产物)": {
+    "message": "output",
+    "description": "The label for category output in sidebar configsAppSidebar"
+  },
+  "sidebar.configsAppSidebar.category.runtime (运行时)": {
+    "message": "runtime",
+    "description": "The label for category runtime in sidebar configsAppSidebar"
+  },
+  "sidebar.configsAppSidebar.category.server (服务器)": {
+    "message": "server",
+    "description": "The label for category server in sidebar configsAppSidebar"
+  },
+  "sidebar.configsAppSidebar.category.bff (BFF API)": {
+    "message": "bff",
+    "description": "The label for category bff in sidebar configsAppSidebar"
+  },
+  "sidebar.configsAppSidebar.category.dev (开发调试)": {
+    "message": "dev ",
+    "description": "The label for category dev in sidebar configsAppSidebar"
+  },
+  "sidebar.configsAppSidebar.category.testing (测试)": {
+    "message": "testing",
+    "description": "The label for category testing in sidebar configsAppSidebar"
+  },
+  "sidebar.configsAppSidebar.category.tools (底层配置)": {
+    "message": "tools",
+    "description": "The label for category tools  in sidebar configsAppSidebar"
+  }
+}

package/package.json

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

package/scripts/config.ts

@@ -0,0 +1,98 @@
+import path from 'path';
+import fs from 'fs-extra';
+
+const tip: Record<string, string> = {
+  zh: '该配置为 Modern.js Builder 配置，可能存在无法跳转的链接。详细信息可参考',
+  en: 'This configuration is Modern.js Builder configuration, there may be links that cannot be redirected. for details, please refer to',
+};
+
+export type Summary = {
+  name: string;
+  dirname: string;
+};
+
+export type Language = 'en' | 'zh';
+
+const createMarkdown = (summary: Summary, lng: Language) => {
+  const { name, dirname } = summary;
+
+  return `---
+title: ${dirname}.${name}
+sidebar_label: ${name}
+---
+
+:::info BUILDER
+${
+  tip[lng]
+} [${dirname}.${name}](https://modernjs.dev/builder/zh/api/config-${dirname}.html#${dirname}-${name.toLowerCase()})。
+:::
+
+import Main from '@modern-js/builder-doc/${lng}/config/${dirname}/${name}.md'
+
+<Main />
+`;
+};
+
+const hyphenateRE = /\B([A-Z]+)/g;
+const hyphenate = function (str: string) {
+  return str.replace(hyphenateRE, '-$1').toLowerCase();
+};
+
+const configPath = 'configure/app';
+const getBaseDir = (lng: Language) => {
+  const cwd = process.cwd();
+  const baseDir =
+    lng === 'zh'
+      ? path.join(cwd, lng, configPath)
+      : path.join(
+          cwd,
+          lng,
+          'docusaurus-plugin-content-docs/current',
+          configPath,
+        );
+  return baseDir;
+};
+
+export const gen = (jsonMap: Record<Language, Summary[]>) => {
+  Object.keys(jsonMap).forEach(lng => {
+    const baseDir = getBaseDir(lng as Language);
+    const json = jsonMap[lng as Language];
+    json.forEach(summary => {
+      const mdDir = path.join(baseDir, summary.dirname);
+      const mdPath = path.join(mdDir, `${hyphenate(summary.name)}.md`);
+      if (!fs.existsSync(mdDir)) {
+        fs.mkdirpSync(mdDir);
+      }
+      fs.writeFileSync(mdPath, createMarkdown(summary, lng as Language));
+    });
+  });
+};
+
+export const diff = (jsonMap: Record<Language, Summary[]>) => {
+  const outdatedURI: string[] = [];
+  Object.keys(jsonMap).forEach(lng => {
+    const json = jsonMap[lng as Language];
+    const old: {
+      name: string;
+      dirname: string;
+    }[] = require(`./summary.${lng}.json`);
+
+    const outdated = old.filter(oldSummary => {
+      return !json.find(summary => {
+        return (
+          summary.dirname === oldSummary.dirname &&
+          summary.name === oldSummary.name
+        );
+      });
+    });
+
+    const URIAry = outdated.map(summary => {
+      const baseDir = getBaseDir(lng as Language);
+      const mdDir = path.join(baseDir, summary.dirname);
+      const mdPath = path.join(mdDir, `${hyphenate(summary.name)}.md`);
+      return mdPath;
+    });
+    outdatedURI.push(...URIAry);
+  });
+  return outdatedURI;
+};

package/scripts/summary.en.json

@@ -0,0 +1 @@
+[{"name":"assetPrefix","dirname":"dev"},{"name":"hmr","dirname":"dev"},{"name":"https","dirname":"dev"},{"name":"port","dirname":"dev"},{"name":"progressBar","dirname":"dev"},{"name":"startUrl","dirname":"dev"},{"name":"lazyCompilation","dirname":"experiments"},{"name":"appIcon","dirname":"html"},{"name":"crossorigin","dirname":"html"},{"name":"disableHtmlFolder","dirname":"html"},{"name":"favicon","dirname":"html"},{"name":"faviconByEntries","dirname":"html"},{"name":"inject","dirname":"html"},{"name":"injectByEntries","dirname":"html"},{"name":"meta","dirname":"html"},{"name":"metaByEntries","dirname":"html"},{"name":"mountId","dirname":"html"},{"name":"template","dirname":"html"},{"name":"templateByEntries","dirname":"html"},{"name":"templateParameters","dirname":"html"},{"name":"templateParametersByEntries","dirname":"html"},{"name":"title","dirname":"html"},{"name":"titleByEntries","dirname":"html"},{"name":"assetPrefix","dirname":"output"},{"name":"assetsRetry","dirname":"output"},{"name":"charset","dirname":"output"},{"name":"cleanDistPath","dirname":"output"},{"name":"convertToRem","dirname":"output"},{"name":"copy","dirname":"output"},{"name":"cssModuleLocalIdentName","dirname":"output"},{"name":"dataUriLimit","dirname":"output"},{"name":"disableCssModuleExtension","dirname":"output"},{"name":"disableFilenameHash","dirname":"output"},{"name":"disableInlineRuntimeChunk","dirname":"output"},{"name":"disableMinimize","dirname":"output"},{"name":"disableSourceMap","dirname":"output"},{"name":"disableTsChecker","dirname":"output"},{"name":"distPath","dirname":"output"},{"name":"enableAssetFallback","dirname":"output"},{"name":"enableAssetManifest","dirname":"output"},{"name":"enableCssModuleTSDeclaration","dirname":"output"},{"name":"enableInlineScripts","dirname":"output"},{"name":"enableInlineStyles","dirname":"output"},{"name":"enableLatestDecorators","dirname":"output"},{"name":"externals","dirname":"output"},{"name":"filename","dirname":"output"},{"name":"legalComments","dirname":"output"},{"name":"overrideBrowserslist","dirname":"output"},{"name":"polyfill","dirname":"output"},{"name":"svgDefaultExport","dirname":"output"},{"name":"buildCache","dirname":"performance"},{"name":"bundleAnalyze","dirname":"performance"},{"name":"chunkSplit","dirname":"performance"},{"name":"printFileSize","dirname":"performance"},{"name":"profile","dirname":"performance"},{"name":"removeConsole","dirname":"performance"},{"name":"removeMomentLocale","dirname":"performance"},{"name":"sri","dirname":"security"},{"name":"alias","dirname":"source"},{"name":"compileJsDataURI","dirname":"source"},{"name":"define","dirname":"source"},{"name":"exclude","dirname":"source"},{"name":"globalVars","dirname":"source"},{"name":"include","dirname":"source"},{"name":"moduleScopes","dirname":"source"},{"name":"preEntry","dirname":"source"},{"name":"resolveExtensionPrefix","dirname":"source"},{"name":"resolveMainFields","dirname":"source"},{"name":"autoprefixer","dirname":"tools"},{"name":"babel","dirname":"tools"},{"name":"cssExtract","dirname":"tools"},{"name":"cssLoader","dirname":"tools"},{"name":"devServer","dirname":"tools"},{"name":"htmlPlugin","dirname":"tools"},{"name":"inspector","dirname":"tools"},{"name":"less","dirname":"tools"},{"name":"minifyCss","dirname":"tools"},{"name":"postcss","dirname":"tools"},{"name":"pug","dirname":"tools"},{"name":"sass","dirname":"tools"},{"name":"styleLoader","dirname":"tools"},{"name":"styledComponents","dirname":"tools"},{"name":"terser","dirname":"tools"},{"name":"tsChecker","dirname":"tools"},{"name":"tsLoader","dirname":"tools"},{"name":"webpack","dirname":"tools"},{"name":"webpackChain","dirname":"tools"}]

package/scripts/summary.zh.json

@@ -0,0 +1 @@
+[{"name":"assetPrefix","dirname":"dev"},{"name":"hmr","dirname":"dev"},{"name":"https","dirname":"dev"},{"name":"port","dirname":"dev"},{"name":"progressBar","dirname":"dev"},{"name":"startUrl","dirname":"dev"},{"name":"lazyCompilation","dirname":"experiments"},{"name":"appIcon","dirname":"html"},{"name":"crossorigin","dirname":"html"},{"name":"disableHtmlFolder","dirname":"html"},{"name":"favicon","dirname":"html"},{"name":"faviconByEntries","dirname":"html"},{"name":"inject","dirname":"html"},{"name":"injectByEntries","dirname":"html"},{"name":"meta","dirname":"html"},{"name":"metaByEntries","dirname":"html"},{"name":"mountId","dirname":"html"},{"name":"template","dirname":"html"},{"name":"templateByEntries","dirname":"html"},{"name":"templateParameters","dirname":"html"},{"name":"templateParametersByEntries","dirname":"html"},{"name":"title","dirname":"html"},{"name":"titleByEntries","dirname":"html"},{"name":"assetPrefix","dirname":"output"},{"name":"assetsRetry","dirname":"output"},{"name":"charset","dirname":"output"},{"name":"cleanDistPath","dirname":"output"},{"name":"convertToRem","dirname":"output"},{"name":"copy","dirname":"output"},{"name":"cssModuleLocalIdentName","dirname":"output"},{"name":"dataUriLimit","dirname":"output"},{"name":"disableCssModuleExtension","dirname":"output"},{"name":"disableFilenameHash","dirname":"output"},{"name":"disableInlineRuntimeChunk","dirname":"output"},{"name":"disableMinimize","dirname":"output"},{"name":"disableSourceMap","dirname":"output"},{"name":"disableTsChecker","dirname":"output"},{"name":"distPath","dirname":"output"},{"name":"enableAssetFallback","dirname":"output"},{"name":"enableAssetManifest","dirname":"output"},{"name":"enableCssModuleTSDeclaration","dirname":"output"},{"name":"enableInlineScripts","dirname":"output"},{"name":"enableInlineStyles","dirname":"output"},{"name":"enableLatestDecorators","dirname":"output"},{"name":"externals","dirname":"output"},{"name":"filename","dirname":"output"},{"name":"legalComments","dirname":"output"},{"name":"overrideBrowserslist","dirname":"output"},{"name":"polyfill","dirname":"output"},{"name":"svgDefaultExport","dirname":"output"},{"name":"buildCache","dirname":"performance"},{"name":"bundleAnalyze","dirname":"performance"},{"name":"chunkSplit","dirname":"performance"},{"name":"printFileSize","dirname":"performance"},{"name":"profile","dirname":"performance"},{"name":"removeConsole","dirname":"performance"},{"name":"removeMomentLocale","dirname":"performance"},{"name":"sri","dirname":"security"},{"name":"alias","dirname":"source"},{"name":"compileJsDataURI","dirname":"source"},{"name":"define","dirname":"source"},{"name":"exclude","dirname":"source"},{"name":"globalVars","dirname":"source"},{"name":"include","dirname":"source"},{"name":"moduleScopes","dirname":"source"},{"name":"preEntry","dirname":"source"},{"name":"resolveExtensionPrefix","dirname":"source"},{"name":"resolveMainFields","dirname":"source"},{"name":"autoprefixer","dirname":"tools"},{"name":"babel","dirname":"tools"},{"name":"cssExtract","dirname":"tools"},{"name":"cssLoader","dirname":"tools"},{"name":"devServer","dirname":"tools"},{"name":"htmlPlugin","dirname":"tools"},{"name":"inspector","dirname":"tools"},{"name":"less","dirname":"tools"},{"name":"minifyCss","dirname":"tools"},{"name":"postcss","dirname":"tools"},{"name":"pug","dirname":"tools"},{"name":"sass","dirname":"tools"},{"name":"styleLoader","dirname":"tools"},{"name":"styledComponents","dirname":"tools"},{"name":"terser","dirname":"tools"},{"name":"tsChecker","dirname":"tools"},{"name":"tsLoader","dirname":"tools"},{"name":"webpack","dirname":"tools"},{"name":"webpackChain","dirname":"tools"}]

package/scripts/sync.ts

@@ -1,6 +1,6 @@
-import fs from 'fs';
 import path, { basename, dirname, extname } from 'path';
-import { gen } from './gen-config';
+import fs from 'fs-extra';
+import { diff, gen } from './config';
 
 const walk = (dir: string) => {
   const fl: string[] = [];
@@ -22,15 +22,36 @@ const summary = (lng: string) => {
       `./node_modules/@modern-js/builder-doc/${lng}/config`,
     ),
   );
-  return fl.map(fpath => {
+  const json = fl.map(fpath => {
     return {
       name: basename(fpath).replace(extname(fpath), ''),
       dirname: basename(dirname(fpath)),
     };
   });
+
+  return json;
 };
 
+const zh = summary('zh');
+const en = summary('en');
+
+// 寻找已经过时的配置，并删除
+const outdated = diff({
+  zh,
+  en,
+});
+
+outdated.forEach(uri => {
+  if (fs.existsSync(uri)) {
+    fs.unlinkSync(uri);
+  }
+});
+
+// 生成新的配置
+fs.writeJSONSync(path.join(__dirname, 'summary.en.json'), en);
+fs.writeJSONSync(path.join(__dirname, 'summary.zh.json'), zh);
+
 gen({
-  zh: summary('zh'),
-  en: summary('en'),
+  zh,
+  en,
 });

package/zh/apis/app/commands/build.md

@@ -13,7 +13,7 @@ Options:
   --analyze   分析构建产物体积，查看各个模块打包后的大小
 ```
 
-`modern build` 命令默认会在 `/dist` 目录下构建出可用于生产环境的产物。
+`modern build` 命令默认会在 `dist/` 目录下构建出可用于生产环境的产物。
 
 可以通过修改配置 [`output.distPath`](/docs/configure/app/output/dist-path) 指定产物的输出目录。
 
@@ -39,6 +39,6 @@ File sizes after production build:
 
 ## 命令行参数
 
-import CommandTip from '@site/docs/components/command-tip.md'
+import CommandTip from '@site-docs/components/command-tip.md'
 
 <CommandTip />

package/zh/apis/app/commands/dev.md

@@ -26,6 +26,6 @@ App running at:
   > Network:  http://192.168.0.1:8080/
 ```
 
-import CommandTip from '@site/docs/components/command-tip.md'
+import CommandTip from '@site-docs/components/command-tip.md'
 
 <CommandTip />

package/zh/apis/app/commands/index.md

@@ -4,7 +4,7 @@ type: ref
 
 # 命令
 
-本节涵盖了使用应用工程的所有命令。
+本节涵盖了所有命令。
 
 
 

package/zh/apis/app/commands/lint.md

@@ -13,10 +13,10 @@ Options:
   -h, --help  display help for command
 ```
 
-运行 `ESLint` 检查代码语法情况， 通长情况下，我们只需要在 `git commit` 阶段通过 `lint-staged` 检查本次提交修改的部分代码。
+运行 `ESLint` 检查代码语法情况。通常情况下，我们只需要在 `git commit` 阶段通过 `lint-staged` 检查本次提交修改的部分代码。
 
 * `--no-fix` 参数设置后可以关闭自动修复 lint 错误代码的能力。
 
-import CommandTip from '@site/docs/components/command-tip.md'
+import CommandTip from '@site-docs/components/command-tip.md'
 
 <CommandTip />

package/zh/apis/app/commands/new.md

@@ -19,7 +19,7 @@ Options:
 
 比如添加应用入口、启用启用一些可选功能如 Tailwind CSS、微前端开发模式等。
 
-import CommandTip from '@site/docs/components/command-tip.md'
+import CommandTip from '@site-docs/components/command-tip.md'
 
 <CommandTip />
 

package/zh/apis/app/commands/start.md

@@ -25,7 +25,7 @@ export default defineConfig({
 })
 ```
 
-import CommandTip from '@site/docs/components/command-tip.md'
+import CommandTip from '@site-docs/components/command-tip.md'
 
 <CommandTip />
 

package/zh/apis/app/commands/test.md

@@ -31,6 +31,6 @@ Time:        0.994 s, estimated 1 s
 `src` 和 `api` 目录下面 `*.test.(js|ts)` 都会默认识别为测试用例。
 :::
 
-import CommandTip from '@site/docs/components/command-tip.md'
+import CommandTip from '@site-docs/components/command-tip.md'
 
 <CommandTip />

package/zh/apis/app/commands/upgrade.md

@@ -14,8 +14,6 @@ Options:
   -h, --help             display help for command
 ```
 
-`modern upgrade` 命令，用于升级项目 Modern.js 相关依赖至最新版本。
-
 在项目根目录下执行命令 `npx modern upgrade`，会默认将当前执行命令项目的 `package.json` 中的 Modern.js 相关依赖更新至最新版本。
 
 :::info