@bleedingdev/modern-js-main-doc 3.2.0-ultramodern.73 → 3.2.0-ultramodern.76

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 (53) hide show
  1. package/docs/en/apis/app/commands.mdx +32 -32
  2. package/docs/en/community/blog/2022-0708-updates.md +1 -1
  3. package/docs/en/community/blog/2022-0910-updates.md +2 -2
  4. package/docs/en/community/blog/v2-release-note.mdx +5 -5
  5. package/docs/en/community/blog/v3-release-note.mdx +1 -1
  6. package/docs/en/community/releases.mdx +2 -2
  7. package/docs/en/components/build-output.mdx +1 -1
  8. package/docs/en/components/debug-app.mdx +1 -1
  9. package/docs/en/components/deploy-command.mdx +3 -3
  10. package/docs/en/components/init-app.mdx +12 -29
  11. package/docs/en/components/init-rspack-app.mdx +1 -1
  12. package/docs/en/components/serve-command.mdx +3 -3
  13. package/docs/en/configure/app/bff/runtime-framework.mdx +1 -1
  14. package/docs/en/configure/app/usage.mdx +6 -6
  15. package/docs/en/guides/basic-features/debug/using-storybook.mdx +1 -1
  16. package/docs/en/guides/basic-features/deploy.mdx +14 -14
  17. package/docs/en/guides/basic-features/env-vars.mdx +2 -2
  18. package/docs/en/guides/basic-features/routes/config-routes.mdx +2 -2
  19. package/docs/en/guides/concept/server.mdx +2 -2
  20. package/docs/en/guides/get-started/quick-start.mdx +2 -2
  21. package/docs/en/guides/get-started/tech-stack.mdx +4 -4
  22. package/docs/en/guides/topic-detail/module-federation/application.mdx +1 -1
  23. package/docs/en/guides/topic-detail/module-federation/deploy.mdx +2 -2
  24. package/docs/en/guides/topic-detail/module-federation/usage.mdx +5 -5
  25. package/docs/en/guides/troubleshooting/builder.mdx +1 -1
  26. package/docs/en/guides/upgrade/other.mdx +7 -7
  27. package/docs/zh/apis/app/commands.mdx +32 -32
  28. package/docs/zh/community/blog/2022-0708-updates.md +1 -1
  29. package/docs/zh/community/blog/2022-0910-updates.md +2 -2
  30. package/docs/zh/community/blog/v2-release-note.mdx +5 -5
  31. package/docs/zh/community/blog/v3-release-note.mdx +1 -1
  32. package/docs/zh/community/releases.mdx +2 -2
  33. package/docs/zh/components/build-output.mdx +1 -1
  34. package/docs/zh/components/debug-app.mdx +1 -1
  35. package/docs/zh/components/deploy-command.mdx +3 -3
  36. package/docs/zh/components/init-app.mdx +12 -29
  37. package/docs/zh/components/init-rspack-app.mdx +1 -1
  38. package/docs/zh/components/serve-command.mdx +3 -3
  39. package/docs/zh/configure/app/bff/runtime-framework.mdx +1 -1
  40. package/docs/zh/configure/app/usage.mdx +5 -5
  41. package/docs/zh/guides/basic-features/debug/using-storybook.mdx +1 -1
  42. package/docs/zh/guides/basic-features/deploy.mdx +13 -13
  43. package/docs/zh/guides/basic-features/env-vars.mdx +2 -2
  44. package/docs/zh/guides/basic-features/routes/config-routes.mdx +2 -2
  45. package/docs/zh/guides/concept/server.mdx +2 -2
  46. package/docs/zh/guides/get-started/quick-start.mdx +2 -2
  47. package/docs/zh/guides/get-started/tech-stack.mdx +4 -4
  48. package/docs/zh/guides/topic-detail/module-federation/application.mdx +1 -1
  49. package/docs/zh/guides/topic-detail/module-federation/deploy.mdx +2 -2
  50. package/docs/zh/guides/topic-detail/module-federation/usage.mdx +5 -5
  51. package/docs/zh/guides/troubleshooting/builder.mdx +1 -1
  52. package/docs/zh/guides/upgrade/other.md +7 -8
  53. package/package.json +2 -2
@@ -4,16 +4,16 @@ sidebar_position: 1
4
4
 
5
5
  # Commands
6
6
 
7
- Modern.js has some built-in commands that can help you quickly start a development server, build production environment code, and more.
7
+ UltraModern.js has some built-in commands that can help you quickly start a development server, build production environment code, and more.
8
8
 
9
- Through this chapter, you can learn about the built-in commands of Modern.js and how to use them.
9
+ Through this chapter, you can learn about the built-in commands of UltraModern.js and how to use them.
10
10
 
11
- ## modern dev
11
+ ## ultramodern dev
12
12
 
13
- The `modern dev` command is used to start a local development server and compile the source code in the development environment.
13
+ The `ultramodern dev` command is used to start a local development server and compile the source code in the development environment.
14
14
 
