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

package/en/docusaurus-plugin-content-docs/current/guides/advanced-features/bff/function.md

@@ -0,0 +1,218 @@
+---
+sidebar_position: 1
+title: Integration
+---
+
+Modern.js allow functions that meet certain conditions in the `api/` directory to be directly called in the React component, which is called **integration**.
+
+:::note
+The use of integration calls requires the enable BFF first.
+:::
+
+## BFF Function
+
+The functions that are allowed to be called through integration are called **BFF functions**. Here is the simplest BFF function to write, creating an `api/hello.ts` file:
+
+```ts title="api/hello.ts"
+export const get = async () => 'Hello Modern.js';
+```
+
+Then directly import the function in `src/App.tsx` and call:
+
+```tsx title=src/App.tsx
+import { useState, useEffect } from 'react';
+import { get as hello } from '@api/hello';
+
+export default () => {
+  const [text, setText] = useState('');
+
+  useEffect(() => {
+    hello().then(setText);
+  }, []);
+  return <div>{text}</div>;
+};
+```
+
+:::info
+Modern.js generator has already configured the `@api` alias in tsconfig.json, so you can import functions directly by aliases.
+:::
+
+The functions import in `src/App.tsx` will be automatically converted into interface calls, so there is no need to call the interface through fetch.
+
+Execute `pnpm run dev`, then open `http://localhost:8080/` to see that the page has displayed the content returned by the BFF function. In Network, you can see that the page sent a request to `http://localhost:8080/api/hello`.
+
+## Function Route
+
+In Modern.js, the BFF function routing system is implemented based on the file system, and it is also a conventional routing system.
+
+In **Function Writing**, All files under `api/` will map to an interface. In **Framework Writing**, All files under `api/lambda` will map to an interface
+
+:::note
+Function Writing & Framework Writing will introduce soon.
+:::
+
+All routes generated by BFF functions have a prefix, and the default value is `/api`. The prefix can be set through [bff.prefix] (/docs/configure/app/bff/prefix).
+
+Several routing conventions are described as follow.
+
+### Default Route
+
+Files named `index.[jt]s` are mapped to the previous directory.
+
+* `api/index.ts` -> `{prefix}/`
+* `api/user/index.ts` -> `{prefix}/user`
+
+### Multi-layer Route
+
+Supports parsing nested files, if you create a nested folder structure, the files will still automatically parse routes in the same way.
+
+* `api/hello.ts` -> `{prefix}/hello`
+* `api/user/list.ts` -> `{prefix}/user/list`
+
+### Dynamic Route
+
+Create folders or files named with `[xxx]` to support dynamic named routing parameters.
+
+* `api/user/[username]/info.ts` -> `{prefix}/user/:username/info`
+* `api/user/username/[action].ts` -> `{prefix}/user/username/:action`
+
+### Allow List
+
+By default, all files in the'api/'directory will be parsed as BFF function files, but the following files will not be parsed:
+
+* file name start with `_`, for example `_utils.ts`.
+* files in directory which name start with `_`, for example `_utils/index.ts`、`_utils/cp.ts`.
+* test files, for example `foo.test.ts`.
+* type files, for example `hello.d.ts`.
+* files in `node_module`.
+
+## RESTful API
+
+Modern.js BFF functions need to be defined according to the RESTful API standard, follow the HTTP Method specification, and do not allow free parameter definition.
+
+:::info
+Assuming that the function allows free definition of parameters, the resulting route must be called by the **private protocol** (the reason is that the request parameters cannot be distinguished from the request body), and cannot implement any RESTful API.
+
+If the service is only used for the application itself, there is no problem. but its **non-standard interface definition** cannot be integrated into the larger system. In the case of multiple systems working together (such as BFF low-code construction), other systems also need to follow the **private protocol**.
+:::
+
+### Function Named Export
+
+Modern.js the export name of the BFF function determines the Method of the corresponding interface of the function, such as `get`, `post` and so on.
+
+For example, following the example, a `GET` interface can be exported.
+
+```ts
+export const get = async () => {
+  return {
+    name: 'Modern.js',
+    desc: '现代 web 工程方案',
+  };
+};
+```
+
+Following the example below, a `POST` interface can be exported.
+
+```ts
+export const post = async () => {
+  return {
+    name: 'Modern.js',
+    desc: '现代 web 工程方案',
+  };
+};
+```
+
+* Modern.js supports 9 definitions for HTTP Method: `GET`、`POST`、`PUT`、`DELETE`、`CONNECT`、`TRACE`、`PATCH`、`OPTION`、`HEAD`, can be exported using these methods as functions。
+
+* The name is size insensitive，if `GET`，can write `get`、`Get`、`GEt`、`GET`，can be accurately identified. But default export as `export default xxx` will be map to `Get`。
+
+* Multiple functions of different Methods can be defined in one file, but if multiple functions of the same Method are defined, only the first will take effect.
+
+:::info
+It should be noted that the defined functions should all be asynchronous, which is related to the type when the function is called, which will be mentioned later.
+:::
+
+### Function Parameter Rule
+
+As mentioned above, in order to meet the design criteria of RESTful APIs, the BFF function in Modern.js needs to follow certain imported parameter rules.
+
+The function parameters are divided into two parts, the dynamic part in the request path and the request option `RequestOption`.
+
+#### Dynamic Path
+
+Dynamic routing will be used as imported parameters in the first part of the function, and each imported parameter corresponds to a dynamic route. For example, in the following example, uid will be passed into the function as the first two parameters:
+
+```ts title="api/[level]/[id].ts"
+export default async (level: number, id: number) => {
+  const userData = await queryUser(level, uid);
+  return userData
+}
+```
+
+Pass dynamic parameters directly when calling:
+
+```ts title="App.tsx"
+import { useState, useEffect } from 'react'
+import { get as getUser } from '@api/[level]/[id]'
+
+export default () => {
+  const [name, setName] = useState('')
+
+  useEffect(() => {
+    getUser(6, 001).then(
+      userData => setName(userData.name)
+    )
+  }, [])
+
+  return <div>{name}</div>
+}
+```
+
+#### RequestOption
+
+The parameter after Dynamic Path is the object `RequestOption` containing querystring and request body, which is used to define the types of `data` and `query`.
+
+In normal functions without dynamic routing, the incoming `data` and `query` can be obtained from the first imported parameter, for example:
+
+```ts title="api/hello.ts"
+import type { RequestOption } from '@modern-js/runtime/server'
+
+export async function post(
+  { query, data }: RequestOption<Record<string, string>, Record<string, string>>
+) {
+  // do somethings
+}
+```
+
+When a function file uses dynamic routing rules, dynamic routing before the `RequestOption` parameter.
+
+```ts title="api/[sku]/[id]/item.ts"
+export async function post(
+  sku: string,
+  id: string,
+  { data, query }: RequestOption<Record<string, string>, Record<string, string>>
+) {
+  // do somethings
+}
+```
+
+Also pass in the parameters according to the function definition:
+
+```ts title="App.tsx"
+import { post } from '@api/[sku]/[id]/item'
+
+export default () => {
+  const addSku = () => {
+    post('0001'/* sku */, '1234' /* id */, {
+      query: { /* ... */ },
+      data: { /* ... */ },
+    })
+  }
+
+  return <div onClick={addSku}>添加 SKU</div>
+}
+```
+
+As mentioned earlier, the defined functions should be asynchronous because they are automatically converted to HTTP interface calls when called by the front end.
+
+so in order to keep the type definition consistent with the actual calling, it is necessary to set the BFF function to asynchronous when defining it.

