1.0.3 • Published 7 months ago
create-cll v1.0.3
create-cll-app
一个现代化的前端项目脚手架,基于 Vue 3 + Vite + TypeScript,提供多种可选功能。
环境要求
- Node.js >= 18.0.0
- npm >= 8.x
特性
- ⚡️ Vue 3 + Vite + TypeScript
- 🎨 ESLint/Prettier 代码规范(可选)
- 📦 Pinia 状态管理(可选)
- 🚦 Vue Router 路由管理(可选)
- 🔌 Axios 请求库(可选)
- 🎭 Mock 数据(可选)
- 🎯 Tailwind CSS(可选)
- 📋 Git Commit 规范(默认)
- 🔧 Husky Git Hooks(默认)
快速开始
使用以下命令创建项目:
npx create-cll-app my-app
交互式配置
运行命令后,将进入交互式配置界面,你可以选择:
- 是否使用 TypeScript
- 是否使用 ESLint
- 是否使用 Prettier(当不使用 ESLint 时可选)
- 是否使用 Pinia
- 是否使用 Vue Router
- 是否使用 Axios
- 是否使用 Mock
- 是否使用 Tailwind CSS
所有选项默认为"是",你可以通过空格键切换选择。
项目结构
my-app/
├── src/
│ ├── api/ # API 请求(如果选择 Axios)
│ ├── assets/ # 静态资源
│ ├── components/ # 组件
│ ├── mock/ # Mock 数据(如果选择)
│ ├── router/ # 路由配置(如果选择)
│ ├── store/ # Pinia 状态管理(如果选择)
│ ├── types/ # TypeScript 类型定义(如果选择)
│ ├── views/ # 页面组件(如果选择路由)
│ ├── App.vue # 根组件
│ └── main.ts # 入口文件
├── .eslintrc.js # ESLint 配置(如果选择)
├── .prettierrc.js # Prettier 配置(如果选择)
├── .gitignore # Git 忽略文件
├── commitlint.config.js # Commit 消息规范配置
├── index.html # HTML 模板
├── package.json # 项目配置
├── tailwind.config.js # Tailwind 配置(如果选择)
├── tsconfig.json # TypeScript 配置(如果选择)
└── vite.config.ts # Vite 配置
Git 提交规范
项目默认集成了 commitlint,提交信息需要符合以下格式:
<type>: <description>
# 例如
feat: 添加用户登录功能
fix: 修复首页加载慢的问题
支持的 type:
- feat: 新功能
- fix: 修复
- docs: 文档变更
- style: 代码格式
- refactor: 重构
- perf: 性能优化
- test: 增加测试
- chore: 构建过程或辅助工具的变动
- revert: 回退
- build: 打包
- ci: CI/CD 相关
开发命令
# 安装依赖
npm install
# 启动开发服务器
npm run dev
# 构建生产版本
npm run build
# ESLint 检查(如果选择)
npm run lint
# Prettier 格式化(如果选择)
npm run format