15
15
  ```bash
16
- Usage: modern dev [options]
16
+ Usage: ultramodern dev [options]
17
17
 
18
18
  Options:
19
19
  -e --entry <entry> compiler by entry
@@ -23,10 +23,10 @@ Options:
23
23
  --api-only only start API service
24
24
  ```
25
25
 
26
- After running `modern dev`, Modern.js will watch source file changes and apply hot module replacement.
26
+ After running `ultramodern dev`, UltraModern.js will watch source file changes and apply hot module replacement.
27
27
 
28
28
  ```bash
29
- $ modern dev
29
+ $ ultramodern dev
30
30
 
31
31
  info Starting dev server...
32
32
 
@@ -38,10 +38,10 @@ info Starting dev server...
38
38
 
39
39
  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.
40
40
 
41
- For example, execute `modern dev --entry`, the entry selector will be displayed in the command line interface:
41
+ For example, execute `ultramodern dev --entry`, the entry selector will be displayed in the command line interface:
42
42
 
43
43
  ```text
44
- $ modern dev --entry
44
+ $ ultramodern dev --entry
45
45
 
46
46
  ? Please select the entry that needs to be built
47
47
  ❯ ◯ foo
@@ -57,22 +57,22 @@ You can also specify the page name through parameters after `--entry`, and the n
57
57
 
58
58
  ```bash
59
59
  # Compile foo page
60
- modern dev --entry foo
60
+ ultramodern dev --entry foo
61
61
 
62
62
  # Compile foo and bar pages
63
- modern dev --entry foo,bar
63
+ ultramodern dev --entry foo,bar
64
64
  ```
65
65
 
66
- ## modern start
66
+ ## ultramodern start
67
67
 
68
- `modern start` is an alias of `modern dev` command, the usage of the two are exactly the same.
68
+ `ultramodern start` is an alias of `ultramodern dev` command, the usage of the two are exactly the same.
69
69
 
70
- ## modern build
70
+ ## ultramodern build
71
71
 
72
- The `modern build` command will build production-ready artifacts in the `dist/` directory by default. You can specify the output directory by modifying the configuration [`output.distPath`](/configure/app/output/dist-path).
72
+ The `ultramodern build` command will build production-ready artifacts in the `dist/` directory by default. You can specify the output directory by modifying the configuration [`output.distPath`](/configure/app/output/dist-path).
73
73
 
74
74
  ```bash
75
- Usage: modern build [options]
75
+ Usage: ultramodern build [options]
76
76
 
77
77
  Options:
78
78
  -c --config <config> specify the configuration file, which can be a relative or absolute path
@@ -80,14 +80,14 @@ Options:
80
80
  -w --watch turn on watch mode, watch for changes and rebuild
81
81
  ```
82
82
 
83
- ## modern new
83
+ ## ultramodern new
84
84
 
85
- The `modern new` command is used to enable features in an existing project.
85
+ The `ultramodern new` command is used to enable features in an existing project.
86
86
 
87
87
  For example, add application entry, enable some optional features such as BFF, micro frontend, etc.
88
88
 
89
89
  ```bash
90
- Usage: modern new [options]
90
+ Usage: ultramodern new [options]
91
91
 
92
92
  Options:
93
93
  --config-file <configFile> specify the configuration file, which can be a relative or absolute path
@@ -104,7 +104,7 @@ Options:
104
104
  In the project, execute the `new` command to add entries as follows:
105
105
 
106
106
  ```text
107
- $ npx modern new
107
+ $ npx ultramodern new
108
108
  ? Please select the operation you want: Create Element
109
109
  ? Please select the type of element to create: New "entry"
110
110
  ? Please fill in the entry name: entry
@@ -115,7 +115,7 @@ $ npx modern new
115
115
  In the project, execute the `new` command to enable features as follows:
116
116
 
117
117
  ```text
118
- $ npx modern new
118
+ $ npx ultramodern new
119
119
  ? Please select the operation you want: Enable Features
120
120
  ? Please select the feature name: (Use arrow keys)
121
121
  ❯ Enable BFF
@@ -133,12 +133,12 @@ import ServeCommand from '@site-docs-en/components/serve-command';
133
133
 
134
134
  <ServeCommand />
135
135
 
136
- ## modern upgrade
136
+ ## ultramodern upgrade
137
137
 
138
- Execute the command `npx modern upgrade` in the project, by default, dependencies in the `package.json` are updated to the latest version.
138
+ Execute the command `npx ultramodern upgrade` in the project, by default, dependencies in the `package.json` are updated to the latest version.
139
139
 
140
140
  ```bash
141
- Usage: modern upgrade [options]
141
+ Usage: ultramodern upgrade [options]
142
142
 
143
143
  Options:
144
144
  --config <config> specify the configuration file, which can be a relative or absolute path
