@modern-js/main-doc 0.0.0-next-20221205140617 → 0.0.0-next-20221206090411

package/.turbo/turbo-build.log

@@ -1,4 +1,4 @@
 
-> @modern-js/main-doc@2.0.0-beta.2 build /tmp/repo/modern.js/packages/toolkit/main-doc
+> @modern-js/main-doc@2.0.0-beta.2 build /github/workspace/packages/toolkit/main-doc
 > npx ts-node ./scripts/sync.ts
 

package/CHANGELOG.md

@@ -1,24 +1,24 @@
 # @modern-js/main-doc
 
-## 0.0.0-next-20221205140617
+## 0.0.0-next-20221206090411
 
 ### Patch Changes
 
-- 5927355ee: feat: develop documentation directly with main-doc
+- 5927355ee1: feat: develop documentation directly with main-doc
   feat: 直接使用 main-doc 包开发文档
-- 1ef69374b: feat: support update main-doc when package build or website build
+- 1ef69374be: feat: support update main-doc when package build or website build
   feat: 支持在包发布和官网发布时，更新 main-doc 包
-- Updated dependencies [2bc090c08]
-- Updated dependencies [f96a72521]
-- Updated dependencies [57077b2c6]
-- Updated dependencies [2ff6167be]
-- Updated dependencies [5402fdb0c]
-- Updated dependencies [10d08a480]
-- Updated dependencies [5d67c26cd]
-- Updated dependencies [af4422d67]
-- Updated dependencies [dda38c9c3]
-- Updated dependencies [812913ccd]
-- Updated dependencies [3fae2d03b]
-- Updated dependencies [df41d71ad]
-- Updated dependencies [14b712da8]
-  - @modern-js/builder-doc@0.0.0-next-20221205140617
+- Updated dependencies [2bc090c089]
+- Updated dependencies [f96a725211]
+- Updated dependencies [57077b2c64]
+- Updated dependencies [2ff6167be0]
+- Updated dependencies [5402fdb0ca]
+- Updated dependencies [10d08a480d]
+- Updated dependencies [5d67c26cdb]
+- Updated dependencies [af4422d67f]
+- Updated dependencies [dda38c9c3e]
+- Updated dependencies [812913ccdd]
+- Updated dependencies [3fae2d03b3]
+- Updated dependencies [df41d71ade]
+- Updated dependencies [14b712da84]
+  - @modern-js/builder-doc@0.0.0-next-20221206090411

package/en/docusaurus-plugin-content-docs/current/components/reduck-migration.md

@@ -0,0 +1 @@
+

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

