create-hj-project
v1.1.0
Published
A CLI scaffolding tool for creating projects from templates
Maintainers
Readme
create-hj-project
基于 npm/pnpm 的 create 协议实现的脚手架工具,通过单仓库多分支模式管理模板。
使用方式
# 使用 pnpm
pnpm create hj-project
# 使用 npm
npm create hj-project
# 使用 yarn
yarn create hj-project工作原理
- 运行交互问答,选择项目配置(框架、构建工具、语言等)
- 根据配置拼接分支名称,如
vue/vite-ts - 从模板仓库下载对应分支的模板
- 初始化 Git 仓库
配置说明
默认配置在 config.json 中:
{
"templateRepo": "github:your-org/hj-templates",
"prompts": [
{ "name": "framework", "message": "选择框架", ... },
{ "name": "buildTool", "message": "选择构建工具", ... },
{ "name": "language", "message": "选择语言", ... }
],
"branchPattern": "{{framework}}/{{buildTool}}-{{language}}"
}自定义配置
在用户目录创建 ~/.hj-project.json 可覆盖默认配置:
{
"templateRepo": "github:my-org/my-templates",
"prompts": [
{
"name": "type",
"message": "选择项目类型",
"options": [
{ "value": "web", "label": "Web 应用" },
{ "value": "lib", "label": "库" }
]
}
],
"branchPattern": "{{type}}"
}模板仓库结构
模板仓库使用单仓库多分支模式:
hj-templates/
├── vue/vite-ts # Vue + Vite + TypeScript
├── vue/vite-js # Vue + Vite + JavaScript
├── react/vite-ts # React + Vite + TypeScript
├── node/ts # Node.js + TypeScript
└── ...本地开发
# 安装依赖
pnpm install
# 运行测试
pnpm test
# 本地链接(全局)
pnpm link --global
# 测试命令
create-hj-projectLicense
MIT
