唯普前端工具库

安装使用

npm i chevip-fe-utils

函数调用

比如，里程格式化：

import { mileageFormat } from 'chevip-fe-utils';
...
mileageFormat('12.34'); // 输出：12.34万公里
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

接口文档

接口文档采用 https://typedoc.org/ 自动化生成文档，并通过 CI/CD 自动化部署到 GitLab Pages。

• 文档生成：npm run docs
• 文档部署：代码提交到 main 分支后，自动化部署

NPM 发布新版本

步骤1：发布前保证

运行 npm run release，保证所有测试通过并没报错。

步骤2：npm 发布

1. 修改版本号：package.json
2. 生成版本历史：git changelog
3. Npm 发布: npm publish（会先自动触发 npm run release）

步骤3：打 Tag

发布完后，需要合并代码到 master，然后通过 release 命令打个对应版本的 tag。

git release 1.x