zjh-major-cli
v1.0.0
Published
这是一个轻量级的项目脚手架,用于快速生成基于模板的项目(示例模板:Vue + Vite)。
Readme
简易脚手架 (my-cli)
这是一个轻量级的项目脚手架,用于快速生成基于模板的项目(示例模板:Vue + Vite)。
主要目标:提供可定制的模板目录,便于快速创建新项目并能在模板中直接维护示例代码。
目录(重要文件)
- 仓库根: package.json — 项目配置与依赖。
- CLI 启动脚本: bin/index.js — 脚手架入口程序。
- 脚手架实现: src/create.js — 创建项目的逻辑实现。
- Vue 模板: templates/vue — 示例模板目录(包含 Vite 配置与示例源代码)。
- 示例路由: templates/vue/src/router/index.ts — 模板中的路由示例文件。
快速开始
先决条件:已安装 node(建议 v16+)与包管理器(推荐 pnpm)。
- 安装仓库依赖(开发本脚手架时)
pnpm install- 本地运行脚手架(开发或测试)
node ./bin/index.js
# 或者传入命令参数,例如:
node ./bin/index.js create my-project- 将脚手架安装为全局命令(可选)
pnpm link --global
# 之后可通过 package.json 中的 bin 字段声明的命令直接使用- 使用 Vue 模板启动示例项目(在生成出的项目目录中)
pnpm install
pnpm dev # 启动开发服务器(Vite)
pnpm build # 构建
pnpm preview模板结构说明(templates/vue 示例)
templates/vue/package.json:模板项目的依赖与脚本(开发、构建等)。templates/vue/vite.config.ts:Vite 配置。templates/vue/src:示例源代码(包含App.vue、main.ts、样式和钩子函数等)。templates/vue/src/router/index.ts:路由配置示例(引用了views/test/seller-level.vue)。
如果要新增模板,可以在 templates/ 下创建新的子目录,并按照现有结构添加 package.json 与 src。
自定义与开发
- 修改脚手架逻辑:编辑 src/create.js。
- 修改 CLI 启动:编辑 bin/index.js。
- 添加/修改模板:编辑
templates/下对应目录。
调试建议:在本地修改脚手架后,使用 node ./bin/index.js create <tmp-dir> 在临时目录验证生成结果。
贡献
欢迎提交 issue 或 PR:
- 修复 BUG 或改进生成逻辑。
- 添加更多模板(例如 React、Express、Node CLI 等)。
许可
默认未指定,建议在仓库根添加合适的 LICENSE 文件(例如 MIT)。
如果你希望我把此 README.md 格式微调为英文版、增加 badge、或根据 package.json 自动填充 CLI 命令说明,我可以接着帮你完善并提交更改。
