npm - @modern-js/main-doc - Versions diffs - 2.0.0-beta.0 → 2.0.0-beta.1 - Mend

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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (507) hide show

package/zh/configure/app/html/inject.md CHANGED Viewed

@@ -1,7 +1,6 @@
 ---
 title: html.inject
 sidebar_label: inject
-sidebar_position: 1
 ---
 :::info BUILDER

package/zh/configure/app/html/meta-by-entries.md CHANGED Viewed

@@ -1,7 +1,6 @@
 ---
 title: html.metaByEntries
 sidebar_label: metaByEntries
-sidebar_position: 1
 ---
 :::info BUILDER

package/zh/configure/app/html/meta.md CHANGED Viewed

@@ -1,7 +1,6 @@
 ---
 title: html.meta
 sidebar_label: meta
-sidebar_position: 1
 ---
 :::info BUILDER

package/zh/configure/app/html/mount-id.md CHANGED Viewed

@@ -1,7 +1,6 @@
 ---
 title: html.mountId
 sidebar_label: mountId
-sidebar_position: 1
 ---
 :::info BUILDER

package/zh/configure/app/html/template-by-entries.md CHANGED Viewed

@@ -1,7 +1,6 @@
 ---
 title: html.templateByEntries
 sidebar_label: templateByEntries
-sidebar_position: 1
 ---
 :::info BUILDER

package/zh/configure/app/html/template-parameters-by-entries.md CHANGED Viewed

@@ -1,7 +1,6 @@
 ---
 title: html.templateParametersByEntries
 sidebar_label: templateParametersByEntries
-sidebar_position: 1
 ---
 :::info BUILDER

package/zh/configure/app/html/template-parameters.md CHANGED Viewed

@@ -1,7 +1,6 @@
 ---
 title: html.templateParameters
 sidebar_label: templateParameters
-sidebar_position: 1
 ---
 :::info BUILDER

package/zh/configure/app/html/template.md CHANGED Viewed

@@ -1,7 +1,6 @@
 ---
 title: html.template
 sidebar_label: template
-sidebar_position: 1
 ---
 :::info BUILDER

package/zh/configure/app/html/title-by-entries.md CHANGED Viewed

@@ -1,7 +1,6 @@
 ---
 title: html.titleByEntries
 sidebar_label: titleByEntries
-sidebar_position: 1
 ---
 :::info BUILDER

package/zh/configure/app/html/title.md CHANGED Viewed

@@ -1,7 +1,6 @@
 ---
 title: html.title
 sidebar_label: title
-sidebar_position: 1
 ---
 :::info BUILDER

package/zh/configure/app/output/asset-prefix.md CHANGED Viewed

@@ -1,7 +1,6 @@
 ---
 title: output.assetPrefix
 sidebar_label: assetPrefix
-sidebar_position: 1
 ---
 :::info BUILDER

package/zh/configure/app/output/assets-retry.md CHANGED Viewed

@@ -1,7 +1,6 @@
 ---
 title: output.assetsRetry
 sidebar_label: assetsRetry
-sidebar_position: 1
 ---
 :::info BUILDER

package/zh/configure/app/output/charset.md CHANGED Viewed

@@ -1,7 +1,6 @@
 ---
 title: output.charset
 sidebar_label: charset
-sidebar_position: 1
 ---
 :::info BUILDER

package/zh/configure/app/output/clean-dist-path.md CHANGED Viewed

@@ -1,7 +1,6 @@
 ---
 title: output.cleanDistPath
 sidebar_label: cleanDistPath
-sidebar_position: 1
 ---
 :::info BUILDER

package/zh/configure/app/output/convert-to-rem.md CHANGED Viewed

@@ -1,7 +1,6 @@
 ---
 title: output.convertToRem
 sidebar_label: convertToRem
-sidebar_position: 1
 ---
 :::info BUILDER

package/zh/configure/app/output/copy.md CHANGED Viewed