@@ -148,12 +148,12 @@ Options:
148
148
  -h, --help show command help
149
149
  ```
150
150
 
151
- ## modern inspect
151
+ ## ultramodern inspect
152
152
 
153
- The `modern inspect` command is used to view the Modern.js config, [Rsbuild config](https://v2.rsbuild.rs/config/index) and Rspack config of the project.
153
+ The `ultramodern inspect` command is used to view the UltraModern.js config, [Rsbuild config](https://v2.rsbuild.rs/config/index) and Rspack config of the project.
154
154
 
155
155
  ```bash
156
- Usage: modern inspect [options]
156
+ Usage: ultramodern inspect [options]
157
157
 
158
158
  Options:
159
159
  --env <env> view the configuration in the target environment (default: "development")
@@ -163,14 +163,14 @@ Options:
163
163
  -h, --help show command help
164
164
  ```
165
165
 
166
- 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:
166
+ After executing the command `npx ultramodern inspect` in the project root directory, the following files will be generated in the `dist` directory of the project:
167
167
 
168
168
  - `modern.js.config.mjs`:The Modern.js configuration currently used.
169
169
  - `rsbuild.config.mjs`: The Rsbuild config to use at build time.
170
170
  - `rspack.config.web.mjs`: The Rspack config used by to use at build time.
171
171
 
172
172
  ```bash
173
- ➜ npx modern inspect
173
+ ➜ npx ultramodern inspect
174
174
 
175
175
  Inspect config succeed, open following files to view the content:
176
176
 
@@ -184,7 +184,7 @@ Inspect config succeed, open following files to view the content:
184
184
  By default, the inspect command will output the development configs, you can use the `--env production` option to output the production configs:
185
185
 
186
186
  ```bash
187
- modern inspect --env production
187
+ ultramodern inspect --env production
188
188
  ```
189
189
 
190
190
  ### Verbose content
@@ -192,7 +192,7 @@ modern inspect --env production
192
192
  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:
193
193
 
194
194
  ```bash
195
- modern inspect --verbose
195
+ ultramodern inspect --verbose
196
196
  ```
197
197
 
198
198
  ### SSR Configuration
@@ -200,7 +200,7 @@ modern inspect --verbose
200
200
  If the project has enabled SSR, an additional `rspack.config.node.mjs` file will be generated in the `dist/`, corresponding to the Rspack configuration at SSR build time.
201
201
 
