docs: 更新包名

2025-04-06 03:59:53 +08:00 · 2021-03-05 18:58:14 +08:00 · 2021-03-05 18:58:14 +08:00 · 8fed154ae6
commit 8fed154ae6
parent 611d4cb3f0
19 changed files with 80 additions and 80 deletions
--- a/docs/zh/README.md
+++ b/docs/zh/README.md
@ -30,7 +30,7 @@ footer: MIT Licensed | Copyright © 2020-present Webank

 ```bash
 # 创建模板
-yarn create @webank/fes-app myapp
+yarn create @fesjs/fes-app myapp

 # 安装依赖
 yarn 
@ -45,7 +45,7 @@ yarn dev

 ```bash
 # 创建模板
-npx @webank/create-fes-app myapp
+npx @fesjs/create-fes-app myapp

 # 安装依赖
 npm install 
@ -61,5 +61,5 @@ npm run dev

 | Github Issue  | 微信群 | Fes.js开源运营小助手 |
 | --- | --- | --- |
-| [@webank/fes.js/issues](https://github.com/WeBankFinTech/fes.js/issues) | <img src="https://i.loli.net/2020/09/11/2XhKtPZd6NFVbDE.png" width="250" /> | <img src="https://i.loli.net/2020/09/16/sxwr62CKhmYOUyV.jpg" height="250"/> |
+| [@fesjs/fes.js/issues](https://github.com/WeBankFinTech/fes.js/issues) | <img src="https://i.loli.net/2020/09/11/2XhKtPZd6NFVbDE.png" width="250" /> | <img src="https://i.loli.net/2020/09/16/sxwr62CKhmYOUyV.jpg" height="250"/> |

--- a/docs/zh/guide/config.md
+++ b/docs/zh/guide/config.md
@ -1,6 +1,6 @@
 # 配置

-`fes` 在 `.fes.js` 文件中添加项目基础配置。一份常见的配置示例如下：
+Fes.js 约定 `.fes.js` 文件为项目基础配置文件，一份常见的配置示例如下：
 ```js
 export default {
    base: '/foo/',
--- a/docs/zh/guide/contributing.md
+++ b/docs/zh/guide/contributing.md
@ -4,23 +4,23 @@

 项目仓库借助于 [Yarn Classic 工作区](https://classic.yarnpkg.com/zh-Hans/docs/workspaces) 来实现 [Monorepo](https://en.wikipedia.org/wiki/Monorepo) ，在 `packages` 目录下存放了多个互相关联的独立 Package 。

- `@webank/create-fes-app`: 创建项目模板模块。提供`create-fes-app`命令，提供创建多种类型项目模板的能力。
+- `@fesjs/create-fes-app`: 创建项目模板模块。提供`create-fes-app`命令，提供创建多种类型项目模板的能力。
  
- `@webank/fes`: 入口模块。提供`fes`命令和 API 入口。 
+- `@fesjs/fes`: 入口模块。提供`fes`命令和 API 入口。 

- `@webank/fes-compiler`: 编译时插件管理模块。定义插件的生命周期、插件配置、插件通讯机制等。
+- `@fesjs/compiler`: 编译时插件管理模块。定义插件的生命周期、插件配置、插件通讯机制等。

- `@webank/fes-runtime`: 运行时插件模块。集成了vue-router，定义运行时插件生命周期、插件通讯机制。
+- `@fesjs/runtime`: 运行时插件模块。集成了vue-router，定义运行时插件生命周期、插件通讯机制。

- `@webank/fes-preset-build-in`: 内置插件集。包含`dev`、`build`等命令，集成webpack5+babel，提供方便编写插件的API，入口文件处理，路由处理等能力。
+- `@fesjs/preset-build-in`: 内置插件集。包含`dev`、`build`等命令，集成webpack5+babel，提供方便编写插件的API，入口文件处理，路由处理等能力。

- `@webank/fes-template`: 适用于PC类型的模板项目。
+- `@fesjs/fes-template`: 适用于PC类型的模板项目。

- `@webank/fes-template-h5`: 适用于H5类型的模板项目。
+- `@fesjs/fes-template-h5`: 适用于H5类型的模板项目。

- `@webank/fes-plugin-${name}`: 官方插件。
+- `@fesjs/plugin-${name}`: 官方插件。

- `@webank/fes`: 是 `@webank/compiler` + `@webank/fes-runtime` + `@webank/fes-preset-build-in` 的封装。用户只需要安装此依赖和额外的插件或者插件集。
+- `@fesjs/fes`: 是 `@fesjs/compiler` + `@fesjs/runtime` + `@fesjs/preset-build-in` 的封装。用户只需要安装此依赖和额外的插件或者插件集。

 ## 开发配置

--- a/docs/zh/guide/directory-structure.md
+++ b/docs/zh/guide/directory-structure.md
@ -21,10 +21,10 @@ fes-template
 ### 根目录

 #### package.json
-包含插件和插件集，以 `@webank/fes-preset-`、`@webank/fes-plugin-`、`fes-preset-` 和 `fes-plugin-` 开头的依赖会被自动注册为插件或插件集。
+包含插件和插件集，以 `@fesjs/preset-`、`@fesjs/plugin-`、`fes-preset-` 和 `fes-plugin-` 开头的依赖会被自动注册为插件或插件集。

 #### tsconfig.json
-解决 `@webank/fes` 和使用 `@` 的 API 提示
+解决 `@fesjs/fes` 和使用 `@` 的 API 提示

 #### .fes.js
 配置文件，包含 Fes.js 内置功能和插件的配置。
--- a/docs/zh/guide/getting-started.md
+++ b/docs/zh/guide/getting-started.md
@ -37,7 +37,7 @@ cd workspace

 ```bash
 # 创建模板
-yarn create @webank/fes-app myapp
+yarn create @fesjs/fes-app myapp
 ```

  </CodeGroupItem>
@ -46,7 +46,7 @@ yarn create @webank/fes-app myapp

 ```bash
 # 创建模板
-npx @webank/create-fes-app myapp
+npx @fesjs/create-fes-app myapp
 ```

  </CodeGroupItem>
@ -112,7 +112,7 @@ Starting the development server http://localhost:8080 ...
 npm run dev


-> @webank/fes-template@2.0.0-alpha.1 dev /Users/harrywan/company/git/fes.js/packages/fes-template
+> @fesjs/fes-template@2.0.0-alpha.1 dev /Users/harrywan/company/git/fes.js/packages/fes-template
 > fes dev

 Starting the development server http://localhost:8080 ...
@ -159,7 +159,7 @@ $ fes build
 # 构建
 npm run build

-> @webank/fes-template@2.0.0-alpha.1 build /Users/harrywan/company/git/fes.js/packages/fes-template
+> @fesjs/fes-template@2.0.0-alpha.1 build /Users/harrywan/company/git/fes.js/packages/fes-template
 > fes build

 ✔ Webpack
--- a/docs/zh/guide/plugin.md
+++ b/docs/zh/guide/plugin.md
@ -3,7 +3,7 @@
 ## 插件的 id 和 key
 每个插件都会对应一个 `id` 和一个 `key`，**`id` 是路径的简写，`key` 是进一步简化后用于配置的唯一值**。

-比如插件 `/node_modules/@webank/fes-plugin-foo/index.js`，通常来说，其 `id` 为 `@webank/fes-plugin-foo`，`key` 为 `foo`。
+比如插件 `/node_modules/@fesjs/plugin-foo/index.js`，通常来说，其 `id` 为 `@fesjs/plugin-foo`，`key` 为 `foo`。

 ::: tip
 id 一般用不上，对于普通开发者 key 用来配置插件，而插件开发者可以使用 key 判断是否安装某个插件。 
@ -17,11 +17,11 @@ Fes.js 会自动检测 `dependencies` 和 `devDependencies` 里的 fes 插件，
 ```json
 {
  "dependencies": {
-    "@webank/fes-plugin-request": "^2.0.0"
+    "@fesjs/plugin-request": "^2.0.0"
  }
 }
 ```
-那么 `@webank/fes-plugin-request` 会自动被注册，无需在配置里重复声明。
+那么 `@fesjs/plugin-request` 会自动被注册，无需在配置里重复声明。

 ### 配置
 在配置里可通过 `presets` 和 `plugins` 配置插件，比如：
--- a/docs/zh/guide/route.md
+++ b/docs/zh/guide/route.md
@ -229,7 +229,7 @@ const router = new VueRouter({
 页面跳转 API 由 `router` 实例提供，查看 [Vue Rouer 文档](https://next.router.vuejs.org/zh/api/#router-%E6%96%B9%E6%B3%95)了解更多。

 ```js
-import { useRouter } from '@webank/fes';
+import { useRouter } from '@fesjs/fes';

 export default {
    setup(){
--- a/docs/zh/reference/api/README.md
+++ b/docs/zh/reference/api/README.md
@ -3,9 +3,9 @@ sidebar: auto
 ---

 # API
-Fes.js 统一了API的出口，所有运行时API（包含Fes.js内置API和插件提供的API）全部通过`@webank/fes`导出。
+Fes.js 统一了API的出口，所有运行时API（包含Fes.js内置API和插件提供的API）全部通过`@fesjs/fes`导出。
 ```js
-import { someApi  } from "@webank/fes"
+import { someApi  } from "@fesjs/fes"
 ```

 ## 基础API
@ -73,7 +73,7 @@ Fes.js 路由基于 [Vue Router 4.0](https://next.router.vuejs.org/introduction.
 ### useRoute
 返回当前 `route` 实例，相当于在模板内使用 `$route`。必须在 `setup` 函数内调用。
 ```js
-import { useRoute } from "@webank/fes";
+import { useRoute } from "@fesjs/fes";
 export default {
    setup(){
        const route = useRoute()
@ -84,7 +84,7 @@ export default {
 ### useRouter
 返回 `router` 实例，相当于在模板语法中使用 `$router`。必须在 `setup` 函数内调用。
 ```js
-import { useRouter } from "@webank/fes";
+import { useRouter } from "@fesjs/fes";
 export default {
    setup(){
        const router = useRouter()
@ -95,7 +95,7 @@ export default {
 ### onBeforeRouteUpdate
 添加导航守卫，在当前路由即将更新时触发。类似于之前的`beforeRouteUpdate`，但是可用于任何组件。卸载组件时，将移除守卫。
 ```js
-import { onBeforeRouteUpdate } from "@webank/fes";
+import { onBeforeRouteUpdate } from "@fesjs/fes";
 export default {
    setup(){
        onBeforeRouteUpdate((to, from, next)=>{
@ -106,7 +106,7 @@ export default {
 ### onBeforeRouteLeave
 添加导航守卫，在当前路由即将离开时触发。类似于之前的`beforeRouteLeave`，但可用于任何组件。卸载组件时，将移除守卫。
 ```js
-import { onBeforeRouteLeave } from "@webank/fes";
+import { onBeforeRouteLeave } from "@fesjs/fes";
 export default {
    setup(){
        onBeforeRouteLeave((to, from, next)=>{
@ -146,7 +146,7 @@ export default {
 ### useLink
 返回的结果跟 RouterLink 的作用域插槽的属性一致，查看[官方API](https://next.router.vuejs.org/api/#router-link-s-v-slot)了解更多。
 ```js
-import { RouterLink, useLink } from '@webank/fes'
+import { RouterLink, useLink } from '@fesjs/fes'

 export default {
  name: 'AppLink',
--- a/docs/zh/reference/cli/README.md
+++ b/docs/zh/reference/cli/README.md
@ -22,7 +22,7 @@ Options:

 ```bash
 # 全局安装
-yarn global add @webank/create-fes-app
+yarn global add @fesjs/create-fes-app

 # 创建模板
 create-fes-app fes-app
@ -34,7 +34,7 @@ create-fes-app fes-app

 ```bash
 # 全局安装
-npm i -g @webank/create-fes-app
+npm i -g @fesjs/create-fes-app

 # 创建模板
 create-fes-app fes-app
@ -50,7 +50,7 @@ create-fes-app fes-app

 ```bash
 # 创建模板
-yarn create @webank/fes-app myapp
+yarn create @fesjs/fes-app myapp

 # 安装依赖
 yarn 
@ -65,7 +65,7 @@ yarn dev

 ```bash
 # 创建模板
-npx @webank/create-fes-app myapp
+npx @fesjs/create-fes-app myapp

 # 安装依赖
 npm install 
--- a/docs/zh/reference/config/README.md
+++ b/docs/zh/reference/config/README.md
@ -221,7 +221,7 @@ export default {
 - 默认值： `false`
 - 详情：

-    配置是否启用单数模式的目录。 比如 `src/pages` 的约定在开启后为 `src/page` 目录，@webank/fes-plugins 插件也遵照此配置的约定。
+    配置是否启用单数模式的目录。 比如 `src/pages` 的约定在开启后为 `src/page` 目录，@fesjs/fes-plugins 插件也遵照此配置的约定。

 ## targets
 - 类型： `object`
--- a/docs/zh/reference/plugin/plugins/access.md
+++ b/docs/zh/reference/plugin/plugins/access.md
@ -1,4 +1,4 @@
-# @webank/fes-plugin-access
+# @fesjs/plugin-access



@ -37,8 +37,8 @@ Fes.js 用角色定义一组资源。当访问 Fes.js 应用时，使用插件
 ```json
 {
    "dependencies": {
-        "@webank/fes": "^2.0.0",
-        "@webank/fes-plugin-access": "^2.0.0"
+        "@fesjs/fes": "^2.0.0",
+        "@fesjs/plugin-access": "^2.0.0"
    },
 }
 ```
@ -133,9 +133,9 @@ export const access = {
 ## API

 ### access
-插件 API 通过 `@webank/fes` 导出：
+插件 API 通过 `@fesjs/fes` 导出：
 ```js
-import { access } from '@webank/fes'
+import { access } from '@fesjs/fes'
 ```

 #### access.hasAccess
@ -153,7 +153,7 @@ import { access } from '@webank/fes'
 - **参数**：null
 - **返回值**：Boolean
 ```js
-import { access } from '@webank/fes';
+import { access } from '@fesjs/fes';
 console.log(access.isDataReady())
 ```

@ -167,7 +167,7 @@ console.log(access.isDataReady())
    - String，对应着 `roles` 配置对象中的 `key`。
    - Promise，Promise resolve 的结果应对应着 `roles` 配置对象中的 `key`。
 ```js
-import { access } from '@webank/fes';
+import { access } from '@fesjs/fes';
 access.setRole(['admin'])
 ```

@ -180,7 +180,7 @@ access.setRole(['admin'])
    - Array，数组项对应着 `roles` 配置对象中的 `key`。
    - Promise，Promise resolve 的结果应该是`Array<accessId>`。
 ```js
-import { access } from '@webank/fes';
+import { access } from '@fesjs/fes';
 access.setAccess(['/a', '/b', '/c'])
 ```

@ -191,7 +191,7 @@ access.setAccess(['/a', '/b', '/c'])
 - **参数**：null

 ```js
-import { access } from '@webank/fes';
+import { access } from '@fesjs/fes';
 access.getAccess();
 ```

@ -208,7 +208,7 @@ access.getAccess();
    <div v-if="accessOnepicess">accessOnepicess</div>
 </template>
 <script>
-import { useAccess } from '@webank/fes';
+import { useAccess } from '@fesjs/fes';
 export default {
    setup(){
        const accessOnepicess = useAccess('/onepiece1');
--- a/docs/zh/reference/plugin/plugins/enums.md
+++ b/docs/zh/reference/plugin/plugins/enums.md
@ -1,4 +1,4 @@
-# @webank/fes-plugin-enums
+# @fesjs/plugin-enums
 ## 介绍
 日常业务开发中，有很多场景会使用到枚举值，比如select-options、table-column。

@ -8,8 +8,8 @@
 ```json
 {
    "dependencies": {
-        "@webank/fes": "^2.0.0",
-        "@webank/fes-plugin-enums": "^2.0.0"
+        "@fesjs/fes": "^2.0.0",
+        "@fesjs/plugin-enums": "^2.0.0"
    }
 }
 ```
@ -30,7 +30,7 @@ export default {
 ### 动态配置
 在业务代码中
 ```js
-import { enums } from '@webank/fes';
+import { enums } from '@fesjs/fes';
 // 动态添加
 enums.push('status', [['0', '无效的'], ['1', '有效的']]
 enums.get('status', '1') // 有效的
@ -60,7 +60,7 @@ enums.get('status', '1') // 有效的
    </div>
 </template>
 <script>
-import { enums } from '@webank/fes';
+import { enums } from '@fesjs/fes';

 export default {
    setup() {
--- a/docs/zh/reference/plugin/plugins/icon.md
+++ b/docs/zh/reference/plugin/plugins/icon.md
@ -1,4 +1,4 @@
-# @webank/fes-plugin-icon
+# @fesjs/plugin-icon

 ## 介绍

@ -9,8 +9,8 @@
 ```json
 {
    "dependencies": {
-        "@webank/fes": "^2.0.0",
-        "@webank/fes-plugin-icon": "^2.0.0"
+        "@fesjs/fes": "^2.0.0",
+        "@fesjs/plugin-icon": "^2.0.0"
    },
 }
 ```
--- a/docs/zh/reference/plugin/plugins/jest.md
+++ b/docs/zh/reference/plugin/plugins/jest.md
@ -1,4 +1,4 @@
-# @webank/fes-plugin-jest
+# @fesjs/plugin-jest
 ## 启用方式

 ## 配置
--- a/docs/zh/reference/plugin/plugins/layout.md
+++ b/docs/zh/reference/plugin/plugins/layout.md
@ -1,4 +1,4 @@
-# @webank/fes-plugin-layout
+# @fesjs/plugin-layout

 ## 介绍
 为了进一步降低研发成本，我们尝试将布局通过 fes 插件的方式内置，只需通过简单的配置即可拥有布局，包括导航以及侧边栏。从而做到用户无需关心布局。
@ -6,8 +6,8 @@
 - 布局，提供 `side`、 `top`、`mixin` 三种布局。
 - 主题，提供 `light`、`dark` 两种主题。
 - 默认实现对路由的 404、403 处理。
- 搭配 [@webank/fes-plugin-access](./access.html) 插件使用，可以完成对路由的权限控制。
- 搭配 [@webank/fes-plugin-loacle](./locale.html) 插件使用，提供切换语言的能力。
+- 搭配 [@fesjs/plugin-access](./access.html) 插件使用，可以完成对路由的权限控制。
+- 搭配 [@fesjs/plugin-loacle](./locale.html) 插件使用，提供切换语言的能力。
 - 支持自定义头部区域。
  
 - 可配置页面是否需要 layout。
@ -27,8 +27,8 @@
 ```json
 {
    "dependencies": {
-        "@webank/fes": "^2.0.0",
-        "@webank/fes-plugin-layout": "^2.0.0"
+        "@fesjs/fes": "^2.0.0",
+        "@fesjs/plugin-layout": "^2.0.0"
    },
 }
 ```
--- a/docs/zh/reference/plugin/plugins/locale.md
+++ b/docs/zh/reference/plugin/plugins/locale.md
@ -1,4 +1,4 @@
-# @webank/fes-plugin-locale
+# @fesjs/plugin-locale

 ## 介绍
 国际化插件，基于 [Vue I18n](https://github.com/intlify/vue-i18n-next)，用于解决 i18n 问题。
@ -7,8 +7,8 @@
 ```json
 {
    "dependencies": {
-        "@webank/fes": "^2.0.0",
-        "@webank/fes-plugin-locale": "^2.0.0"
+        "@fesjs/fes": "^2.0.0",
+        "@fesjs/plugin-locale": "^2.0.0"
    },
 }
 ```
@ -125,9 +125,9 @@ const localeShared = plugin.getShared("locale");
 ## API

 ### locale
-插件 API 通过 `@webank/fes` 导出：
+插件 API 通过 `@fesjs/fes` 导出：
 ```js
-import { locale } from '@webank/fes'
+import { locale } from '@fesjs/fes'
 ```

 #### locale.messages
@ -143,7 +143,7 @@ import { locale } from '@webank/fes'
  - locale，语言的名称，应该是符合 `<lang>-<COUNTRY>` 规范的名称。
 - **返回值**：`null`
 ```js
-import { locale } from '@webank/fes';
+import { locale } from '@fesjs/fes';
 locale.setLocale({ locale: 'en-US' });
 ```

@ -156,7 +156,7 @@ locale.setLocale({ locale: 'en-US' });
  - messages, 语言信息。
 - **返回值**：`null`
 ```js
-import { locale } from '@webank/fes'
+import { locale } from '@fesjs/fes'
 locale.addLocale({ locale: 'ja-JP', messages: { test: 'テスト' } });
 ```

@ -168,7 +168,7 @@ locale.addLocale({ locale: 'ja-JP', messages: { test: 'テスト' } });
 - **参数**：null
 - **返回值**：`Array`
 ```js
-import { locale } from '@webank/fes';
+import { locale } from '@fesjs/fes';
 console.log(locale.getAllLocales());
 // ["en-US", "id-ID", "ja-JP", "pt-BR", "zh-CN", "zh-TW"]
 ```
@ -186,7 +186,7 @@ Composition API, 只能在 `setup` 函数中使用，更多细节参考 [Vue I18
 </template>

 <script>
-import { useI18n } from '@webank/fes'
+import { useI18n } from '@fesjs/fes'

 export default {
 setup() {
--- a/docs/zh/reference/plugin/plugins/model.md
+++ b/docs/zh/reference/plugin/plugins/model.md
@ -1,4 +1,4 @@
-# @webank/fes-plugin-model
+# @fesjs/plugin-model


 ## 启用方式
--- a/docs/zh/reference/plugin/plugins/request.md
+++ b/docs/zh/reference/plugin/plugins/request.md
@ -1,4 +1,4 @@
-# @webank/fes-plugin-request
+# @fesjs/plugin-request

 基于 axios 封装的 request，内置防止重复请求、请求节流、错误处理等功能。
 ## 启用方式
@ -7,8 +7,8 @@
 ```json
 {
    "dependencies": {
-        "@webank/fes": "^2.0.0",
-        "@webank/fes-plugin-request": "^2.0.0"
+        "@fesjs/fes": "^2.0.0",
+        "@fesjs/plugin-request": "^2.0.0"
    },
 }
 ```
@ -66,7 +66,7 @@ export const request = {
 ### 发起一个普通 post 请求

 ```js
-import {request} from '@webank/fes';
+import {request} from '@fesjs/fes';

 request('/api/login', {
    username: 'robby',
@ -81,7 +81,7 @@ request('/api/login', {
 ### 请求节流

 ```js
-import {request} from '@webank/fes';
+import {request} from '@fesjs/fes';

 request('/api/login', {
    username: 'robby',
@ -98,7 +98,7 @@ request('/api/login', {
 ### 请求缓存

 ```js
-import {request} from '@webank/fes';
+import {request} from '@fesjs/fes';

 request('/api/login', {
    username: 'robby',
@ -120,7 +120,7 @@ request('/api/login', {
 ### 结合 use 使用

 ```js
-import {useRequest} from '@webank/fes';
+import {useRequest} from '@fesjs/fes';


 export default {
--- a/docs/zh/reference/plugin/plugins/vuex.md
+++ b/docs/zh/reference/plugin/plugins/vuex.md
@ -1,4 +1,4 @@
-# @webank/fes-plugin-vuex
+# @fesjs/plugin-vuex
 ## 介绍
 集成vuex插件

@ -14,8 +14,8 @@ vuex的提供的api直接导入使用
 ```json
 {
    "dependencies": {
-        "@webank/fes": "^2.0.0",
-        "@webank/fes-plugin-vuex": "^2.0.0"
+        "@fesjs/fes": "^2.0.0",
+        "@fesjs/plugin-vuex": "^2.0.0"
    }
 }
 ```
@ -43,7 +43,7 @@ store.dispatch('user/login')
 使用该插件，可以利用导出的事件类型，如：
 ```js
 import { useStore } from 'vuex';
-import { MUTATION_TYPES, GETTER_TYPES, ACTION_TYPES } from '@webank/fes';
+import { MUTATION_TYPES, GETTER_TYPES, ACTION_TYPES } from '@fesjs/fes';
 const store = useStore();
 store.getters[GETTER_TYPES.user.address]
 store.commit(MUTATION_TYPES.counter.increment)