@@ -0,0 +1,42 @@
+---
+title: tools.swc
+sidebar_label: swc
+---
+
+- Type: `Object`
+- Default: `undefined`
+
+## Introduction
+
+[SWC](https://SWC.rs/) (Speedy Web Compiler) is a transformer and minimizer for JavaScript and TypeScript based on `Rust`. SWC can provide the same abilities with Babel, and it's more than 10x faster than Babel.
+
+Modern.js Builder has a out-of-box plugin for SWC, power your Web application with Polyfill and minification, we also port some common used Babel plugins to SWC.
+
+## Install
+
+The `@modern-js/plugin-swc` plugin needs to be installed before use. After the installation, the SWC compilation and compression will be automatically enabled.
+
+```bash
+pnpm add @modern-js/plugin-swc -D
+```
+
+## Config
+
+You can set the SWC compilation behavior through the `tools.swc` config.
+
+```js title="modern.config.ts"
+import { defineConfig } from '@modern-js/app-tools';
+
+export default defineConfig({
+  tools: {
+    swc: {
+      jsMinify: {
+        compress: {},
+        mangle: true,
+      },
+    },
+  },
+});
+```
+
+For config details, please refer to [Modern.js Builder - SWC Plugin Configuration](https://modernjs.dev/builder/en/plugins/plugin-swc.html#config).

package/package.json

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

package/zh/components/reduck-migration.md

@@ -0,0 +1 @@
+

package/zh/configure/app/experiments/_category_.json

@@ -0,0 +1,4 @@
+{
+  "label": "experiments (实验性)",
+  "position": 15
+}

package/zh/configure/app/html/_category_.json

@@ -0,0 +1,4 @@
+{
+  "label": "html (模板)",
+  "position": 2
+}

package/zh/configure/app/performance/_category_.json

@@ -0,0 +1,4 @@
+{
+  "label": "performance (性能)",
+  "position": 13
+}

package/zh/configure/app/runtime/state.md

@@ -12,6 +12,19 @@ sidebar_label: state
 
 具体配置项如下：
 
+## `models`
+
+* 类型：`Array<Model>`
+* 默认值：`[]`
+
+注册提前挂载的 model 对象，这些 model 会在 Reduck store 创建完成后立即执行挂载。一般使用无需提前挂载。
+
+## `initialState`
+* 类型: `Object`
+* * 默认值：`{}`
+
+用于设置全局 store 的初始状态。一般用于 SSR 在 hydration 阶段初始化数据。
+
 ## `immer`
 
 * 类型：`boolean`

package/zh/configure/app/security/_category_.json

@@ -0,0 +1,4 @@
+{
+  "label": "security (安全)",
+  "position": 14
+}

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

@@ -0,0 +1,42 @@
+---
+title: tools.swc
+sidebar_label: swc
+---
+
+- 类型： `Object`
+- 默认值： `undefined`
+
+## 介绍
+
+[SWC](https://swc.rs/) (Speedy Web Compiler) 是基于 `Rust` 语言编写的高性能 JavaScript 和 TypeScript 转译和压缩工具。在 Polyfill 和语法降级方面可以和 Babel 提供一致的能力，并且比 Babel 性能高出 10 倍不止。
+
+Modern.js 提供了开箱即用的 SWC 插件，可以为你的 Web 应用提供语法降级、Polyfill 以及压缩，并且移植了一些额外常见的 Babel 插件。
+
+## 安装
+
+使用前需要安装 `@modern-js/plugin-swc` 插件，安装完成后，会自动启用 SWC 编译和压缩能力。
+
+```bash
+pnpm add @modern-js/plugin-swc -D
+```
+
+## 配置项
+
+你可以通过 `tools.swc` 配置项来设置 SWC 编译行为。
+
+```js title="modern.config.ts"
+import { defineConfig } from '@modern-js/app-tools';
+
+export default defineConfig({
+  tools: {
+    swc: {
+      jsMinify: {
+        compress: {},
+        mangle: true,
+      },
+    },
+  },
+});
+```
+
+完整配置项请参考 [Modern.js Builder - SWC 插件配置](https://modernjs.dev/builder/zh/plugins/plugin-swc.html#%E9%85%8D%E7%BD%AE)。

package/zh/guides/advanced-features/ssr.md

@@ -189,20 +189,18 @@ import { PreRender } from '@modern-js/runtime/ssr';
 
 ### 环境变量区分
 
-在组件中可以直接使用 EdenX 内置的环境变量 `EDENX_TARGET` 进行判断，方便在构建时删除无用代码：
+在组件中可以直接使用 Modern.js 内置的环境变量 `MODERN_TARGET` 进行判断，方便在构建时删除无用代码：
 
 ```ts
 export default () => {
-  if (process.env.EDENX_TARGET === 'node') {
-    console.log('server render')
+  if (process.env.MODERN_TARGET === 'node') {
+    console.log('server render');
   } else {
-    console.log('client render')
+    console.log('client render');
   }
 }
 ```
 
-在 SSR 中直接调用 RPC 接口时，该环境变量会非常有用，因为 RPC 调用时往往会执行到浏览器中无法运行的代码。
-
 :::note
 更多内容可以查看[环境变量](/docs/guides/basic-features/env-vars)。
 :::
@@ -240,11 +238,11 @@ export default () => {
 
 ### 独立文件
 
-上述两种方式，都会为开发者带来一些心智负担。Modern.js 正在基于[嵌套路由](/docs/guides/basic-features/routes)开发设计更简单的方案来分离 CSR 和 SSR 的代码。。
+上述两种方式，都会为开发者带来一些心智负担。Modern.js 正在基于[嵌套路由](/docs/guides/basic-features/routes)开发设计[更简单的方案](/docs/guides/basic-features/data-fetch)来分离 CSR 和 SSR 的代码。
 
 ## 接口请求
 
-在 SSR 中发起接口请求时，开发者有时自己封装了同构的请求工具。部分接口需要传递用户 Cookie，开发者可以通过 [`useRuntimeContext`](/docs/apis/app/runtime/core/use-runtime-context) API 获取到请求头来实现。
+在 SSR 中发起接口请求时，开发者有时自己封装了同构的请求工具。部分接口需要传递用户 Cookie，开发者可以通过 [`useRuntimeContext`](/docs/guides/basic-features/data-fetch#route-loader) API 获取到请求头来实现。
 
 需要注意的是，此时获取到的是 HTML 请求的请求头，不一定适用于接口请求，因此**千万不能**透传所有请求头。并且，一些后端接口，或是通用网关，会根据请求头中的信息做校验，全量透传容易出现各种难以排查的问题，推荐**按需透传**。
 

package/zh/guides/basic-features/env-vars.md

@@ -23,6 +23,40 @@ Modern.js 提供了对环境变量的支持，包含内置的环境变量和自
 MODERN_ENV 的优先级高于 NODE_ENV。
 :::
 
+### MODERN_TARGET
+
+使用 `@modern-js/runtime` 时会自动注入，用于区分 SSR 与 CSR 环境。开发者可以自行在代码中判断，构建时会默认移除 dead code。
+
+```ts title="App.tsx"
+function App() {
+  if (process.env.MODERN_TARGET === 'browser') {
+    console.log(window.innerHeight);
+  };
+};
+```
+
+开发环境打包后，可以看到 SSR 产物和 CSR 产物如下：
+
+```js title="dist/bundles/main.js"
+function App() {
+  if (false) {}
+}
+```
+
+```js title="dist/static/main.js"
+function App() {
+  if (true) {
+    console.log(window.innerHeight);
+  }
+}
+```
+
+:::note
+在生产环境，会将 dead code 移除，例如上述 `if` 语句。
+:::
+
+这种方式可以针对不同客户端提供不同的产物，保证代码体积最小化。也能方便处理不同环境下，代码中的一些副作用，
+
 ## 自定义环境变量
 
 环境变量支持通过 `shell` 和 `.env` 文件两种方式指定。

package/zh/guides/topic-detail/model/quick-start.md

@@ -3,6 +3,10 @@ sidebar_position: 1
 title: 快速上手
 ---
 
+import ReduckMigration from '@site-docs/components/reduck-migration.md'
+
+<ReduckMigration />
+
 [Reduck](https://github.com/modern-js-dev/reduck) 是 Modern.js 团队开发的遵循 MVC 模式的状态管理库，底层状态存储基于 [Redux](https://redux.js.org/) 实现，同时提供更高层级的抽象，并完全兼容 Redux 生态。
 
 Reduck 的目标是以 MVC 模式组织 React 应用开发结构，将业务逻辑维护在 Model 层，业务逻辑与 UI 解耦，让开发业务逻辑更集中、更简单，同时通过更高层级的抽象，减少重复工作（样板代码）。