前端 UI 库

vue3 UI 组件库~

npm发布

在outputFile 发布和修改版本号

使用

推荐使用 yarn 安装而不是 npm 来安装。

# 安装 yarn 
npm install -g yarn
# OR 下载安装
https://classic.yarnpkg.com/zh-Hans/

# 安装 
npm run install

# 启动示例项目
npm run serve

# 启动文档项目
npm run docs:dev

# 使用构建，打包会生成 lib 文件，将生成的 js 文件直接用 script 引入即可
npm run rollup

# 使用构建打包子模块，用于按需引入
npm run rollup:sub

# 使用构建打包主题
npm run rollup:theme

# 使用构建打包全部 输出目录为outputFile 可以发布测试包自行测试
npm run build

## 提交规范

> 示例代码

```bash
git commit -m "feat: 添加 git hooks 检测"

# OR

git commit -m "refactor(axios): 重构 axios 配置"

按照一定的规范写 commit messages，可以在git push 代码之前（工具/脚本自动)检测 commit messages。规范提交信息。

commit message 包含三个部分，header, body和footer，其中header必须有，body和footer可以按情况省略。

示例 type 字段 => 具体可以查看目录 scripts/verifyCommit.js 的正则部分

feat：新功能（feature）
fix：修补bug
docs：文档（documentation）
style： 格式（不影响代码运行的变动）
refactor：重构（即不是新增功能，也不是修改bug的代码变动）
test：增加测试
chore：构建过程或辅助工具的变动

如果你遇到提交问题无法解决，可以使用 -n OR --no-verify 跳过检测（严重不推荐）

git commit -n -m "跳过 git hooks 检测" 

目录结构

# docs            # 项目文档，组件维护说明文档。
packages        # 组件存放目录
 |--...         # 其他通用组件
 |--shared      # 共享文件
 |--theme-chalk # 样式文件
 |--index.ts    # 导出文件 - 后期组件拆分独立仓库时可以删除
src             # 前端开发阶段目录，用于编写组件例子
lib             # 编译输出目录
lib-sub         # 编译输出模块打包目录