@@ -1,7 +1,6 @@
 ---
 title: output.copy
 sidebar_label: copy
-sidebar_position: 1
 ---
 :::info BUILDER

package/zh/configure/app/output/css-module-local-ident-name.md CHANGED Viewed

@@ -1,7 +1,6 @@
 ---
 title: output.cssModuleLocalIdentName
 sidebar_label: cssModuleLocalIdentName
-sidebar_position: 1
 ---
 :::info BUILDER

package/zh/configure/app/output/data-uri-limit.md CHANGED Viewed

@@ -1,7 +1,6 @@
 ---
 title: output.dataUriLimit
 sidebar_label: dataUriLimit
-sidebar_position: 1
 ---
 :::info BUILDER

package/zh/configure/app/output/disable-css-module-extension.md CHANGED Viewed

@@ -1,7 +1,6 @@
 ---
 title: output.disableCssModuleExtension
 sidebar_label: disableCssModuleExtension
-sidebar_position: 1
 ---
 :::info BUILDER

package/zh/configure/app/output/disable-filename-hash.md CHANGED Viewed

@@ -1,7 +1,6 @@
 ---
 title: output.disableFilenameHash
 sidebar_label: disableFilenameHash
-sidebar_position: 1
 ---
 :::info BUILDER

package/zh/configure/app/output/disable-inline-runtime-chunk.md CHANGED Viewed

@@ -1,7 +1,6 @@
 ---
 title: output.disableInlineRuntimeChunk
 sidebar_label: disableInlineRuntimeChunk
-sidebar_position: 1
 ---
 :::info BUILDER

package/zh/configure/app/output/disable-minimize.md CHANGED Viewed

@@ -1,7 +1,6 @@
 ---
 title: output.disableMinimize
 sidebar_label: disableMinimize
-sidebar_position: 1
 ---
 :::info BUILDER

package/zh/configure/app/output/disable-node-polyfill.md CHANGED Viewed