202
202
  ```bash
203
- ➜ npx modern inspect
203
+ ➜ npx ultramodern inspect
204
204
 
205
205
  Inspect config succeed, open following files to view the content:
206
206
 
@@ -17,7 +17,7 @@ Modern.js 7 ~ 8 月的最新版本为 v1.17.0,本双月的主要更新有:
17
17
 
18
18
  Modern.js 框架和相关插件完成对 React 18 的适配。现在,只需要将项目中的 `react`、`react-dom` 两个包的版本,升级到最新的 React 18 大版本,就可以使用 React 18 的新功能。
19
19
 
20
- 注意,使用 `@modern-js/create` 命令默认创建的项目,安装的依赖 `react`、`react-dom` 的版本仍然为 17,如果希望使用 React 18,请手动升级这两个包的版本。
20
+ 注意,使用 `@bleedingdev/modern-js-create` 命令默认创建的项目,安装的依赖 `react`、`react-dom` 的版本仍然为 17,如果希望使用 React 18,请手动升级这两个包的版本。
21
21
 
22
22
  另外,SSR 流式渲染功能,目前尚在开发中,暂不支持。
23
23
 
@@ -15,7 +15,7 @@ Modern.js 9 ~ 10 月的最新版本为 v1.21.0,本双月的主要更新有:
15
15
 
16
16
  Modern.js 框架完成了对 pnpm v7 的变更适配。
17
17
 
18
- 使用 `npx @modern-js/create@modern-1` 创建项目时会根据用户当前环境的 pnpm 版本进行安装依赖操作,并且在初始化项目中会在 `.npmrc` 中添加
18
+ 使用 `pnpm dlx @bleedingdev/modern-js-create` 创建项目时会根据用户当前环境的 pnpm 版本进行安装依赖操作,并且在初始化项目中会在 `.npmrc` 中添加
19
19
  `strict-peer-dependencies=false` 配置,避免安装时由于 `peerDependencies` 缺失导致安装依赖失败问题。
20
20
  同时适配 `release`、`deploy` 命令对 pnpm v7 的支持。
21
21
 
@@ -67,7 +67,7 @@ pnpm run command --options
67
67
 
68
68
  - husky 升级至 v8
69
69
 
70
- 使用 `npx @modern-js/create@modern-1` 创建项目时,husky 会默认安装 v8 版本,并移除 `package.json` 中 husky 的配置,使用 `.husky` 文件夹的形式管理 husky 配置。
70
+ 使用 `pnpm dlx @bleedingdev/modern-js-create` 创建项目时,husky 会默认安装 v8 版本,并移除 `package.json` 中 husky 的配置,使用 `.husky` 文件夹的形式管理 husky 配置。
71
71
 
72
72
  在初次安装依赖时需要执行 `npx husky install` 进行 husky 初始化,默认项目会在 prepare 命令中完成,如果 husky 配置未生效,可通过手动执行完成 husky 配置。
73
73
 
@@ -86,20 +86,20 @@ title: Modern.js v2 发布
86
86
 
87
87
  大家对 Modern.js 框架的第一印象可能是「一个大而全的框架」,但事实上,为了避免变得臃肿,**Modern.js 采取了渐进式设计**,将所有功能建立在灵活的插件系统之上,因此具备按需启用和可插拔的能力。
88
88
 
89
- Modern.js 期望能支持不同规模的项目研发,考虑到中大型项目和小型项目对功能的诉求存在差异,**Modern.js 的大多数功能都是按需启用的**。在创建项目时,Modern.js 默认只安装核心模块,使 npm 依赖保持轻量;当需要用到额外功能时,你可以通过 modern new 命令一键开启,并自动安装相关依赖。
89
+ Modern.js 期望能支持不同规模的项目研发,考虑到中大型项目和小型项目对功能的诉求存在差异,**Modern.js 的大多数功能都是按需启用的**。在创建项目时,Modern.js 默认只安装核心模块,使 npm 依赖保持轻量;当需要用到额外功能时,你可以通过 ultramodern new 命令一键开启,并自动安装相关依赖。
90
90
 
91
- ![modern new 命令](https://lf3-static.bytednsdoc.com/obj/eden-cn/zq-uylkvT/ljhwZthlaukjlkulzlp/v2-release/modern-new-code.png)
91
+ ![ultramodern new 命令](https://lf3-static.bytednsdoc.com/obj/eden-cn/zq-uylkvT/ljhwZthlaukjlkulzlp/v2-release/modern-new-code.png)
92
92
 
93
- <div style={{ textAlign: 'center', fontStyle: 'italic' }}>modern new 命令</div>
93
+ <div style={{ textAlign: 'center', fontStyle: 'italic' }}>ultramodern new 命令</div>
94
94
 
95
95
  比如:
96
96
 
97
97
  - 对于基础的开发场景,项目中只需安装 Modern.js 的 CLI 工具 `@modern-js/app-tools`,即具备了开发调试、生产构建的能力。
98
- - 当你需要在应用中增加一些 BFF 接口时,可以执行 modern new 命令来启用 BFF 功能。启用后,Modern.js 会自动安装所需的 BFF 插件,以及某个 Node.js 框架对应的插件(如 Koa / Express):
98
+ - 当你需要在应用中增加一些 BFF 接口时,可以执行 ultramodern new 命令来启用 BFF 功能。启用后,Modern.js 会自动安装所需的 BFF 插件,以及某个 Node.js 框架对应的插件(如 Koa / Express):
99
99
 
100
100
  ![](https://lf3-static.bytednsdoc.com/obj/eden-cn/zq-uylkvT/ljhwZthlaukjlkulzlp/v2-release/bff-plugins.png)
101
101
 
102
- 目前,你可以通过 `modern new` 命令来按需开启以下功能,未来我们也会将更多功能加入到 `new` 命令中,使其能够被便捷地集成。
102
+ 目前,你可以通过 `ultramodern new` 命令来按需开启以下功能,未来我们也会将更多功能加入到 `new` 命令中,使其能够被便捷地集成。
103
103
 
104
104
  ![](https://lf3-static.bytednsdoc.com/obj/eden-cn/zq-uylkvT/ljhwZthlaukjlkulzlp/v2-release/modern-new.png)
105
105
 
@@ -339,7 +339,7 @@ For more on config-based routing, see the docs: [Config-Based Routing](/guides/b
339
339
 
340
340
  #### Route Debugging
341
341
 
342
- Run the `npx modern routes` command to generate a complete route structure analysis report in the `dist/routes-inspect.json` file.
342
+ Run the `npx ultramodern routes` command to generate a complete route structure analysis report in the `dist/routes-inspect.json` file.
343
343
 
344
344
  The report displays each route's path, component file, data loader, error boundary, loading component, and other details, helping developers quickly understand the project's route configuration and troubleshoot routing issues. The structured JSON format is also easy for AI agents to understand and analyze, improving the efficiency of AI-assisted development.
345
345
 
@@ -24,8 +24,8 @@ Modern.js follows the [Semantic Versioning](https://semver.org) specification.
24
24
 
25
25
  ## Version Upgrade
26
26
 
27
- When you need to upgrade the Modern.js version in your project, you can use the `modern upgrade` command, refer to [Upgrade](/guides/get-started/upgrade).
27
+ When you need to upgrade the Modern.js version in your project, you can use the `ultramodern upgrade` command, refer to [Upgrade](/guides/get-started/upgrade).
28
28
 
29
29
  ```bash
