@modern-js/main-doc 2.1.0 → 2.3.0

package/zh/configure/app/source/disable-default-entries.md

@@ -1,28 +0,0 @@
----
-title: source.disableDefaultEntries
-sidebar_label: disableDefaultEntries
----
-
-- 类型： `boolean`
-- 默认值： `false`
-
-关闭根据项目目录结构自动识别应用构建入口的功能，默认情况下，Modern.js 会根据项目目录结构得到对应构建入口。
-
-:::info
-默认情况下，Modern.js 会根据项目目录结构得到对应入口信息。具体可参考[入口](/docs/guides/concept/entries)。
-配置关闭改机制后，需要使用 [`source.entries`](/docs/configure/app/source/entries) 配置自定义入口。
-:::
-
-:::warning 警告
-推荐按照 Modern.js 提供的目录规范组织代码可以更好使用框架的功能，避免一些冗余的配置。
-:::
-
-设置如下，即可关闭默认的行为：
-
-```ts title="modern.config.ts"
-export default defineConfig({
-  source: {
-    disableDefaultEntries: true,
-  },
-});
-```

package/zh/configure/app/source/disable-entry-dirs.md

@@ -1,38 +0,0 @@
----
-title: source.disableEntryDirs
-
-sidebar_label: disableEntryDirs
----
-
-- 类型： `string[]`
-- 默认值： `[]`
-
-默认会根据 `src` 目录识别应用入口，可通过该选项禁止某些目录被识别为应用入口。
-
-例如，当配置与目录结构如下时：
-
-```ts title="modern.config.ts"
-export default defineConfig({
-  source: {
-    disableEntryDirs: './src/one',
-  },
-});
-```
-
-```bash title="项目目录结构"
-└── src/
-    ├── one/
-    |    └── App.tsx
-    ├── two/
-    |    └── routes/
-    └── env.d.ts
-```
-
-在未设置该配置项时，Modern.js 会根据项目目录产出两个 entry:
-
-- one
-- two
-
-当设置该配置项后，`src/one` 不会作为 entry 目录被识别。
-
-常见的用法是，将 `src/common`、`src/components` 目录配置到该选项中，避免这些目录被识别为应用入口。

package/zh/configure/app/source/enable-async-entry.md

