quec-utils

本项目由 quec-cli 生成， typescript 工具库类型项目模版，使用 vue3 和 typescript 开发，使用 vite 作为构建工具，并集成了 prettier、eslint、commitlint、husky 等现代前端开发工程化内容

同时集成了 vitepress 作为文档工具，使用 markdown 编写文档，支持 vue 组件的使用

基本流程

• 需求整理
• 初步设计（入参、出参、命名、分类等）
• 初步评审
• 代码实现
• 测试用例编写
• 提交 merge request
• code review，看代码是否符合规范、用例是否完善等
• 修改代码，直到通过 code review
• 合并代码
• 发布版本（生成 tag 提交后触发 gitlab ci/cd，自动进行测试和 npm 包发布）

开发指南

源码开发

工具库的开发流程，主要是在 src 目录下进行开发，开发完成后，需要编写测试用例，编写文档，最后发布版本

只需要在 src 下新增工具函数 ts 文件进行开发即可，无需在其他地方进行配置（发布时会自动更新）

测试

推荐使用 vitest 的 ui 界面进行测试用例编写，支持热更新，实时查看测试结果（控制台中也会同步显示结果）

本项目采用 vitest 对工具库推荐的 In-source testing 方式进行测试用例编写，即测试用例和源码放在同一个文件中，方便开发和维护

yarn vitest:ui

文档开发

使用 vitepress 进行文档开发，在 docs 目录下编写 markdown 文档

yarn docs:dev

构建

yarn build

发布版本

yarn release