diff --git a/docs/zh/README.md b/docs/zh/README.md index 06abda8a..4ce085d6 100644 --- 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) | | | +| [@fesjs/fes.js/issues](https://github.com/WeBankFinTech/fes.js/issues) | | | diff --git a/docs/zh/guide/config.md b/docs/zh/guide/config.md index 69a031b1..206bc963 100644 --- 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/', diff --git a/docs/zh/guide/contributing.md b/docs/zh/guide/contributing.md index c4428fdc..b17a1746 100644 --- 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` 的封装。用户只需要安装此依赖和额外的插件或者插件集。 ## 开发配置 diff --git a/docs/zh/guide/directory-structure.md b/docs/zh/guide/directory-structure.md index 2623ce60..321ef685 100644 --- 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 内置功能和插件的配置。 diff --git a/docs/zh/guide/getting-started.md b/docs/zh/guide/getting-started.md index 726500c0..cfa0cdc0 100644 --- 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 ``` @@ -46,7 +46,7 @@ yarn create @webank/fes-app myapp ```bash # 创建模板 -npx @webank/create-fes-app myapp +npx @fesjs/create-fes-app myapp ``` @@ -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 diff --git a/docs/zh/guide/plugin.md b/docs/zh/guide/plugin.md index c6122041..b81a3570 100644 --- 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` 配置插件,比如: diff --git a/docs/zh/guide/route.md b/docs/zh/guide/route.md index 6cd4b49d..d684ca77 100644 --- 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(){ diff --git a/docs/zh/reference/api/README.md b/docs/zh/reference/api/README.md index c4e6000f..10c76697 100644 --- 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', diff --git a/docs/zh/reference/cli/README.md b/docs/zh/reference/cli/README.md index fc9a9d50..261a435d 100644 --- 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 diff --git a/docs/zh/reference/config/README.md b/docs/zh/reference/config/README.md index 45b53853..ecb61f97 100644 --- 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` diff --git a/docs/zh/reference/plugin/plugins/access.md b/docs/zh/reference/plugin/plugins/access.md index 58e8bed1..be8bf179 100644 --- 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`。 ```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();
accessOnepicess