create-vue_zx
create-vue_zx
个人常用的 Vue 3 + Vite 脚手架,包含 TypeScript、Pinia、Vue Router、Element Plus、Tailwind CSS 4、Axios、ESLint、Prettier 和 Vitest。
创建项目
npm create vue_zx@latest
交互式回答项目名称、项目描述、作者信息(可选)和开发端口,即可生成完整的 Vue 项目。生成后执行:
cd 你的项目名称
npm install
npm run dev
非交互创建:
npm create vue_zx@latest -- --name my-app --port 3001
cd my-app
npm install
npm run dev
npm run dev:Mock 模式,自动生成 MSW worker,提供可删除的/api/example。npm run dev:backend:代理到http://192.168.1.165,不加载 Mock。npm run build:生产构建。浏览器请求同源/api,由 Nginx 转发,不在前端配置生产后端地址。
生成内容
- 待填写的
DESIGN.md与可替换的浅色示例 token,不预设最终品牌规范。 src/styles/index.css样式入口、tokens.css示例设计变量、element-plus.css控件映射。.env公共默认值;.env.backend只覆盖测试服务器地址,本地覆盖文件被 Git 忽略。- 项目级 VS Code 配置与插件推荐、UTF-8 / LF / 两空格的 EditorConfig。
- 生成项目自己的
AGENTS.md、README、请求协议和 Toast 行为测试。 npm run check提供只读类型、lint、格式和测试检查;npm run fix自动修复 lint 与格式,再检查类型并运行测试。
默认接口前缀为 /api,业务码 200 或 1 成功并提取 data。模板不改变既有后端协议。
生成项目的 Node 基线为 24.13.0。依赖使用版本范围;通过局部 overrides 将 js-beautify 的命令行参数解析依赖 nopt 固定为 9.0.0,避免其新版间接提高 Node 最低要求。首次安装后保留生成的 package-lock.json,后续可用 npm ci。
模板在 package.json 中仅允许 MSW、vue-demi 和 esbuild 的安装脚本,普通 npm install 无需逐个审批;新增其他带安装脚本的依赖仍需自行审查。
维护脚手架
npm run build
npm run test:smoke
冒烟验证会构建并打包脚手架、在系统临时目录安装打包产物、生成项目、安装依赖,再运行只读检查和生产构建。需要网络;失败保留排查目录,成功仅清理自身创建的临时目录。
npm run test:smoke -- --keep 可保留成功生成的项目,用于浏览器验收。此命令不会发布 npm 包。
现有项目不会被自动迁移。
Related Packages
Version History
| Version | Released | License |
|---|---|---|
| 0.0.9 | MIT | |
| 0.0.8 | MIT | |
| 0.0.6 | MIT | |
| 0.0.5 | MIT | |
| 0.0.4 | MIT | |
| 0.0.3 | MIT | |
| 0.0.2 | MIT | |
| 0.0.1 | MIT |