package/en/docusaurus-plugin-content-docs/current/guides/advanced-features/bff/index.md

@@ -0,0 +1,20 @@
+---
+title: BFF
+---
+
+In the development of the concept of **front back separation**, the front-end part can do more and more things, and the front-end needs some UI-oriented data interfaces, so the industry introduced the concept of BFF (Backends for Frontends).
+
+The main problems it to solve include:
+
+* Aggregation, mapping, clipping, and proxying of lower-level APIs according to their own business needs.
+* Cache data for some specific scenarios to improve performance and thus improve user experience.
+* Quickly development of new products based on existing interfaces.
+* Interface with third-party systems, such as login authentication.
+
+Modern.js officially supported the BFF and provided the **Integrated BFF** to further strengthen the BFF's capabilities, mainly including the following capabilities:
+
+* Quick development and debugging go live, running, building, and deploying BFF code in the same project.
+* Minimal pure function call, directly import BFF function on the front end, and can be automatically converted into HTTP request when called.
+* No private protocol, follow RESTful API specification, all BFF interfaces are standardized.
+* Full TypeScript support.
+* Meet user preferences and support multi-frame extension writing.

package/en/docusaurus-plugin-content-docs/current/guides/advanced-features/bff/type.md

@@ -0,0 +1,43 @@
+---
+sidebar_position: 2
+title: Writing Type
+---
+
+Runtime framework support is also an important part of **BFF**. Modern.js supports extending BFF's runtime framework through plugins, and provides a series of built-in plugins, developers can directly use the conventions and ecology of the framework.
+
+The plugin is compatible with most of the specifications of these frameworks, and each framework needs to provide two types of ways to extend the writing of BFF functions, namely **Function Writing** and **Framework Writing**.
+
+:::note
+Whether the current `api/` directory structure is written as a framework is determined by the corresponding plugin, Modern.js don't care.
+:::
+
+## Function Writing
+
+When the plugin considers that it is currently written as a function, it must support writing middleware in the `api/_ app.ts` to extend the BFF function.
+
+Modern.js collects the middleware in the `api/_app.ts` and passes it to the plugin, which injects the middleware into the runtime, for example:
+
+```ts
+import { hook } from '@modern-js/runtime/server';
+
+export default hook(({ addMiddleware }) => {
+  addMiddleware(myMiddleware);
+});
+```
+
+:::note
+The writing of middleware for different plugins is not the same, see [Runtime Framework](/docs/guides/advanced-features/bff/frameworks) for details.
+:::
+
+## Framework Writing
+
+Framework writing is a way of using frame structure to extend BFF functions. Compared with function writing, although frame writing can use more frame structure and make the entire BFF Server clearer in complex scenarios, it is also more complex and requires more attention to the content at the framework level.
+
+In the framework writing method, all BFF functions need to be written in the `api/lambda/` directory, and the hook file `_app.[tj]s` cannot be used.
+
+In most cases, the function writing method can cover the customization requirements of most BFF functions. Only when your project server level logic is more complex, the code needs to be layered, or you need to use more elements of the framework, you need to use the framework writing method.
+
+:::note
+The directory structure of different plugin frameworks is not the same, see [Runtime Frameworks](/docs/guides/advanced-features/bff/frameworks) for details.
+:::
+

