为 sisyphe-react-scripts 创建的项目提供的工具扩展
如何本地调试
Features
- 右键选择文件夹，快速创建页面(sisyphe-page)
- 右键选择文件夹，新建动态表单配置(@sisyphe/components/es/DynamicForm)
- 右键选择文件夹，生成 services 文件
- 右键选择文件夹，快速创建小程序页面（针对 taro 项目）
- 命令输入 sisyphe-react-tools.nativeDev 开启 RN Debug
- 命令输入 启动自动更新 SwaggerDTO
- 命令输入 停止自动更新 SwaggerDTO
- 命令输入 启动 mockSwagger 服务
- 命令输入 停止 mockSwagger 服务
doc
插件配置： 根目录创建文件 .sisyphe.config.js
// .sisyphe.config.js
const path = require("path");
module.exports = function () {
return {
swagger: {
url: ["http://xxx.xx.x.xx:xxxxx"],
// url 也可以配置成对象数组，如下所示
// url: [
// {
// url: 'http://xxx.xx.x.xx:xxxxx',
// desc: 'xxxx',
// apiPrefix: '/xxx',
// },
// {
// url: 'http://xxx.xx.x.xx:xxxxx',
// desc: 'xxxx',
// apiPrefix: '/xxx',
// },
// ],
path: path.resolve(__dirname, "./src/services"),
fetchInterval: 10,
log: true,
apiPrefix: "",
// 非必填，是 swagger 查询需要的参数
search: "?a=xx",
// Bearer Token，将会放置于 header.authorization，用于通过 swagger 上可能存在的网关鉴权
token: "xxxx",
},
mock: {
url: "http://xxx.xx.x.xx:xxxxx",
// exclude: [],
// include: [],
originalUrl: "http://xxx.xx.x.xx",
},
};
};
导出的配置参数
swagger
| 参数 |
说明 |
类型 |
默认值 |
| url |
swagger 的地址，只能有域名和端口 |
string[] | SwaggerUrl[] |
- |
| path |
swaggerDTO 文件的保存路径 |
string |
- |
| fetchInterval |
自动 fetch 的间隔，单位分钟 |
number |
10 |
| log |
是否生成日志文件 |
boolean |
10 |
| apiPrefix |
api 前缀, 若 url 对应服务地址项里没有配置 apiPrefix, 则默认优先使用此全局的 apiPrefix |
string |
- |
| useNamespace |
SwaggerDTO 是否生成命名空间 |
boolean |
false |
| suffixWhenRepeat |
名称重复时添加后缀 |
boolean |
false |
| useMultipleNamespace |
SwaggerDTO 使用多个命名空间 |
false |
boolean |
| addPartial |
添加是否将请求参数添加 Partial |
false |
boolean |
| token |
Bearer Token，将会放置于 header.authorization，用于通过 swagger 上可能存在的网关鉴权 |
string |
- |
| loginEnv |
登录环境 (dev, test, preprod) |
string |
dev |
| language |
定义语言 (ts, dart) |
string |
ts |
SwaggerUrl
{
/** 文档地址 */
url: string,
/** 描述，用于在创建services文件时选择的展示 */
desc: string,
/** Api前缀，用于在创建services文件时添加接口前缀 */
apiPrefix: string
/** 在配置 useMultipleNamespace 时，用于区分不同命名空间的名称 */
name: string
/** swagger的版本，默认是v2 */
version: "v2" | "v3"
/** 非必填，是 swagger 查询需要的参数 */
search: string
}
mock
| 参数 |
说明 |
类型 |
默认值 |
| url |
swagger 的地址，只能有域名和端口 |
string |
- |
| originalUrl |
原始请求路径，当不代理 mock 时，请求的路径 |
string |
- |
| prefix |
mock 生成的接口地址的前缀（一般情况下是后端的服务名，因为从 swagger 获取的接口地址不包含服务名） |
string |
- |
| include |
需要 mock 的接口地址 |
Array<string> |
[] |
| exclude |
排除 mock 的接口地址 |
Array<string> |
[] |
| port |
mock 服务的端口 |
number |
8088 |
如何贡献
目前是基于 master 分支发版，所以 master 分支必须保持纯粹
基于 master 分支签出特性分支
功能分支应使用 feature 分组
修复分支应使用 fix 分组
git checkout -b feature/xxx // 功能分支
git checkout -b fix/xxx // 修复分支
在特性分支上提交代码后，创建 merge request 指派给对应 Maintainer ，注意应在 MR 中选择压缩提交 (Squash commits) 的选项
Maintainer 合并代码并在一定发版时期中修改版本号发版，即可上线功能
