基于Vue3
,VitePress
,ElementPush
, Rollup
等主流技术开发的组件库模板
- 最新技术栈:使用 Vue3/vite2 等前端前沿技术开发
- 组件文档:使用 VitePress 内置文档
- 支持:支持 TypeScript,支持按需引入
- 模板: 内置指令一键生成开发模板
- Vite - 熟悉 vite 特性
- Vue3 - 熟悉 Vue 基础语法
- Es6+ - 熟悉 es6 基本语法
- VitePress - 熟悉 VitePress 基本使用
- element-plus - ui 基本使用
- 安装依赖
```bash
npm install
# 建议不要直接使用 cnpm 安装以来,会有各种诡异的 bug。可以通过如下操作解决 npm 下载速度慢的问题
# 如果下载依赖慢可以使用淘宝镜像源安装依赖
npm install --registry=https://registry.npm.taobao.org
- 运行内置模板调试组件
# 生成组件库代码
npm run build
# 起一个vite server
npm run dev
- 运行 VitePress 文档
npm run docs:dev
- 创建组件模板
npm run ct '组件名称'
- 打包组件库
npm run build
- 打包 VitePress 文档
npm run docs:build
-
参考 vue 规范
feature
增加新功能fixbug
修复问题/BUGstyle
不影响程序逻辑的代码修改(修改空白字符,格式缩进,补全缺失的分号等,没有改变代码逻辑)perf
优化/性能提升refactor
重构revert
撤销修改docs
文档/注释chore
依赖更新/脚手架配置修改等
-
或使用指令提交
npm run commit
- esLint - js 语法检测
- styleLint - 样式语法检测
- commitLint - git commit 提交规范检测
.
├── LICENSE
├── README.md
├── build
├── commitlint.config.js
├── docs # vitepress文档目录
├── effect # 调试模板
├── lib
├── node_modules
├── package-lock.json
├── package.json
├── packages # 公共组件目录
│ ├── components # 组件存放目录
│ ├── hooks # hooks存放目录
│ ├── theme-default # 组件样式存放目录
│ ├── utils # 公共方法存放目录
├── postcss.config.js
├── prettier.config.js
├── script
├── stylelint.config.js
├── tsconfig.json
└── typings
- button
- yamlEdit