package/en/docusaurus-plugin-content-docs/current/guides/advanced-features/code-split.md

@@ -0,0 +1,77 @@
+---
+title: Code Split
+sidebar_position: 6
+---
+
+Code Split is a common way to optimizing front-end resource loading. This doc will introduce three methods supported by Modern.js:
+
+:::info
+When you use Modern.js [Conventional routing](/docs/guides/basic-features/routes#conventional-routing), by default it will do code splitting based on routing components, wrapping `Suspense` components, no need to do code splitting by yourself.
+:::
+
+- `import`
+- `React.lazy`
+- `loadable`
+
+## import
+
+use dynamic `import()`，`import` The JS modules pass to this API will be packaged into a separate JS file as a new packaging entry, for example:
+
+```ts
+import("./math").then(math => {
+  console.log(math.add(16, 26));
+});
+```
+
+The JS modules corresponding to the './math' path will be packaged in a separate JS file.
+
+
+## React.lazy
+
+The officially way provides by React to split component code.
+
+:::caution
+SSR is not supported in React 17 and below, and it is recommended that SSR applications for React 17 use loadable.
+:::
+
+```ts
+import React, { Suspense } from 'react';
+
+const OtherComponent = React.lazy(() => import('./OtherComponent'));
+const AnotherComponent = React.lazy(() => import('./AnotherComponent'));
+
+function MyComponent() {
+  return (
+    <div>
+      <Suspense fallback={<div>Loading...</div>}>
+        <section>
+          <OtherComponent />
+          <AnotherComponent />
+        </section>
+      </Suspense>
+    </div>
+  );
+}
+```
+
+For detail, see [React lazy](https://reactjs.org/docs/code-splitting.html#reactlazy)。
+
+## loadable
+
+use `loadable` API，for example：
+
+```ts
+import loadable from '@modern-js/runtime/loadable'
+
+const OtherComponent = loadable(() => import('./OtherComponent'));
+
+function MyComponent() {
+  return <OtherComponent />
+}
+```
+
+For detail, see [loadable API](/docs/apis/app/runtime/utility/loadable)。
+
+:::info
+SSR is supported out of the box by `loadable`.
+:::

package/en/docusaurus-plugin-content-docs/current/guides/advanced-features/compatibility.md

@@ -0,0 +1,76 @@
+---
+title: Compatibility
+sidebar_position: 5
+---
+
+## Browserslist
+
+Modern.js supports the `browserslist` field in the `package.json` file, or a `.browserslistrc` file to specify the target browser range covered by the project.
+
+This value is used by ['@babel/preset-env'] (https://babeljs.io/docs/en/babel-preset-env) and ['autoprefixer'] (https://github.com/postcss/autoprefixer) to determine the JavaScript syntax features to be converted and the CSS browser prefix to be added.
+
+The default value in Modern.js as follow:
+
+```js
+['> 0.01%', 'not dead', 'not op_mini all']
+```
+
+You can learn how to customize the browserlist [here](https://github.com/browserslist/browserslist).
+
+See Modern.js Builder docs to learn more [Browserlist](https://modernjs.dev/builder/zh/guide/advanced/browserslist.html) info.
+
+:::note
+Modern.js also supports configuring [output.override Browserlist](/docs/configure/app/output/override-browserslist) to override the default browserlist value.
+:::
+
+
+## Polyfill
+
+### Polyfill At Compile
+
+Modern.js inject the Polyfill code via [core-js] (https://github.com/zloirock/core-js) at compile time by default.
+
+By default, the required Polyfill code will be introduced according to the settings of the Browserslist, so there is no need to worry about the Polyfill problem of the project source code and third-party dependencies, but because it contains some Polyfill code that is not used, the final bundle size may be increased.
+
+:::info
+For case where Polyfill is not required for third-party dependencies, you can set ['output.polyfill'](/docs/configure/app/output/polyfill) to `usage`, so that Babel compiles only Polyfill code based on the syntax used in the code.
+:::
+
+### Polyfill At Runtime
+
+Modern.js also provides a runtime Polyfill solution based on browser [UA](https://developer.mozilla.org/zh-CN/docs/Web/HTTP/Headers/User-Agent) information, which has the following advantages over Babel:
+
+* It will not be inserted into the code, reducing the code .
+* The same browser will share a Polyfill code. Therefore, with more and more projects, the UA-based Polyfill code will be delivered faster and faster.
+
+exec `pnpm run new` to enable this features：
+
+```bash
+? 请选择你想要的操作 启用可选功能
+? 启用可选功能 启用「基于 UA 的 Polyfill」功能
+```
+
+After executing the command, register the Polyfill plugin in `modern.config.ts`:
+
+```ts title="modern.config.ts"
+import PolyfillPlugin from '@modern-js/plugin-polyfill';
+// https://modernjs.dev/docs/apis/app/config
+export default defineConfig({
+  ...,
+  plugins: [..., PolyfillPlugin()],
+});
+```
+
+After configuring `output.polyfill` as `ua` and executing `pnpm run build & & pnpm run serve` to start the server, visiting the page can see that the HTML product contains the following script:
+
+```js
+<script src="/__polyfill__" crossorigin></script>
+```
+
+Visit the page `http://localhost:8080/__polyfill__` on Chrome 51 to see:
+
+![ua-polyfill](https://lf3-static.bytednsdoc.com/obj/eden-cn/aphqeh7uhohpquloj/modern-js/docs/ua-polyfill.png)
+
+:::caution
+This feature only works when using Modern.js built-in Web Server.
+:::

package/en/docusaurus-plugin-content-docs/current/guides/advanced-features/eslint.md

@@ -0,0 +1,145 @@
+---
+title: ESLint
+sidebar_position: 8
+---
+
+**Modern.js ESLint Rules** Is the full set of **ESLint** rules，includes `@modern-js` （Lint rules for Node.js projects）and `@modern-js-app`（Lint rules for web projects）。
+
+More ESLint usage is described below with specific questions.
+
+## Q: How To Deal With Lint
+
+### Automatic Fix
+
+Most problems will be solved by the automatic fix of ESLint rules or the code formatting of [Prettier](https://prettier.io/) (which has been integrated into ESLint), and the developer does not need to care about the details of the problem and how to solve it.
+
+:::info
+This kind of automatic fix is mainly performed when the IDE saves the file, and a few will be automatically fix on submit.
+:::
+
+### Batch Automatic Fix
+
+在少数情况下，比如旧项目迁移的时候，可以执行以下命令，批量修复和检查所有文件：
+
+```bash
+pnpm run lint:error
+```
+
+### Manual Fix
+
+对于无法自动修复的问题，可以在 IDE 里点击问题提示框里的规则链接，打开这条规则的文档，查看问题的解释和解决方案。
+
+
+### 声明例外情况
+
+目前阶段，有些规则并不能做到足够智能，多数情况下会有很大收益，在少数情况下也许不适用。但如果为了这些少数情况就把整个规则关掉或改掉，得不偿失。
+
+这种情况下可以用 [eslint-disable](https://eslint.org/docs/user-guide/configuring/rules#disabling-rules) 注释，对符合**少数情况**的代码块做标注，声明这里是一个例外，应该忽略。比如：
+
+```js
+/* eslint-disable filenames/match-exported */
+...
+/* eslint-enable filenames/match-exported */
+```
+
+:::info 注
+在 VS Code 编辑器里输入 eslint，会自动出现关于 "eslint-disable" 的提示框，选择提示选项生成对应注释对。
+:::
+
+【Modern.js ESLint 规则集】要求 [eslint-disable](https://eslint.org/docs/user-guide/configuring/rules#disabling-rules) 必须成对使用，必须明确表达要影响的范围，以及在这个范围内明确表达要禁用什么规则，目的是让**例外**有明确的、最小化的范围，避免 [eslint-disable](https://eslint.org/docs/user-guide/configuring/rules#disabling-rules) 被滥用，导致不属于例外的代码也被禁用了规则。
+
+## Q: 如何自定义 ESLint 规则
+
+### 仓库根目录下 `package.json` 里的 "eslintConfig" 字段
+
+这个地方是整个仓库的默认 ESLint 配置，是针对纯 Node.js 代码（只能在 Node.js 里运行）设计的。
+
+如果项目在某些规则上确实有特殊要求或不可避免的兼容问题（不是例外），可以在这里增加规则配置。该配置会优先于默认的【Modern.js ESLint 规则集】，比如：
+
+```json
+ "eslintConfig": {
+    "extends": [
+      "@modern-js"
+    ],
+    "rules": {
+      "filenames/match-exported": "off"
+    }
+  },
+
+```
+
+### `src/.eslintrc.js` 文件
+
+Modern.js 的应用工程、模块工程，源代码目录里都会默认有这个配置文件，是针对 Universal JS 代码设计的。
+
+:::info 注
+Universal JS 代码是既能浏览器端也能在服务器端运行的代码。
+:::
+
+如果项目在某些规则上确实有特殊要求或不可避免的兼容问题（不是例外），可以在这里增加规则配置，该配置会优先于默认的【Modern.js ESLint 规则集】，比如：
+
+```js
+// eslint-disable-next-line import/no-commonjs
+module.exports = {
+  root: true,
+  extends: ['@modern-js-app'],
+  parserOptions: {
+    tsconfigRootDir: __dirname,
+    project: ['../tsconfig.json'],
+  },
+  rules: {
+    'filenames/match-exported': 'off',
+  },
+};
+```
+
+如果有需要，还可以继续在不同的子目录里增加 `.eslintrc.js` 文件，针对这个子目录里的代码做特殊配置：
+
+```js
+module.exports = {
+  rules: {
+    'filenames/match-exported': 'off',
+  },
+};
+```
+
+:::tip 提示
+注意：没有必要使用 `extends` 字段，会自动继承父目录的配置。
+:::
+
+### package.json 里的 `eslintIgnore` 字段
+
+把包含 `.js`、`.jsx`、`.ts`、`.tsx` 文件、但不需要做代码检查和自动修复的目录，添加到 `eslintIgnore` 里，可以优化 ESLint 检查的速度，比如：
+
+```json
+ "eslintIgnore": [
+    "node_modules",
+    "dist",
+    "output"
+  ],
+```
+
+## Q: 如何升级 ESLint 插件的版本
+
+只要不是 Major 版本的变化（不符合 [Semver](https://semver.org/) 规则的 `^` 符号），就可以直接在业务项目的 `package.json` 里指定这个依赖，删除 Lock 文件（或尝试手动删除 Lock 文件中这个包名的内容），执行 `pnpm install` 重新安装依赖并且生成新的 Lock 文件。
+
+做完这些操作之后，在业务项目的 `./node_modules` 目录里，这个插件应该只存在一份，并且升级到了你指定的版本。
+
+:::tip 提示
+- Major 版本就是主版本号。更多信息，请阅读【[Semantic Versioning](https://semver.org/#summary)】。
+- 所有被 Modern.js 封装的上游项目（比如 ESLint、[ESLint 插件](https://eslint.org/docs/user-guide/configuring/plugins#plugins)、[React Router](https://reactrouter.com/) 等），也都可以这样升级。
+- Modern.js 也会在每次发版中尽量及时的升级这些上游依赖。
+- Major 版本的升级需要由 Modern.js 来发版。
+:::
+
+## Q: WebStorm 有时候会报 ESLint 错误
+
+由于 WebStorm 认为 ESLint 执行目录是根据 `.eslintrc` 文件来决定的。因此 `src/.eslintrc` 文件位置的放置会导致 `tsconfig.json` 文件指定的位置（项目根目录下）在 `src/` 目录下找不到。
+
+此时需要手动配置一下：
+
+```json
+--parser-options=project:../tsconfig.json
+```
+
+![webstorm-lint-error](https://lf3-static.bytednsdoc.com/obj/eden-cn/aphqeh7uhohpquloj/modern-js/docs/webstorm-lint-error.png)

package/en/docusaurus-plugin-content-docs/current/guides/advanced-features/index.md

@@ -0,0 +1,12 @@
+---
+type: ref
+---
+
+# Advanced Features
+
+This section covers advanced features of Modern.js.
+
+
+
+
+

package/en/docusaurus-plugin-content-docs/current/guides/advanced-features/low-level.md

@@ -0,0 +1,46 @@
+---
+title: Low-Level Tools
+sidebar_position: 11
+---
+
+## Usage
+
+Modern.js internally integrates tools such as [Babel](https://babeljs.io/), [TypeScript](https://www.typescriptlang.org/), [Webpack](https://webpack.js.org/), [PostCSS](https://postcss.org/), [Tailwind CSS] (https://tailwindcss.com/) by default.
+
+Usually, the default configuration can meet most development needs. When there are special needs, it can be achieved through the underlying configuration.
+
+Take configuring Webpack as an example, just add ['tools.webpack'] (/docs/configure/app/tools/webpack) to the modern.config.ts:
+
+```typescript title="modern.config.ts"
+export default defineConfig({
+  tools: {
+    webpack: config => {
+
+    }
+  }
+})
+```
+
+Configurations in the `tools` can be set to `Object` or `Function`.
+
+When the value is `Object`, it will be merged with the default configuration. For the specific merging strategy, refer to the configuration options document (see table below).
+
+When the value is `Function`, the first parameter is the default configuration value. You can directly modify this object without returning it, or you can return a new object or a merged object as the final result.
+
+## Low-level Configuration Details
+
+Currently provided is as follows:
+
+| Tools | Config   |
+| -------- | --------- |
+| DevServer | [tools.devServer](/docs/configure/app/tools/dev-server) |
+| Babel | [tools.babel](/docs/configure/app/tools/babel)|
+| styled-components | [tools.styledComponents](/docs/configure/app/tools/styled-components)|
+| PostCSS | [tools.postcss](/docs/configure/app/tools/postcss)|
+| Less | [tools.less](/docs/configure/app/tools/less) |
+| Sass | [tools.sass](/docs/configure/app/tools/sass) |
+| webpack | [tools.webpack](/docs/configure/app/tools/webpack)|
+| Minify CSS | [tools.minifyCss](/docs/configure/app/tools/minify-css)|
+| terser | [tools.terser](/docs/configure/app/tools/terser)|
+| Tailwind CSS | [tools.tailwind](/docs/configure/app/tools/tailwindcss) |
+| Autoprefixer | [tools.autoprefixer](/docs/configure/app/tools/autoprefixer) |