@@ -11,11 +11,9 @@ sidebar_label: disableNodePolyfill
 默认情况下我们内置了 [webpack 5 移除掉的 node polyfill](https://webpack.js.org/blog/2020-10-10-webpack-5-release/#automatic-nodejs-polyfills-removed)。
-如果确认项目下不需要任何 Node Polyfill，可以在 `modern.config.js` 中配置如下关闭内置引入的 Node Polyfill：
-```js title="modern.config.js"
-import { defineConfig } from '@modern-js/app-tools';
+如果确认项目下不需要任何 Node Polyfill，可以在 `modern.config.ts` 中配置如下关闭内置引入的 Node Polyfill：
+```typescript title="modern.config.ts"
 export default defineConfig({
   output: {
     disableNodePolyfill: true,

package/zh/configure/app/output/disable-source-map.md CHANGED Viewed

@@ -1,7 +1,6 @@
 ---
 title: output.disableSourceMap
 sidebar_label: disableSourceMap
-sidebar_position: 1
 ---
 :::info BUILDER

package/zh/configure/app/output/disable-ts-checker.md ADDED Viewed

@@ -0,0 +1,12 @@
+---
+title: output.disableTsChecker
+sidebar_label: disableTsChecker
+---
+:::info BUILDER
+该配置为 Modern.js Builder 配置，可能存在无法跳转的链接。详细信息可参考 [output.disableTsChecker](https://modernjs.dev/builder/zh/api/config-output.html#output-disabletschecker)。
+:::
+import Main from '@modern-js/builder-doc/zh/config/output/disableTsChecker.md'
+<Main />

package/zh/configure/app/output/dist-path.md CHANGED Viewed

@@ -1,7 +1,6 @@
 ---
 title: output.distPath
 sidebar_label: distPath
-sidebar_position: 1
 ---
 :::info BUILDER

package/zh/configure/app/output/enable-asset-fallback.md CHANGED Viewed

@@ -1,7 +1,6 @@
 ---
 title: output.enableAssetFallback
 sidebar_label: enableAssetFallback
-sidebar_position: 1
 ---
 :::info BUILDER

package/zh/configure/app/output/enable-asset-manifest.md CHANGED Viewed

@@ -1,7 +1,6 @@
 ---
 title: output.enableAssetManifest
 sidebar_label: enableAssetManifest
-sidebar_position: 1
 ---
 :::info BUILDER

package/zh/configure/app/output/enable-css-module-tsdeclaration.md CHANGED Viewed

@@ -1,7 +1,6 @@
 ---
 title: output.enableCssModuleTSDeclaration
 sidebar_label: enableCssModuleTSDeclaration
-sidebar_position: 1
 ---
 :::info BUILDER

package/zh/configure/app/output/enable-inline-scripts.md CHANGED Viewed

@@ -1,7 +1,6 @@
 ---
 title: output.enableInlineScripts
 sidebar_label: enableInlineScripts
-sidebar_position: 1
 ---
 :::info BUILDER

package/zh/configure/app/output/enable-inline-styles.md CHANGED Viewed

@@ -1,7 +1,6 @@
 ---
 title: output.enableInlineStyles
 sidebar_label: enableInlineStyles
-sidebar_position: 1
 ---
 :::info BUILDER

package/zh/configure/app/output/enable-latest-decorators.md CHANGED Viewed

@@ -1,7 +1,6 @@
 ---
 title: output.enableLatestDecorators
 sidebar_label: enableLatestDecorators
-sidebar_position: 1
 ---
 :::info BUILDER

package/zh/configure/app/output/enable-modern-mode.md CHANGED Viewed

@@ -4,14 +4,14 @@ sidebar_label: enableModernMode
 # output.enableModernMode
 * 类型： `boolean`
 * 默认值：`false`
-用于配置入口产物形态：
+Modern.js 默认值构建针对旧版浏览器带有 Polyfill 的 JS 产物，开启该配置后，可以在生产环境会自动构建出针对现代浏览器语法未降级的 JS 产物，产物文件名格式为 `[name].[hash]-es6/js`。
+例如配置如下配置：
-```js title="modern.config.js"
+```ts title="modern.config.ts"
 import { defineConfig } from '@modern-js/app-tools';
 export default defineConfig({
@@ -21,6 +21,14 @@ export default defineConfig({
 });
 ```
-设置 `output.enableModernMode` 后， 生产环境会自动构建出针对现代浏览器语法未降级的 js 产物和针对旧版本浏览器带有 Polyfill 的 js 产物:
+执行 `build` 命令后，除了正常的 Client 打包外， 还进行了 Modern 的打包，并且 `dist/static/js` 目录会生成 es6 相关产物。
+![](https://lf3-static.bytednsdoc.com/obj/eden-cn/zq-uylkvT/ljhwZthlaukjlkulzlp/output-enable-modern-build.jpeg)
+执行 `start` 命令后，使用最新版本 Chrome 浏览器访问，观察 Network 中请求的 JS 资源为 es6 产物。
+![](https://lf3-static.bytednsdoc.com/obj/eden-cn/zq-uylkvT/ljhwZthlaukjlkulzlp/output-enable-modern-network.jpeg)
+:::info
 更多内容可以查看[客户端兼容性](/docs/guides/advanced-features/compatibility)。
+:::

package/zh/configure/app/output/externals.md CHANGED Viewed

@@ -1,7 +1,6 @@
 ---
 title: output.externals
 sidebar_label: externals
-sidebar_position: 1
 ---
 :::info BUILDER

package/zh/configure/app/output/filename.md CHANGED Viewed

@@ -1,7 +1,6 @@
 ---
 title: output.filename
 sidebar_label: filename
-sidebar_position: 1
 ---
 :::info BUILDER

package/zh/configure/app/output/legal-comments.md CHANGED Viewed

@@ -1,7 +1,6 @@
 ---
 title: output.legalComments
 sidebar_label: legalComments
-sidebar_position: 1
 ---
 :::info BUILDER

package/zh/configure/app/output/override-browserslist.md CHANGED Viewed

@@ -1,7 +1,6 @@
 ---
 title: output.overrideBrowserslist
 sidebar_label: overrideBrowserslist
-sidebar_position: 1
 ---
 :::info BUILDER

package/zh/configure/app/output/polyfill.md CHANGED Viewed

@@ -1,7 +1,6 @@
 ---
 title: output.polyfill
 sidebar_label: polyfill
-sidebar_position: 1
 ---
 :::info BUILDER

package/zh/configure/app/output/svg-default-export.md CHANGED Viewed

@@ -1,7 +1,6 @@
 ---
 title: output.svgDefaultExport
 sidebar_label: svgDefaultExport
-sidebar_position: 1
 ---
 :::info BUILDER

package/zh/configure/app/performance/build-cache.md CHANGED Viewed

@@ -1,7 +1,6 @@
 ---
 title: performance.buildCache
 sidebar_label: buildCache
-sidebar_position: 1
 ---
 :::info BUILDER

package/zh/configure/app/performance/bundle-analyze.md CHANGED Viewed

@@ -1,7 +1,6 @@
 ---
 title: performance.bundleAnalyze
 sidebar_label: bundleAnalyze
-sidebar_position: 1
 ---
 :::info BUILDER

package/zh/configure/app/performance/chunk-split.md CHANGED Viewed

@@ -1,7 +1,6 @@
 ---
 title: performance.chunkSplit
 sidebar_label: chunkSplit
-sidebar_position: 1
 ---
 :::info BUILDER

package/zh/configure/app/performance/print-file-size.md CHANGED Viewed

@@ -1,7 +1,6 @@
 ---
 title: performance.printFileSize
 sidebar_label: printFileSize
-sidebar_position: 1
 ---
 :::info BUILDER

package/zh/configure/app/performance/profile.md CHANGED Viewed

@@ -1,7 +1,6 @@
 ---
 title: performance.profile
 sidebar_label: profile
-sidebar_position: 1
 ---
 :::info BUILDER

package/zh/configure/app/performance/remove-console.md CHANGED Viewed

@@ -1,7 +1,6 @@
 ---
 title: performance.removeConsole
 sidebar_label: removeConsole
-sidebar_position: 1
 ---
 :::info BUILDER

package/zh/configure/app/performance/remove-moment-locale.md CHANGED Viewed

@@ -1,7 +1,6 @@
 ---
 title: performance.removeMomentLocale
 sidebar_label: removeMomentLocale
-sidebar_position: 1
 ---
 :::info BUILDER

package/zh/configure/app/runtime/intro.md ADDED Viewed

@@ -0,0 +1,92 @@
+---
+sidebar_label: 总览
+sidebar_position: 1
+---
+# 总览
+此节将介绍 Runtime 插件的配置。
+## 配置方式
+### runtime
+* 类型：`Object`
+runtime 配置方式如下：
+#### 基本用法
+在 `modern.config.ts` 中配置
+```ts title="modern.config.ts"
+import { defineConfig } from '@modern-js/app-tools';
+export default defineConfig({
+  runtime: {
+    state: true,
+    router: true
+  }
+});
+```
+#### 运行时配置
+通过 [`defineConfig`](/docs/apis/app/runtime/app/define-config) API 配置：
+:::info
+当 runtime 配置中存在函数时，只能使用该方式进行配置。
+:::
+```ts title="src/App.tsx"
+import { defineConfig } from '@modern-js/runtime';
+const App = () => {
+  /** */
+};
+defineConfig(App, {
+  router: {
+    supportHtml5History: false
+  }
+})
+export default App;
+```
+:::info
+使用运行时配置，可以解决 Runtime 插件配置需要在运行时才能获取到具体内容问题。
+Runtime 插件运行时配置和直接在 `modern.config.ts` 中的配置默认会进行合并，且运行时配置优先级更高。
+:::
+:::warning
+defineConfig 中只能定义 Runtime 插件的具体配置内容，确认是否开启插件还需要通过 `package.json` 中的 `modernConfig` 或者 `modern.config.ts` 中的配置决定。
+:::
+### runtimeByEntries
+* 类型： `Object`
+* 默认值：无
+#### 说明
+按入口添加 runtime 配置，选项属性同 runtime 一致，指定值会和 runtime 属性内容做替换合并操作。
+```ts title="modern.config.ts"
+import { defineConfig } from '@modern-js/app-tools';
+export default defineConfig({
+  runtime: {
+    state: false,
+  },
+  runtimeByEntries: {
+    entry1: {
+       state: true, // { state: true }
+    },
+    entry2: { // { state: false, router: true }
+       router: true,
+    },
+  },
+});
+```

package/zh/configure/app/runtime/master-app.md CHANGED Viewed

@@ -1,37 +1,24 @@
 ---
 sidebar_label: masterApp
-sidebar_position: 3
 ---
 # runtime.masterApp
 * 类型： `Object`
-:::tip 提示
-```ts
-export declare type Config = Partial<GarfishOptions> & {
-  manifest: {
-    modules: Array<{
-        name: string;
-        entry: string;
-        activeWhen?: string;
-      }> | string;
-  };
-  LoadingComponent?: React.ComponentType | React.ElementType;
-};
-```
+:::info
+使用该配置首先需要使用 [new 命令](/docs/apis/app/commands/new)启用「微前端」功能。
 :::
 ## `manifest`
-- 类型：`modules: Array<{
+主应用添加子应用信息。
+* 类型：`modules: Array<{
         name: string;
         entry: string;
         activeWhen?: string;
       }> | string;`
-- 默认值：`null`
+* 默认值：`null`
 ### `modules`
@@ -45,8 +32,8 @@ export declare type Config = Partial<GarfishOptions> & {
 ## `LoadingComponent`
-- 类型: `React.ComponentType | React.ElementType`
-- 默认值 `null`
+* 类型: `React.ComponentType | React.ElementType`
+* 默认值 `null`
 当加载或切换子应用的时候，加载的过渡动画。

package/zh/configure/app/runtime/router.md CHANGED Viewed

@@ -1,43 +1,15 @@
 ---
 sidebar_label: router
-sidebar_position: 1
 ---
 # runtime.router
+* 类型： `boolean | Object`
+* 默认值： `false`。
+开启 `router` 之后，支持使用 Modern.js 默认提供的约定式路由进行路由管理。
-* 类型： `Object`
-* 默认值： 默认会根据当前入口访问路由设置 `historyOptions.basename`。
-:::tip 提示
-```ts
-export interface BrowserHistoryBuildOptions {
-    basename?: string | undefined;
-    forceRefresh?: boolean | undefined;
-    getUserConfirmation?: typeof getConfirmation | undefined;
-    keyLength?: number | undefined;
-}
-export interface HashHistoryBuildOptions {
-    basename?: string | undefined;
-    hashType?: HashType | undefined;
-    getUserConfirmation?: typeof getConfirmation | undefined;
-}
-export type RouterConfig =  {
-      supportHtml5History: true;
-      historyOptions: BrowserHistoryBuildOptions;
-   }
-  | {
-      supportHtml5History: false;
-      historyOptions: HashHistoryBuildOptions;
-    }
-```
-:::
-具体配置选项解释如下:
+具体配置如下：
 ### supportHtml5History
@@ -46,9 +18,3 @@ export type RouterConfig =  {
 值为 `true` 则使用 `BrowserRouter` 否则使用 `HashRouter`。
-### historyOptions
-* 类型： `BrowserHistoryBuildOptions | HashHistoryBuildOptions`
-* 默认值： 默认会根据当前入口路由设置 basename。
-historyOptions 具体配置可以参考: [history](https://github.com/remix-run/history/blob/v4/docs/Misc.md)