@@ -1,53 +0,0 @@
----
-title: source.enableAsyncEntry
-sidebar_label: enableAsyncEntry
----
-
-- 类型： `boolean`
-- 默认值： `false`
-
-该选项用于 webpack 模块联邦 (Module Federation）场景。
-
-开启此选项后，Modern.js 会通过 Dynamic Import 来包裹自动生成的入口文件（asynchronous boundary），使页面代码可以消费模块联邦生成的远程模块。
-
-## 背景知识
-
-如果不了解 webpack 模块联邦，请先阅读 Module Federation 官方文档：
-
-- [中文文档](https://webpack.docschina.org/concepts/module-federation/)
-- [英文文档](https://webpack.js.org/concepts/module-federation)
-
-## 示例
-
-首先，在配置文件中开启此选项：
-
-```ts title="modern.config.ts"
-export default defineConfig({
-  source: {
-    enableAsyncEntry: true,
-  },
-});
-```
-
-然后执行 `dev` 或 `build` 命令，可以看到 Modern.js 自动生成的文件变为以下结构：
-
-```bash
-node_modules
-  └─ .modern-js
-     └─ main
-        ├─ bootstrap.js  # 真正的入口代码
-        ├─ index.js      # 异步入口文件（asynchronous boundary）
-        └─ index.html
-```
-
-其中 `index.js` 的内容如下：
-
-```js
-import('./bootstrap.js');
-```
-
-此时，就可以在当前页面中消费任意的远程模块了。
-
-:::info
-Modern.js 未对 webpack 的 ModuleFederationPlugin 进行封装，请通过 [tools.webpackChain](/docs/configure/app/tools/webpack-chain) 自行配置 ModuleFederationPlugin。
-:::

package/zh/configure/app/source/entries-dir.md

@@ -1,39 +0,0 @@
----
-title: source.entriesDir
-
-sidebar_label: entriesDir
----
-
-- 类型： `string`
-- 默认值： `./src`
-
-默认会根据 `src` 目录识别应用入口，可通过该选项自定义应用入口的识别目录。
-
-例如，当配置与目录结构如下时：
-
-```ts title="modern.config.ts"
-export default defineConfig({
-  source: {
-    entriesDir: './src/pages',
-  },
-});
-```
-
-```bash title="项目目录结构"
-.
-└── src
-    └── pages
-        ├── a
-        │   └── App.jsx
-        └── b
-            └── App.jsx
-```
-
-Modern.js 会根据 `./src/pages` 目录结构生成构建入口 `a` 和入口 `b`，结果如下：
-
-```js
- {
-   a: './src/pages/a/App.jsx',
-   b: './src/pages/b/App.jsx'
- }
-```

package/zh/configure/app/source/entries.md

@@ -1,122 +0,0 @@
----
-title: source.entries
-sidebar_label: entries
----
-
-- 类型： `Object = { [ entryName: string ]: string | Object }`
-- 默认值： 根据当前项目目录结构动态结算出的默认入口对象。
-
-对于大部分场景，Modern.js 根据目录结构自动生成的入口能满足大部分业务需求。具体可参考[入口](/docs/guides/concept/entries)。
-
-如需自定义构建入口时，可以通过该选项指定。
-
-## String 类型
-
-当值为 `string` 类型时，为入口的文件路径:
-
-```ts title="modern.config.ts"
-import { defineConfig } from '@modern-js/app-tools';
-
-export default defineConfig({
-  source: {
-    entries: {
-      // 指定一个名称为 entry_customize 的新入口
-      entry_customize: './src/home/test/index.js',
-    },
-  },
-});
-```
-
-默认情况下，配置的入口等价于 `App.[jt]sx`，即指定的入口文件只需要导出应用的根组件。
-
-例如以下目录结构：
-
-```bash
-.
-├── src
-│   └── entry
-│       ├── chat.tsx
-│       └── home.tsx
-└── package.json
-```
-
-结合上面默认入口机制的内容，Modern.js 在分析上述目录结构时，不会得到任何默认入口。
-
-在不想改变目录结构的情况下（如项目迁移），可以通过 `source.entries` 自定义入口：
-
-```ts title="modern.config.js"
-export default defineConfig({
-  source: {
-    entries: {
-      home: './src/entry/home.tsx',
-      chat: './src/entry/chat.tsx',
-    },
-  },
-});
-```
-
-## Object 类型
-
-当值为 `Object` 时，可配置如下属性：
-
-- `entry`：`string`，入口文件路径。
-- `disableMount`：`boolean = false`，关闭 Modern.js 生成入口代码的行为。
-
-```ts title="modern.config.ts"
-import { defineConfig } from '@modern-js/app-tools';
-
-export default defineConfig({
-  source: {
-    entries: {
-      entry_customize: {
-        // 入口文件路径
-        entry: './src/home/test/App.jsx',
-      },
-      // 启用约定式路由
-      entry_spa: {
-        // 约定式路由的入口路径必须设置为目录
-        entry: './src/about',
-      },
-    },
-  },
-});
-```
-
-默认情况下，配置的入口等价于 `App.[jt]sx`，如果希望该入口等价于构建模式下的入口，可以将属性 `disableMount` 设置为 `true`。
-
-## 自定义入口和默认入口合并
-
-在指定 `source.entries` 后，Modern.js 会将用户自定义的入口与分析目录结构得到的默认入口合并。合并规则为：
-
-比较自定义入口设置的入口路径和默认入口路径，当入口路径一致时，自定义入口会覆盖默认入口。
-
-例如以下目录结构:
-
-```
-.
-├── src
-│   ├── chat
-│   │   └── App.jsx
-│   └── home
-│       └── index.js
-└── package.json
-```
-
-Modern.js 分析 `src/` 目录，得到默认入口 `chat` 和 `home`。当用户在 `modern.config.js` 文件中配置如下时：
-
-```ts title="modern.config.ts"
-import { defineConfig } from '@modern-js/app-tools';
-
-export default defineConfig({
-  source: {
-    entries: {
-      index: './src/home/index.js',
-    },
-  },
-};
-```
-
-可以看到自定义入口 `index` 的路径和默认入口 `home` 的路径一致，在合并的过程中，`index` 会覆盖掉 `home`，最终入口如下：
-
-- `chat -> ./src/chat/App.jsx`
-- `index -> ./src/home/index.js`

package/zh/configure/app/source/exclude.md

@@ -1,12 +0,0 @@
----
-title: source.exclude
-sidebar_label: exclude
----
-
-:::info BUILDER
-该配置为 Modern.js Builder 配置，详细信息可参考 [source.exclude](https://modernjs.dev/builder/api/config-source.html#source-exclude)。
-:::
-
-import Main from '@modern-js/builder-doc/docs/zh/config/source/exclude.md'
-
-<Main />

package/zh/configure/app/source/global-vars.md

@@ -1,12 +0,0 @@
----
-title: source.globalVars
-sidebar_label: globalVars
----
-
-:::info BUILDER
-该配置为 Modern.js Builder 配置，详细信息可参考 [source.globalVars](https://modernjs.dev/builder/api/config-source.html#source-globalvars)。
-:::
-
-import Main from '@modern-js/builder-doc/docs/zh/config/source/globalVars.md'
-
-<Main />

package/zh/configure/app/source/include.md

@@ -1,12 +0,0 @@
----
-title: source.include
-sidebar_label: include
----
-
-:::info BUILDER
-该配置为 Modern.js Builder 配置，详细信息可参考 [source.include](https://modernjs.dev/builder/api/config-source.html#source-include)。
-:::
-
-import Main from '@modern-js/builder-doc/docs/zh/config/source/include.md'
-
-<Main />

package/zh/configure/app/source/module-scopes.md

@@ -1,12 +0,0 @@
----
-title: source.moduleScopes
-sidebar_label: moduleScopes
----
-
-:::info BUILDER
-该配置为 Modern.js Builder 配置，详细信息可参考 [source.moduleScopes](https://modernjs.dev/builder/api/config-source.html#source-modulescopes)。
-:::
-
-import Main from '@modern-js/builder-doc/docs/zh/config/source/moduleScopes.md'
-
-<Main />

package/zh/configure/app/source/pre-entry.md

@@ -1,12 +0,0 @@
----
-title: source.preEntry
-sidebar_label: preEntry
----
-
-:::info BUILDER
-该配置为 Modern.js Builder 配置，详细信息可参考 [source.preEntry](https://modernjs.dev/builder/api/config-source.html#source-preentry)。
-:::
-
-import Main from '@modern-js/builder-doc/docs/zh/config/source/preEntry.md'
-
-<Main />

package/zh/configure/app/source/resolve-extension-prefix.md

@@ -1,12 +0,0 @@
----
-title: source.resolveExtensionPrefix
-sidebar_label: resolveExtensionPrefix
----
-
-:::info BUILDER
-该配置为 Modern.js Builder 配置，详细信息可参考 [source.resolveExtensionPrefix](https://modernjs.dev/builder/api/config-source.html#source-resolveextensionprefix)。
-:::
-
-import Main from '@modern-js/builder-doc/docs/zh/config/source/resolveExtensionPrefix.md'
-
-<Main />

package/zh/configure/app/source/resolve-main-fields.md

@@ -1,12 +0,0 @@
----
-title: source.resolveMainFields
-sidebar_label: resolveMainFields
----
-
-:::info BUILDER
-该配置为 Modern.js Builder 配置，详细信息可参考 [source.resolveMainFields](https://modernjs.dev/builder/api/config-source.html#source-resolvemainfields)。
-:::
-
-import Main from '@modern-js/builder-doc/docs/zh/config/source/resolveMainFields.md'
-
-<Main />

package/zh/configure/app/testing/transformer.md

@@ -1,14 +0,0 @@
----
-title: testing.transformer
-sidebar_label: transformer
-sidebar_position: 1
----
-
-- 类型：`'babel-jest' | 'ts-jest'`
-- 默认值：`babel-jest`
-
-配置执行测试的时候对于源码的编译工具： [babel-jest](https://www.npmjs.com/package/babel-jest) 或 [ts-jest](https://github.com/kulshekhar/ts-jest)。默认使用 `babel-jest`。
-
-:::info 补充信息
-`babel-jest` 也可以编译 TS 文件，但不会类型报错，如果你需要跑测试的时候对 TS 类型进行校验，那么请使用 `ts-jest`。
-:::

package/zh/configure/app/tools/autoprefixer.md

@@ -1,12 +0,0 @@
----
-title: tools.autoprefixer
-sidebar_label: autoprefixer
----
-
-:::info BUILDER
-该配置为 Modern.js Builder 配置，详细信息可参考 [tools.autoprefixer](https://modernjs.dev/builder/api/config-tools.html#tools-autoprefixer)。
-:::
-
-import Main from '@modern-js/builder-doc/docs/zh/config/tools/autoprefixer.md'
-
-<Main />

package/zh/configure/app/tools/babel.md

@@ -1,12 +0,0 @@
----
-title: tools.babel
-sidebar_label: babel
----
-
-:::info BUILDER
-该配置为 Modern.js Builder 配置，详细信息可参考 [tools.babel](https://modernjs.dev/builder/api/config-tools.html#tools-babel)。
-:::
-
-import Main from '@modern-js/builder-doc/docs/zh/config/tools/babel.md'
-
-<Main />

package/zh/configure/app/tools/css-extract.md

@@ -1,12 +0,0 @@
----
-title: tools.cssExtract
-sidebar_label: cssExtract
----
-
-:::info BUILDER
-该配置为 Modern.js Builder 配置，详细信息可参考 [tools.cssExtract](https://modernjs.dev/builder/api/config-tools.html#tools-cssextract)。
-:::
-
-import Main from '@modern-js/builder-doc/docs/zh/config/tools/cssExtract.md'
-
-<Main />

package/zh/configure/app/tools/css-loader.md

@@ -1,12 +0,0 @@
----
-title: tools.cssLoader
-sidebar_label: cssLoader
----
-
-:::info BUILDER
-该配置为 Modern.js Builder 配置，详细信息可参考 [tools.cssLoader](https://modernjs.dev/builder/api/config-tools.html#tools-cssloader)。
-:::
-
-import Main from '@modern-js/builder-doc/docs/zh/config/tools/cssLoader.md'
-
-<Main />

package/zh/configure/app/tools/dev-server.md

@@ -1,12 +0,0 @@
----
-title: tools.devServer
-sidebar_label: devServer
----
-
-:::info BUILDER
-该配置为 Modern.js Builder 配置，详细信息可参考 [tools.devServer](https://modernjs.dev/builder/api/config-tools.html#tools-devserver)。
-:::
-
-import Main from '@modern-js/builder-doc/docs/zh/config/tools/devServer.md'
-
-<Main />

package/zh/configure/app/tools/esbuild.md

@@ -1,38 +0,0 @@
----
-title: tools.esbuild
-sidebar_label: esbuild
----
-
-- 类型： `Object`
-- 默认值： `undefined`
-
-## 介绍
-
-:::tip esbuild 介绍
-[esbuild](https://esbuild.github.io/) 是一款基于 Golang 开发的前端构建工具，具有打包、编译和压缩 JavaScript 代码的功能，相比传统的打包编译工具，esbuild 在性能上有显著提升。在代码压缩方面，相比 webpack 内置的 terser 压缩器，esbuild 在性能上有数十倍的提升。
-:::
-
-Modern.js 提供了 esbuild 插件，让你能使用 esbuild 代替 babel-loader、ts-loader 和 terser 等库进行代码编译和压缩。在大型工程中开启后，**可以大幅度减少代码编译和压缩所需的时间，同时有效避免 OOM (heap out of memory) 问题**。
-
-## 配置项
-
-你可以通过 `tools.esbuild` 配置项来设置 esbuild 编译行为。
-
-```js title="modern.config.ts"
-import { defineConfig } from '@modern-js/app-tools';
-
-export default defineConfig({
-  tools: {
-    esbuild: {
-      loader: {
-        target: 'chrome61',
-      },
-      minimize: {
-        target: 'chrome61',
-      },
-    },
-  },
-});
-```
-
-完整配置项请参考 [Modern.js Builder - esbuild 插件配置](https://modernjs.dev/builder/zh/plugins/plugin-esbuild.html#%E9%85%8D%E7%BD%AE)。

package/zh/configure/app/tools/html-plugin.md

@@ -1,12 +0,0 @@
----
-title: tools.htmlPlugin
-sidebar_label: htmlPlugin
----
-
-:::info BUILDER
-该配置为 Modern.js Builder 配置，详细信息可参考 [tools.htmlPlugin](https://modernjs.dev/builder/api/config-tools.html#tools-htmlplugin)。
-:::
-
-import Main from '@modern-js/builder-doc/docs/zh/config/tools/htmlPlugin.md'
-
-<Main />

package/zh/configure/app/tools/inspector.md

@@ -1,12 +0,0 @@
----
-title: tools.inspector
-sidebar_label: inspector
----
-
-:::info BUILDER
-该配置为 Modern.js Builder 配置，详细信息可参考 [tools.inspector](https://modernjs.dev/builder/api/config-tools.html#tools-inspector)。
-:::
-
-import Main from '@modern-js/builder-doc/docs/zh/config/tools/inspector.md'
-
-<Main />

package/zh/configure/app/tools/jest.md

@@ -1,39 +0,0 @@
----
-title: tools.jest
-
-sidebar_label: jest
----
-
-- 类型： `Object | Function`
-- 默认值：`{}`
-
-:::caution 注意
-需要先通过 `pnpm run new` 启用 单元测试 功能。
-:::
-
-对应 [Jest](https://jestjs.io/docs/configuration) 的配置，当为 `Object` 类型时，可以配置 Jest 所支持的所有底层配置 。
-
-```js title=modern.config.js
-export default defineConfig({
-  tools: {
-    jest: {
-      testTimeout: 10000,
-    },
-  },
-});
-```
-
-值为 `Function` 类型时，默认配置作为第一个参数传入，需要返回新的 Jest 配置对象。
-
-```js title=modern.config.js
-export default defineConfig({
-  tools: {
-    jest: options => {
-      return {
-        ...options,
-        testTimeout: 10000,
-      };
-    },
-  },
-});
-```

package/zh/configure/app/tools/less.md

@@ -1,12 +0,0 @@
----
-title: tools.less
-sidebar_label: less
----
-
-:::info BUILDER
-该配置为 Modern.js Builder 配置，详细信息可参考 [tools.less](https://modernjs.dev/builder/api/config-tools.html#tools-less)。
-:::
-
-import Main from '@modern-js/builder-doc/docs/zh/config/tools/less.md'
-
-<Main />

package/zh/configure/app/tools/minify-css.md

@@ -1,12 +0,0 @@
----
-title: tools.minifyCss
-sidebar_label: minifyCss
----
-
-:::info BUILDER
-该配置为 Modern.js Builder 配置，详细信息可参考 [tools.minifyCss](https://modernjs.dev/builder/api/config-tools.html#tools-minifycss)。
-:::
-
-import Main from '@modern-js/builder-doc/docs/zh/config/tools/minifyCss.md'
-
-<Main />

package/zh/configure/app/tools/postcss.md

@@ -1,12 +0,0 @@
----
-title: tools.postcss
-sidebar_label: postcss
----
-
-:::info BUILDER
-该配置为 Modern.js Builder 配置，详细信息可参考 [tools.postcss](https://modernjs.dev/builder/api/config-tools.html#tools-postcss)。
-:::
-
-import Main from '@modern-js/builder-doc/docs/zh/config/tools/postcss.md'
-
-<Main />

package/zh/configure/app/tools/pug.md

@@ -1,12 +0,0 @@
----
-title: tools.pug
-sidebar_label: pug
----
-
-:::info BUILDER
-该配置为 Modern.js Builder 配置，详细信息可参考 [tools.pug](https://modernjs.dev/builder/api/config-tools.html#tools-pug)。
-:::
-
-import Main from '@modern-js/builder-doc/docs/zh/config/tools/pug.md'
-
-<Main />

package/zh/configure/app/tools/sass.md

@@ -1,12 +0,0 @@
----
-title: tools.sass
-sidebar_label: sass
----
-
-:::info BUILDER
-该配置为 Modern.js Builder 配置，详细信息可参考 [tools.sass](https://modernjs.dev/builder/api/config-tools.html#tools-sass)。
-:::
-
-import Main from '@modern-js/builder-doc/docs/zh/config/tools/sass.md'
-
-<Main />

package/zh/configure/app/tools/style-loader.md

@@ -1,12 +0,0 @@
----
-title: tools.styleLoader
-sidebar_label: styleLoader
----
-
-:::info BUILDER
-该配置为 Modern.js Builder 配置，详细信息可参考 [tools.styleLoader](https://modernjs.dev/builder/api/config-tools.html#tools-styleloader)。
-:::
-
-import Main from '@modern-js/builder-doc/docs/zh/config/tools/styleLoader.md'
-
-<Main />

package/zh/configure/app/tools/styled-components.md

@@ -1,12 +0,0 @@
----
-title: tools.styledComponents
-sidebar_label: styledComponents
----
-
-:::info BUILDER
-该配置为 Modern.js Builder 配置，详细信息可参考 [tools.styledComponents](https://modernjs.dev/builder/api/config-tools.html#tools-styledcomponents)。
-:::
-
-import Main from '@modern-js/builder-doc/docs/zh/config/tools/styledComponents.md'
-
-<Main />