唯普前端基础代码库

Changelog · Report Bug · Merge Request · 接口文档

仓库地址

本项目采用 “主项目” + “子项目模块” 的方式组织，主项目包含开发源码（开发用），通过公司内网 gitlab 进行管理，子仓库模块主要承载接口文档的自动化部署和 pages 展示。

• 源码仓库（内网）：http://183.6.121.117:8090/frontend/chevip-fe-utils
• 文档仓库（外网）：https://gitlab.com/chevip/chevip-fe-utils-docs
• 接口文档：https://chevip.gitlab.io/chevip-fe-utils-docs/

安装使用

1、包安装

npm i chevip-fe-utils

yarn add chevip-fe-utils

pnpm add chevip-fe-utils

2、函数调用

import { mileageFormat } from 'chevip-fe-utils';
...
// 里程格式化
const mileage = '12.34';
console.log(mileageFormat(mileage)); // 输出："12.34万公里"

console.log(mileageFormat('-1')); // 输出："仪表盘已损坏"

开发编译

依赖安装

npm i

代码格式化（已配置 VsCode 保存时自动格式化当前文件）

npm run format

语法检测

npm run lint

单元测试

npm run jest

生成接口文档

npm run docs

编译 TS 文件，生成的 JS 文件会被放到 dist 目录下

npm run build

核心操作

自动化测试（格式化代码+lint）+单元测试

npm test

构建项目（自动化测试 + 编译 TS + 生成接口文档）

npm run release

生成接口文档

npm run docs

NPM 包发布新版本

按照协定，新包发布都使用 release 分支进行！

开始请，请先把代码合并到 release 分支，并切换到 release 分支后再进行以下操作！

步骤1：发布前保证

# 保证所有测试用例都通过且无报错
npm run release

步骤2：npm publish

1. 修改版本号：package.json（版本号遵循 semver 语义化版本号 规范）
2. 生成历史记录：git changelog（如果报错说这个命令不存在，需要先安装插件 git-extras）
3. NPM 新包发布: npm publish（如果是第一次发布，可能需要先登录 npm）

步骤3：接口文档部署

注意，文档和源代码不在一个项目里，记得切换到文档子项目（docs 目录）进行操作！

由于内网 git pages 域名没配置好，接口文档只能部署到外网 gitlab。文档通过 typedoc 编译生成，已配置 CI/CD 自动化部署到 GitLab Pages，文档子仓库只需 Push 到 main 分支即可。

# 1.更新接口文档（第一步的 `npm run release` 已经包含文档生成，该步骤也可省略）
npm run docs

# 2.进入文档子项目目录
cd docs

# 3.提交文档子模块代码
git commit -m "更新文档版本：x.y.z"

# 4.代码推送（注意：这里 push 的是文档子项目，不是主项目）
git push origin main

步骤4：代码提交、打 Tag

文档子模块更新提交后，子模块的提交哈希会更新。主模块中的 Subproject commit 行表示主仓库引用了子模块的哪个具体提交，具体 diff 内容例子如下：

Subproject commit e35c7524c4c2b65a22b394356a0a6df44298388d
Subproject commit a1f647d6edc1d6eecd2e6ca818bb7b288e46d000

所以需要在这个步骤才把主项目代码提交到上去：

# 回到主模块目录
cd ../
# release 分支代码更新提交并打 Tag
git release x.y.z

最后一步：代码归档到 main 分支

一切都完成后，请别忘记把 release 分支合并到 main 分支，建议通过 MR 进行合并。