@modern-js/main-doc 2.5.0 → 2.6.0

package/.turbo/turbo-build.log

@@ -1,4 +1,4 @@
 
-> @modern-js/main-doc@2.5.0 build /github/workspace/packages/toolkit/main-doc
+> @modern-js/main-doc@2.6.0 build /github/workspace/packages/toolkit/main-doc
 > npx ts-node ./scripts/sync.ts
 

package/en/apis/app/commands.mdx

@@ -0,0 +1,297 @@
+---
+sidebar_position: 1
+---
+
+# Commands
+
+Modern.js has some built-in commands that can help you quickly start a development server, build production environment code, and more.
+
+Through this chapter, you can learn about the built-in commands of Modern.js and how to use them.
+
+## modern dev
+
+The `modern dev` command is used to start a local development server and compile the source code in the development environment.
+
+```bash
+Usage: modern dev [options]
+
+Options:
+  -e --entry <entry>    compiler by entry
+  -c --config <config>  configuration file path, which can be a relative path or an absolute path
+  -h, --help            show command help
+  --analyze             analyze the bundle and view size of each module
+  --api-only            only start API service
+```
+
+After running `modern dev`, Modern.js will watch source file changes and apply hot module replacement.
+
+```bash
+$ modern dev
+
+info    Starting dev server...
+info    App running at:
+
+  > Local:    http://localhost:8080/
+  > Network:  http://192.168.0.1:8080/
+```
+
+### Compile Partial Pages
+
+In multi-page (MPA) projects, the `--entry` option can be added to specify one or more pages to compile. In this way, only part of the code in the project will be compiled, and the dev startup speed will be faster.
+
+For example, execute `modern dev --entry`, the entry selector will be displayed in the command line interface:
+
+```bash
+$ modern dev --entry
+
+? Please select the entry that needs to be built
+❯ ◯ foo
+  ◯ bar
+  ◯ baz
+```
+
+For example, if you select the `foo` entry, only the code related to the `foo` entry will be compiled, and the code of other pages will not be compiled.
+
+### Specify the page by parameter
+
+You can also specify the page name through parameters after `--entry`, and the names of multiple pages can be separated by commas.
+
+```bash
+# Compile foo page
+modern dev --entry foo
+
+# Compile foo and bar pages
+modern dev --entry foo,bar
+```
+
+## modern start
+
+`modern start` is an alias of `modern dev` command, the usage of the two are exactly the same.
+
+## modern build
+
+The `modern build` command will build a production-ready product in the `dist/` directory by default. You can specify the output directory by modifying the configuration [`output.distPath`](/configure/app/output/dist-path).
+
+```bash
+Usage: modern build [options]
+
+Options:
+  -c --config <config>  configuration file path, which can be a relative path or an absolute path
+  -h, --help            show command help
+  --analyze             analyze the bundle and view size of each module
+```
+
+### Analyze Bundle
+
+execute `npx modern build --analyze` command，can produce an HTML file that analyzes the volume of the bundle while packaging the production code:
+
+```
+Bundle Analyzer saved report to /example/dist/report.html
+File sizes after production build:
+
+  122.35 KB  dist/static/js/885.1d4fbe5a.js
+  2.3 KB     dist/static/js/main.4b8e8d64.js
+  761 B      dist/static/js/runtime-main.edb7cf35.js
+  645 B      dist/static/css/main.0dd3ecc1.css
+```
+
+Open the above HTML file in the browser, you can see the tile diagram of the packaged product, and perform package volume analysis and optimization:
+
+<img src="https://lf3-static.bytednsdoc.com/obj/eden-cn/aphqeh7uhohpquloj/modern-js/mwa-build-analyze-8784f762c1ab0cb20935829d5f912c4c.png" />
+
+> this features based on [webpack-bundle-analyzer](https://github.com/webpack-contrib/webpack-bundle-analyzer).
+
+## modern new
+
+The `modern new` command is used to enable features in an existing project.
+
+For example, add application entry, enable some optional features such as Tailwind CSS, micro frontend, etc.
+
+```bash
+Usage: modern new [options]
+
+Options:
+  -d, --debug            using debug mode to log something (default: false)
+  -c, --config <config>  set default generator config(json string)
+  --dist-tag <tag>       use specified tag version for its generator
+  --registry             set npm registry url to run npm command
+  -h, --help             show command help
+```
+
+### Add Entry
+
+In the project, execute the `new` command to add entries as follows:
+
+```bash
+$ npx modern new
+? Action Create project element
+? Create project element New "entry"
+? Entry name entry
+```
+
+### Enable Features
+
+In the project, execute the `new` command to enable features as follows:
+
+```bash
+$ npx modern new
+? Action Enable features
+? Enable features (Use arrow keys)
+❯ Enable Tailwind CSS
+  Enable BFF
+  Enable SSG
+  Enable Micro Frontend
+  Enable Unit Test / Integration Test
+  Enable Visual Testing (Storybook)
+```
+
+:::tip
+The `--config` parameter needs to use a JSON string.
+
+pnpm does not support the use of JSON strings as parameter values currently. Use `npm new` to turn on.【[Relate Issue](https://github.com/pnpm/pnpm/issues/3876)】
+:::
+
+## modern serve
+
+Usually use the `modern serve` command to enable project run in the production environment, and you need to execute the [`build'](/apis/app/commands#modern-build) command in advance to build the outputs.
+
+```bash
+Usage: modern serve [options]
+
+Options:
+  -c --config <config>  configuration file path, which can be a relative path or an absolute path
+  -h, --help            show command help
+  --api-only            only run API service
+```
+
+By default, the project will run in `localhost:8080`, you can modify the Server port number with `server.port`:
+
+```js
+export default defineConfig({
+  server: {
+    port: 8081,
+  },
+});
+```
+
+## modern upgrade
+
+Execute the command `npx modern upgrade` in the project, by default, dependencies in the `package.json` are updated to the latest version.
+
+```
+Usage: modern upgrade [options]
+
+Options:
+  --registry <registry>  specify npm registry (default: "")
+  -d,--debug             using debug mode to log something (default: false)
+  --cwd <cwd>            app directory (default: "")
+  -h, --help             show command help
+```
+
+## modern inspect
+
+The `modern inspect` command is used to view the [Modern.js Builder config](https://modernjs.dev/builder/en/guide/basic/builder-config.html) and webpack config of the project.
+
+```
+Usage: modern inspect [options]
+
+Options:
+  --env <env>           view the configuration in the target environment (default: "development")
+  --output <output>     Specify the path to output in the dist (default: "/")
+  --verbose             Show the full function in the result
+  -c --config <config>  configuration file path, which can be a relative path or an absolute path
+  -h, --help            show command help
+```
+
+After executing the command `npx modern inspect` in the project root directory, the following files will be generated in the `dist` directory of the project:
+
+- `builder.config.js`: The Modern.js Builder config to use at build time.
+- `webpack.config.web.js`: The webpack config used by to use at build time.
+
+```bash
+➜ npx modern inspect
+
+Inspect config succeed, open following files to view the content:
+
+  - Builder Config: /root/my-project/dist/builder.config.js
+  - Webpack Config (web): /root/my-project/dist/webpack.config.web.js
+```
+
+### Configuration Env
+
+By default, the inspect command will output the development configs, you can use the `--env production` option to output the production configs:
+
+```bash
+modern inspect --env production
+```
+
+### Verbose content
+
+By default, the inspect command will omit the function content in the config object, you can use the `--verbose` option to output the full content of the function:
+
+```bash
+modern inspect --verbose
+```
+
+### SSR Configuration
+
+If the project has enabled SSR, an additional `webpack.config.node.js` file will be generated in the `dist/`, corresponding to the webpack configuration at SSR build time.
+
+```bash
+➜ npx modern inspect
+
+Inspect config succeed, open following files to view the content:
+
+  - Builder Config: /root/my-project/dist/builder.config.js
+  - Webpack Config (web): /root/my-project/dist/webpack.config.web.js
+  - Webpack Config (node): /root/my-project/dist/webpack.config.node.js
+```
+
+## modern lint
+
+Run ESLint to check the syntax of the code.
+
+```bash
+Usage: modern lint [options] [...files]
+
+Options:
+  --no-fix    disable auto fix source file
+  -h, --help  display help for command
+```
+
+Normally, only the part of the code modified by this commit needs to be checked by `lint-staged` during the `git commit` phase.
+
+- `--no-fix` close auto fix by lint.
+
+## modern test
+
+`modern test` command will automatically run the test cases.
+
+```bash
+Usage: modern test [options]
+
+Options:
+  -h, --help  show command help
+```
+
+:::tip
+`modern test` command need to execute the `new` command in advance to enable the `unit test/integration test`.
+:::
+
+The effect is as follows:
+
+```bash
+$ npx modern test
+ PASS  src/tests/index.test.ts
+  The add method
+    ✓ should work fine. (2ms)
+
+Test Suites: 1 passed, 1 total
+Tests:       1 passed, 1 total
+Snapshots:   0 total
+Time:        0.994 s, estimated 1 s
+```
+
+:::info
+Files match `*.test.(js|ts)` in `api/` or `src/` folders will be recognized as test cases by default.
+:::

package/en/apis/app/hooks/_category_.json

@@ -1,5 +1,5 @@
 {
   "label": "Convention",
-  "position": 1,
+  "position": 2,
   "collapsed": false
 }

package/en/apis/app/hooks/src/routes.mdx

@@ -44,9 +44,9 @@ If the directory name of the route file is named with `[]`, the generated route
 ```
 └── routes
     ├── [id]
-    │   └── page.tsx
+    │   └── page.tsx
     ├── blog
-    │   └── page.tsx
+    │   └── page.tsx
     └── page.tsx
 ```
 

package/en/components/init-app.mdx

@@ -30,11 +30,11 @@ Now, the project structure is as follows:
 ```
 .
 ├── src
-│   ├── modern-app-env.d.ts
-│   └── routes
-│       ├── index.css
-│       ├── layout.tsx
-│       └── page.tsx
+│   ├── modern-app-env.d.ts
+│   └── routes
+│       ├── index.css
+│       ├── layout.tsx
+│       └── page.tsx
 ├── modern.config.ts
 ├── package.json
 ├── pnpm-lock.yaml

package/en/configure/app/bff/prefix.mdx

@@ -7,9 +7,8 @@ sidebar_label: prefix
 - **Type:** `string`
 - **Default:** `/api`
 
-:::caution Caution
-First you need to enable the "BFF" function using [new](/apis/app/commands/new) command.
-
+:::caution
+First you need to enable the "BFF" function using [new](/apis/app/commands#modern-new) command.
 :::
 
 By default, the route access BFF prefix's directory is `/api`, with the following directory structure:

package/en/configure/app/bff/proxy.mdx

@@ -8,7 +8,7 @@ sidebar_label: proxy
 - **Default:** `{}`
 
 :::caution Caution
-First you need to enable the "BFF" function using [new](/apis/app/commands/new) command.
+First you need to enable the "BFF" function using [new](/apis/app/commands#modern-new) command.
 
 :::
 

package/en/configure/app/dev/before-start-url.mdx

@@ -0,0 +1,13 @@
+---
+sidebar_label: beforeStartUrl
+---
+
+# dev.beforeStartUrl
+
+:::tip
+This config is provided by Modern.js Builder, more detail can see [dev.beforeStartUrl](https://modernjs.dev/builder/en/api/config-dev.html#devbeforestarturl).
+:::
+
+import Main from '@modern-js/builder-doc/docs/en/config/dev/beforeStartUrl.md'
+
+<Main />

package/en/configure/app/dev/host.mdx

@@ -0,0 +1,13 @@
+---
+sidebar_label: host
+---
+
+# dev.host
+
+:::tip
+This config is provided by Modern.js Builder, more detail can see [dev.host](https://modernjs.dev/builder/en/api/config-dev.html#devhost).
+:::
+
+import Main from '@modern-js/builder-doc/docs/en/config/dev/host.md'
+
+<Main />

package/en/configure/app/output/ssg.mdx

@@ -66,7 +66,7 @@ Also using the above configuration, after executing `pnpm run build`, only the e
 ```bash
 .
 ├── src
-│   ├── entryA
+│   ├── entryA
 │   │   └── routes
 │   │       ├── layout.tsx
 │   │       ├── page.tsx
@@ -75,8 +75,8 @@ Also using the above configuration, after executing `pnpm run build`, only the e
 │   │           ├── page.tsx
 │   │           └── profile
 │   │               └── page.tsx
-│   └── entryB
-│       └── App.tsx
+│   └── entryB
+│       └── App.tsx
 ```
 
 By default, all entryA entrances are rendered at build time after setting `output.ssg` to `true`. You can configure `false` to cancel the default behavior of the specified entries. For example, to cancel the rendering of the `entryA` at build time:

package/en/configure/app/runtime/master-app.mdx

@@ -7,7 +7,7 @@ sidebar_label: masterApp
 - **Type:** `Object`
 
 :::info
-First you need to enable the "micro frontend" function using [new command](/apis/app/commands/new).
+First you need to enable the "micro frontend" function using [new command](/apis/app/commands#modern-new).
 :::
 
 ## Example

package/en/configure/app/source/entries-dir.mdx

@@ -24,7 +24,7 @@ export default defineConfig({
 └── src
     └── pages
         ├── a
-        │   └── App.jsx
+        │   └── App.jsx
         └── b
             └── App.jsx
 ```

package/en/configure/app/testing/transformer.mdx

@@ -9,7 +9,7 @@ sidebar_position: 1
 - **Default:** `babel-jest`
 
 :::caution Caution
-First you need to enable the "Unit Test" function using [new](/apis/app/commands/new) command.
+First you need to enable the "Unit Test" function using [new](/apis/app/commands#modern-new) command.
 
 :::
 

package/en/configure/app/tools/jest.mdx

@@ -9,7 +9,7 @@ sidebar_label: jest
 - **Default:** `{}`
 
 :::caution Caution
-First you need to enable the "Unit Test" function using [new](/apis/app/commands/new) command.
+First you need to enable the "Unit Test" function using [new](/apis/app/commands#modern-new) command.
 
 :::
 

package/en/guides/advanced-features/rspack-start.mdx

@@ -0,0 +1,69 @@
+---
+title: Rspack Start
+sidebar_position: 12
+---
+
+# Rspack Start
+
+[Rspack](https://www.rspack.org/) is a Rust-based web bundler developed by the ByteDance Web Infra team. The core architecture of Rspack is aligned with the implementation of webpack, and provides out-of-the-box support for commonly used build features.
+
+Rspack optimizes compilation performance by:
+
+- Highly LTO optimized Native code.
+- Take full advantage of multi-core, and the entire compilation process is fully optimized for multi-threading.
+- On-demand compilation based on request (Lazy Compilation), reducing the number of modules per compilation to improve the speed of cold start.
+
+## Initializing an rspack project
+
+The Modern.js generator provides an interactive question-and-answer interface to initialize a project. To create an rspack project, simply select the **rspack** build tool by running:
+
+```bash
+$ npx @modern-js/create myapp
+? Please select the solution you want to create: Web App Solution
+? Development Language: TS
+? Package Management Tool: pnpm
+? Build Tools: rspack
+```
+
+After the project is created, you can experience the project by running `pnpm run dev`. For more project information, please refer to [Quick Start](/guides/get-started/quick-start.html).
+
+:::tip
+When using rspack as the bundler, the following features are currently not supported:
+
+- Server-side rendering (SSR)
+- Static Site Generation (SSG)
+- Micro Frontend.
+- Storybook debugging.
+
+:::
+
+## Migrating from webpack to rspack
+
+You can enable rspack build by running `pnpm run new`:
+
+```bash
+$ pnpm run new
+? Action： Enable features
+? Enable features： Enable rspack Build
+```
+
+After executing the command, enable the rspack build in `modern.config.ts`:
+
+```ts title=modern.config.ts
+import appTools, { defineConfig } from '@modern-js/app-tools';
+
+export default defineConfig<'rspack'>({
+  runtime: {
+    router: true,
+  },
+  plugins: [
+    appTools({
+      bundler: 'experimental-rspack',
+    }),
+  ],
+});
+```
+
+:::tip
+Migrating from webpack to rspack may have some differences in build and configuration capabilities. For more details, please refer to [Configuration Differences](https://modernjs.dev/builder/en/guide/advanced/rspack-start.html#migrating-from-webpack-to-rspack)
+:::

package/en/guides/advanced-features/ssg.mdx

@@ -37,14 +37,14 @@ For example, the following is a project directory structure using conventional r
 ```bash
 .
 ├── src
-│   └── routes
-│       ├── layout.tsx
-│       ├── page.tsx
-│       └── user
-│           ├── layout.tsx
-│           ├── page.tsx
-│           └── profile
-│               └── page.tsx
+│   └── routes
+│       ├── layout.tsx
+│       ├── page.tsx
+│       └── user
+│           ├── layout.tsx
+│           ├── page.tsx
+│           └── profile
+│               └── page.tsx
 ```
 
 The above file directory will generate the following three routes:

package/en/guides/basic-features/alias.mdx

@@ -23,10 +23,10 @@ For example, import the modules from the `src/common/` directory in the `src/App
 ```bash
 .
 ├── common
-│   ├── styles
-│   │   └── base.css
-│   └── utils
-│       └── index.ts
+│   ├── styles
+│   │   └── base.css
+│   └── utils
+│       └── index.ts
 ├── App.tsx
 ```
 

package/en/guides/basic-features/data-fetch.mdx

@@ -81,9 +81,9 @@ When a routing file is passed through `[]`, it is passed as a [dynamic route](/g
 
 ```tsx
 // routes/user/[id]/page.loader.tsx
-import { LoaderArgs } from '@modern-js/runtime/router';
+import { LoaderFunctionArgs } from '@modern-js/runtime/router';
 
-export default async ({ params }: LoaderArgs) => {
+export default async ({ params }: LoaderFunctionArgs) => {
   const { id } = params;
   const res = await fetch(`https://api/user/${id}`);
   return res.json();
@@ -100,9 +100,9 @@ A common usage scenario is to obtain query parameters via `request`:
 
 ```tsx
 // routes/user/[id]/page.loader.ts
-import { LoaderArgs } from '@modern-js/runtime/router';
+import { LoaderFunctionArgs } from '@modern-js/runtime/router';
 
-export default async ({ request }: LoaderArgs) => {
+export default async ({ request }: LoaderFunctionArgs) => {
   const url = new URL(request.url);
   const userId = url.searchParams.get('id');
   return queryUser(userId);

package/en/guides/basic-features/routes.mdx

@@ -77,7 +77,7 @@ In order to facilitate the introduction of the relationship between `<Layout>` a
 .
 └── routes
     ├── blog
-    │   └── page.tsx
+    │   └── page.tsx
     ├── layout.tsx
     ├── page.tsx
     └── user
@@ -124,9 +124,9 @@ With a file directory named `[]`, the generated route will be used as a dynamic
 ```
 └── routes
     ├── [id]
-    │   └── page.tsx
+    │   └── page.tsx
     ├── blog
-    │   └── page.tsx
+    │   └── page.tsx
     └── page.tsx
 ```
 
@@ -148,7 +148,7 @@ For example, the following directory structure:
 └── routes
     ├── $.tsx
     ├── blog
-    │   └── page.tsx
+    │   └── page.tsx
     └── page.tsx
 ```
 
@@ -215,9 +215,9 @@ When the component exists in the routing directory, all routing switches under t
 .
 └── routes
     ├── blog
-    │   ├── [id]
-    │   │   └── page.tsx
-    │   └── page.tsx
+    │   ├── [id]
+    │   │   └── page.tsx
+    │   └── page.tsx
     ├── layout.tsx
     ├── loading.tsx
     └── page.tsx
@@ -225,6 +225,22 @@ When the component exists in the routing directory, all routing switches under t
 
 When a route jumps from `/` to `/blog`, if the JS Chunk of the `<Blog>` component is not loaded, the component UI exported in `loading.tsx` will be displayed first. But when jumping from `/blog` to `/blog/20220101`, it will not be displayed.
 
+### Redirect
+
+You can redirect routes by creating a [`data loader`](/guides/basic-features/data-fetch) file, Suppose you have the file `routes/user/page.tsx` and you want to redirect the route corresponding to this file, you can create the file `routes/user/page.loader.ts`:
+
+```ts title="routes/user/page.loader.ts"
+import { redirect } from "@edenx/runtime/router"
+
+export default () => {
+  const user = await getUser();
+  if(!user){
+    return redirect('/login');
+  }
+  return null;
+}
+```
+
 ### ErrorBoundary
 
 In each layer directory under `routes/`, the developer can also define a `error.tsx` file, and export a `<ErrorBoundary>` component by default.

package/en/guides/concept/builder.mdx

@@ -14,7 +14,7 @@ From the perspective of building, Modern.js is divided into three layers, from t
 
 - Upper-layer framework: Modern.js.
 - Universal build engine: Modern.js Builder.
-- Low-level bundlers: webpack and Rspack.
+- Low-level bundlers: webpack and rspack.
 
 <img src="https://lf3-static.bytednsdoc.com/obj/eden-cn/zq-uylkvT/ljhwZthlaukjlkulzlp/builder-layers-1117.png" style={{ maxWidth: '540px' }} />
 

package/en/guides/get-started/quick-start.mdx

@@ -129,9 +129,9 @@ The bundle is generated to `dist/` by default, and the directory structure is as
 .
 ├── asset-manifest.json
 ├── html
-│   └── main
+│   └── main
 ├── loader-routes
-│   └── main
+│   └── main
 ├── modern.config.json
 ├── route.json
 └── static