30
- npx modern upgrade
30
+ npx ultramodern upgrade
31
31
  ```
@@ -3,7 +3,7 @@ To build the production artifacts of the project, run `pnpm run build` in the pr
3
3
  ```bash
4
4
  $ pnpm run build
5
5
 
6
- > modern build
6
+ > ultramodern build
7
7
 
8
8
  Modern.js Framework
9
9
 
@@ -2,7 +2,7 @@ Run `pnpm run dev` in the project to start the project:
2
2
 
3
3
  ```bash
4
4
  $ pnpm run dev
5
- > modern dev
5
+ > ultramodern dev
6
6
 
7
7
  Modern.js Framework
8
8
 
@@ -1,9 +1,9 @@
1
- ## modern deploy
1
+ ## ultramodern deploy
2
2
 
3
- The `modern deploy` command is used to generate artifacts required for the deployment platform.
3
+ The `ultramodern deploy` command is used to generate artifacts required for the deployment platform.
4
4
 
5
5
  ```bash
6
- Usage: modern deploy [options]
6
+ Usage: ultramodern deploy [options]
7
7
 
8
8
  Options:
9
9
  -c --config <config> Specify configuration file path, either relative or absolute
@@ -1,64 +1,48 @@
1
- Modern.js provides the `@modern-js/create` tool to create projects. It does not require global installation and can be run on-demand using `npx`.
1
+ UltraModern.js provides the BleedingDev create package to create projects. It does not require global installation and can be run on-demand using `pnpm dlx`.
2
2
 
3
3
  You can create a project in an existing empty directory:
4
4
 
5
5
  ```bash
6
6
  mkdir myapp && cd myapp
7
- npx @modern-js/create@latest
7
+ pnpm dlx @bleedingdev/modern-js-create
8
8
  ```
9
9
 
10
10
  You can also create a project directly in a new directory:
11
11
 
12
12
  ```bash
13
- npx @modern-js/create@latest myapp
13
+ pnpm dlx @bleedingdev/modern-js-create myapp
14
14
  ```
15
15
 
16
- To initialize a TanStack Router template:
16
+ TanStack Router is scaffolded by default. To force React Router compatibility:
17
17
 
18
18
  ```bash
19
- npx @modern-js/create@latest myapp --router tanstack
19
+ pnpm dlx @bleedingdev/modern-js-create myapp --router react-router
20
20
  ```
21
21
 
22
22
  Tailwind CSS v4 is scaffolded by default. To opt out:
23
23
 
24
24
  ```bash
25
- npx @modern-js/create@latest myapp --no-tailwind
26
- ```
27
-
28
- To initialize TanStack Router with the default Tailwind CSS v4 scaffold:
29
-
30
- ```bash
31
- npx @modern-js/create@latest myapp --router tanstack
32
- ```
33
-
34
- To initialize BFF scaffold with the current default runtime:
35
-
36
- ```bash
37
- npx @modern-js/create@latest myapp --bff
25
+ pnpm dlx @bleedingdev/modern-js-create myapp --no-tailwind
38
26
  ```
39
27
 
40
- To initialize BFF scaffold with Effect HttpApi runtime:
41
-
42
- ```bash
43
- npx @modern-js/create@latest myapp --bff-runtime effect
44
- ```
28
+ Effect HttpApi BFF is scaffolded by default.
45
29
 
46
30
  To initialize BFF scaffold with Hono runtime:
47
31
 
48
32
  ```bash
49
- npx @modern-js/create@latest myapp --bff-runtime hono
33
+ pnpm dlx @bleedingdev/modern-js-create myapp --bff-runtime hono
50
34
  ```
51
35
 
52
36
  To initialize with workspace protocol dependencies (for local monorepo testing of unreleased Modern.js packages):
53
37
 
54
38
  ```bash
55
- npx @modern-js/create@latest myapp --router tanstack --bff-runtime effect --workspace
39
+ pnpm dlx @bleedingdev/modern-js-create myapp --workspace
56
40
  ```
57
41
 
58
- `@modern-js/create` will directly create the application without providing an interactive Q & A interface:
42
+ The BleedingDev create package will directly create the application without providing an interactive Q & A interface:
59
43
 
60
44
  ```bash
61
- 🚀 Welcome to Modern.js
45
+ 🚀 Welcome to UltraModern.js
62
46
 
63
47
  📦 Creating project "myapp"...
64
48
 
@@ -103,11 +87,10 @@ Now, the project structure is as follows:
103
87
 
104
88
  Tailwind CSS v4 is generated by default; pass `--no-tailwind` to omit `postcss.config.mjs`, `tailwind.config.ts`, and the Tailwind import.
105
89
 
106
- When `--bff` or `--bff-runtime effect` is enabled, `modern.config.ts` enables `@modern-js/plugin-bff`, generates `api/effect/index.ts` + `shared/effect/api.ts`, and sets `bff.runtimeFramework` to `effect`.
90
+ By default, `modern.config.ts` enables `@modern-js/plugin-bff`, generates `api/effect/index.ts` + `shared/effect/api.ts`, and sets `bff.runtimeFramework` to `effect`.
107
91
  When `--bff-runtime hono` is enabled, `modern.config.ts` enables `@modern-js/plugin-bff`, generates `api/lambda/hello.ts`, and sets `bff.runtimeFramework` to `hono`.
108
92
  When `--workspace` is enabled, `@modern-js/*` dependencies use `workspace:*` versions for local monorepo linkage.
109
93
 
110
- If you want the public UltraModern.js path, use the BleedingDev create package.
111
94
  It creates a simple production-ready UltraModern app by default and installs
112
95
  the published BleedingDev package aliases:
113
96
 
@@ -1,5 +1,5 @@
1
1
  ```bash
2
- $ npx @modern-js/create@latest myapp
2
+ $ pnpm dlx @bleedingdev/modern-js-create myapp
3
3
  ? Please select the programming language: TS
4
4
  ? Please select the package manager: pnpm
5
5
  ```
@@ -1,9 +1,9 @@
1
- ## modern serve
1
+ ## ultramodern serve
2
2
 
3
- The `modern serve` command is used to start a Modern.js project in the production environment. It can also be used to preview the artifacts built for the production environment locally. Please note that you need to execute the [`build`](/apis/app/commands#modern-build) command beforehand to generate the corresponding artifacts.
3
+ The `ultramodern serve` command is used to start an UltraModern.js project in the production environment. It can also be used to preview the artifacts built for the production environment locally. Please note that you need to execute the [`build`](/apis/app/commands#ultramodern-build) command beforehand to generate the corresponding artifacts.
4
4
 
5
5
  ```bash
6
- Usage: modern serve [options]
6
+ Usage: ultramodern serve [options]
7
7
 
8
8
  Options:
9
9
  -c --config <config> specify the configuration file, which can be a relative or absolute path
@@ -25,4 +25,4 @@ export default defineConfig({
25
25
  - Set to `'hono'` to run BFF only from file-convention handlers under `api/lambda/**`.
26
26
 
27
27
  There is no implicit fallback between runtimes. Choose one runtime mode per app.
28
- If you want the public UltraModern preset that prefers the Effect lane, configure it explicitly in your app or scaffold with the create template's Effect path.
28
+ Generated UltraModern apps use the Effect lane by default; set `runtimeFramework: 'hono'` only for the compatibility runtime.
@@ -86,8 +86,8 @@ export default defineConfig(({ env, command }) => ({
86
86
  This function accepts the following parameters:
87
87
 
88
88
  - `env`: Corresponds to the value of `process.env.NODE_ENV`.
89
- - When running `modern dev`, the value of `env` is `development`.
90
- - When running `modern build` or `modern serve`, the value of `env` is `production`.
89
+ - When running `ultramodern dev`, the value of `env` is `development`.
90
+ - When running `ultramodern build` or `ultramodern serve`, the value of `env` is `production`.
91
91
  - `command`: Corresponds to the current command being run, such as `dev`, `build`, or `serve`.
92
92
 
93
93
  #### Exporting Asynchronous Functions
@@ -117,8 +117,8 @@ For example, if you need to use the `modern.prod.config.js` file when executing
117
117
  ```json title="package.json"
118
118
  {
119
119
  "scripts": {
120
- "dev": "modern dev",
121
- "build": "modern build --config modern.prod.config.js"
120
+ "dev": "ultramodern dev",
121
+ "build": "ultramodern build --config modern.prod.config.js"
122
122
  }
123
123
  }
124
124
  ```
@@ -126,7 +126,7 @@ For example, if you need to use the `modern.prod.config.js` file when executing
126
126
  You can also abbreviate the `--config` option as `-c`:
127
127
 
128
128
  ```bash
129
- $ modern build -c modern.prod.config.js
129
+ $ ultramodern build -c modern.prod.config.js
130
130
  ```
131
131
 
132
132
  ### Configuring in package.json (Not Recommended)
@@ -187,7 +187,7 @@ The configuration in the `modern.config.local.ts` file will be deeply merged wit
187
187
 
188
188
  When using `modern.config.local.ts`, please note the following:
189
189
 
190
- - The `modern.config.local.ts` file will only be loaded when executing the `modern dev` commands and will not be loaded during `modern build`.
190
+ - The `modern.config.local.ts` file will only be loaded when executing the `ultramodern dev` commands and will not be loaded during `ultramodern build`.
191
191
  - The priority of the `modern.config.local.ts` file is higher than both `modern.config.ts` and the `modernConfig` field in `package.json`.
192
192
  - Since `modern.config.local.ts` is only used for local debugging, it is not recommended to commit it to the code repository. Ensure that the project's `.gitignore` file includes `modern.config.local.ts` and similar files.
193
193
 
@@ -55,7 +55,7 @@ Add the following scripts to `package.json` to start the BFF server and Storyboo
55
55
  ```json
56
56
  {
57
57
  "scripts": {
58
- "dev:api": "modern dev --api-only",
58
+ "dev:api": "ultramodern dev --api-only",
59
59
  "storybook": "BFF_PROXY=1 storybook dev -p 6006 --no-open",
60
60
  }
61
61
  }
@@ -15,12 +15,12 @@ Currently, Modern.js only supports running in a Node.js environment. Support for
15
15
 
16
16
  ## Build Deployment Products
17
17
 
18
- Running the `modern deploy` command will automatically produce deployment products. This process includes optimizing Bundler build products and their dependencies, detecting the current deployment platform, and automatically generating deployment products that can run on that platform.
18
+ Running the `ultramodern deploy` command will automatically produce deployment products. This process includes optimizing Bundler build products and their dependencies, detecting the current deployment platform, and automatically generating deployment products that can run on that platform.
19
19
 
20
- If you want to generate and test the output locally for a specific deployment platform, you can specify the platform by setting the environment variable: `modern deploy`:
20
+ If you want to generate and test the output locally for a specific deployment platform, you can specify the platform by setting the environment variable: `ultramodern deploy`:
21
21
 
22
22
  ```bash
23
- MODERNJS_DEPLOY=netlify npx modern deploy
23
+ MODERNJS_DEPLOY=netlify npx ultramodern deploy
24
24
  ```
25
25
 
26
26
  :::info
@@ -36,10 +36,10 @@ By default, Modern.js outputs builds that can be run in a Node.js environment wh
36
36
  Use the following command to build the project:
37
37
 
38
38
  ```bash
39
- npx modern deploy
39
+ npx ultramodern deploy
40
40
  ```
41
41
 
42
- When running the `modern deploy` command, Modern.js will generate runnable products and output the following content in terminal:
42
+ When running the `ultramodern deploy` command, UltraModern.js will generate runnable products and output the following content in terminal:
43
43
 
44
44
  ```bash
45
45
  Static directory: `.output/static`
@@ -67,7 +67,7 @@ Assume that the name in the `package.json` of the current project is `app`. Taki
67
67
  {
68
68
  "scripts": {
69
69
  "build:packages": "pnpm --filter 'app^...' run build",
70
- "deploy": "pnpm run build:packages && modern deploy"
70
+ "deploy": "pnpm run build:packages && ultramodern deploy"
71
71
  }
72
72
  }
73
73
  ```
@@ -78,7 +78,7 @@ If you use Rush as your Monorepo management tool, you can add the following comm
78
78
  {
79
79
  "scripts": {
80
80
  "build:packages": "rush rebuild --to-except app",
81
- "deploy": "rushx build:packages && modern deploy"
81
+ "deploy": "rushx build:packages && ultramodern deploy"
82
82
  }
83
83
  }
84
84
  ```
@@ -108,7 +108,7 @@ Add the following content to `netlify.toml`:
108
108
  ```toml
109
109
  [build]
110
110
  publish = "dist"
111
- command = "modern deploy"
111
+ command = "ultramodern deploy"
112
112
  ```
113
113
 
114
114
  :::info
@@ -125,7 +125,7 @@ Full-stack projects refer to projects that use Custom Web Server, SSR or BFF. Th
125
125
  ```toml title="netlify.toml"
126
126
  [build]
127
127
  publish = "dist"
128
- command = "modern deploy"
128
+ command = "ultramodern deploy"
129
129
 
130
130
  [functions]
131
131
  directory = ".netlify/functions"
@@ -173,7 +173,7 @@ Add the following script in `packages/app/package.json`, before executing the de
173
173
  {
174
174
  "scripts": {
175
175
  "build:packages": "pnpm --filter 'app^...' run build",
176
- "deploy": "pnpm run build:packages && modern deploy"
176
+ "deploy": "pnpm run build:packages && ultramodern deploy"
177
177
  }
178
178
  }
179
179
  ```
@@ -213,7 +213,7 @@ Add the following content to `vercel.json`:
213
213
 
214
214
  ```json title="vercel.json"
215
215
  {
216
- "buildCommand": "modern deploy",
216
+ "buildCommand": "ultramodern deploy",
217
217
  "outputDirectory": ".vercel/output"
218
218
  }
219
219
  ```
@@ -281,7 +281,7 @@ Add the following script to `packages/app/package.json` to run `build` command o
281
281
  {
282
282
  "scripts": {
283
283
  "build:packages": "pnpm --filter 'app^...' run build",
284
- "deploy": "pnpm run build:packages && modern deploy"
284
+ "deploy": "pnpm run build:packages && ultramodern deploy"
285
285
  }
286
286
  }
287
287
  ```
@@ -326,7 +326,7 @@ For branch deployment, follow these steps:
326
326
  ```
327
327
  "scripts": {
328
328
  //...
329
- "deploy:gh-pages": "MODERNJS_DEPLOY=ghPages modern deploy && gh-pages -d .output"
329
+ "deploy:gh-pages": "MODERNJS_DEPLOY=ghPages ultramodern deploy && gh-pages -d .output"
330
330
  }
331
331
  ```
332
332
 
@@ -334,7 +334,7 @@ For branch deployment, follow these steps:
334
334
 
335
335
  :::info
336
336
 
337
- 1. Running `MODERNJS_DEPLOY=ghPages modern deploy` will build the production output for GitHub in the .output directory.
337
+ 1. Running `MODERNJS_DEPLOY=ghPages ultramodern deploy` will build the production output for GitHub in the .output directory.
338
338
  2. You can refer to the [project](https://github.com/web-infra-dev/modern-js-examples/tree/main/examples/modern-js-deploy-csr)
339
339
  :::
340
340
 
@@ -16,8 +16,8 @@ The current path prefix of the asset, which is a read-only environment variable.
16
16
 
17
17
  The current execution environment and is a **read-only** environment variable whose have different values under different execution commands:
18
18
 
19
- - `production`: Default value when running `modern build` or `modern serve`.
20
- - `development`: Default value when running `modern dev`, also the default value in other cases.
19
+ - `production`: Default value when running `ultramodern build` or `ultramodern serve`.
20
+ - `development`: Default value when running `ultramodern dev`, also the default value in other cases.
21
21
 
22
22
  ### MODERN_ENV
23
23
 
@@ -271,7 +271,7 @@ Config routes can be used together with convention routes. You can merge routes
271
271
 
272
272
  :::info
273
273
 
274
- Current route structure can be viewed through the [`modern routes`](#debugging-routes) command
274
+ Current route structure can be viewed through the [`ultramodern routes`](#debugging-routes) command
275
275
 
276
276
  :::
277
277
 
@@ -319,7 +319,7 @@ Since the final structure after route merging may not be intuitive, Modern.js pr
319
319
 
320
320
  ```bash
321
321
  # Generate route structure analysis report
322
- npx modern routes
322
+ npx ultramodern routes
323
323
  ```
324
324
 
325
325
  This command will generate the final route structure in the `dist/routes-inspect.json` file, helping you understand the complete route information after merging.
@@ -26,10 +26,10 @@ Static asset files can be directly hosted by Modern.js' server, but it is highly
26
26
 
27
27
  Modern.js supports running built artifacts in any Node.js environment. Typically, the CI environment has already installed all application dependencies.
28
28
 
29
- You can run the [`modern build`](/apis/app/commands#modern-build) command to build the application and the [`modern serve`](/apis/app/commands#modern-serve) command to run the Web server, starting the Modern.js application.
29
+ You can run the [`ultramodern build`](/apis/app/commands#ultramodern-build) command to build the application and the [`ultramodern serve`](/apis/app/commands#ultramodern-serve) command to run the Web server, starting the UltraModern.js application.
30
30
 
31
31
  ## Running in Production Environments
32
32
 
33
33
  When deploying to production, the artifact size should be as small as possible. The aforementioned method for running in CI environments keeps all artifacts from the original project. Therefore, it is not recommended to run the application using the above commands in a production environment.
34
34
 
35
- Modern.js offers a standalone deployment solution. When running the [`modern deploy`](/apis/app/commands#modern-deploy) command, the artifacts will include an entry file for running the Web server.
35
+ UltraModern.js offers a standalone deployment solution. When running the [`ultramodern deploy`](/apis/app/commands#ultramodern-deploy) command, the artifacts will include an entry file for running the Web server.
@@ -27,7 +27,7 @@ import DebugApp from '@site-docs-en/components/debug-app';
27
27
 
28
28
  ## Configuration
29
29
 
30
- In a Modern.js project created using `@modern-js/create`, a `modern.config.ts` file is generated by default.
30
+ In an UltraModern.js project created using `@bleedingdev/modern-js-create`, a `modern.config.ts` file is generated by default.
31
31
 
32
32
  You can modify the configuration through this file to override the default behavior of Modern.js. For example, to enable SSR, add the following configuration:
33
33
 
@@ -48,7 +48,7 @@ After running `pnpm run dev` again, you can find that the project has completed
48
48
 
49
49
  In a newly created project, the `@modern-js/app-tools` npm package is installed by default. It is the core package of the Modern.js framework and provides the following capabilities:
50
50
 
51
- - It offers commonly used CLI commands such as `modern dev`, `modern build`, and more.
51
+ - It offers commonly used CLI commands such as `ultramodern dev`, `ultramodern build`, and more.
52
52
  - It integrates Rsbuild, providing build capabilities.
53
53
  - It integrates Modern.js Server, providing capabilities for development and production servers.
54
54