前端脚手架工具 (Frontend Scaffold CLI)

🚀 一个功能丰富的前端脚手架工具，支持多种模板选择和网络检测，让您快速创建前端项目。

✨ 特性

• 🌐 网络检测: 自动检测网络连接状态，确保模板下载成功
• 📋 多模板支持: 支持 React、Vue、Next.js、Nuxt.js 等多种主流框架
• 🎯 交互式选择: 友好的命令行交互界面，轻松选择项目模板
• ⚡ 快速生成: 一键生成项目结构并自动安装依赖
• 📦 npm 发布: 支持发布到 npm，全局安装使用
• 🔧 灵活配置: 支持命令行参数和交互式两种使用方式

🛠️ 支持的模板

| 模板名称 | 描述 | 技术栈 | |---------|------|--------| | kjl-miniapp | React + Vite + TypeScript | React 18, Vite, TypeScript, ESLint, Prettier | | admin-base | Vue 3 + Vite + TypeScript | Vue 3, Vite, TypeScript, ESLint, Prettier |

📦 安装

全局安装 (推荐)

npm install -g nh-ai-cli

本地安装

npm install nh-ai-cli

🚀 使用方法

交互式模式 (推荐)

nac
# 或者
nh-ai-cli

命令行模式

nac -t react-vite -n my-project -p ./projects

参数说明

• -t, --template <template>: 指定模板名称
• -n, --name <name>: 指定项目名称
• -p, --path <path>: 指定项目路径 (默认为当前目录)

📋 使用示例

1. 交互式创建项目

$ nac

🚀 前端脚手架工具 v1.0.0
快速创建前端项目的最佳选择

✅ 网络连接正常

? 请选择项目模板: (Use arrow keys)
❯ kjl-miniapp - React + Vite + TypeScript
  admin-base - Vue 3 + Vite + TypeScript

? 请输入项目名称: my-awesome-project
? 请输入项目路径: /Users/username/projects

正在下载模板 kjl-miniapp...
✅ 模板 kjl-miniapp 下载完成
✅ 依赖安装完成

🎉 项目创建成功!
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
📁 项目信息:
   名称: my-awesome-project
   路径: /Users/username/projects/my-awesome-project
   模板: kjl-miniapp
   描述: React + Vite + TypeScript

🚀 下一步操作:
   cd my-awesome-project
   npm run dev
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
✨ 开始您的开发之旅吧!

2. 命令行模式

# 创建 React + Vite 项目
nac -t react-vite -n my-react-app

🔧 开发

本地开发

# 克隆项目
git clone https://github.com/your-username/frontend-scaffold-cli.git
cd frontend-scaffold-cli

# 安装依赖
npm install

# 运行测试
npm start

发布到 npm

# 构建项目
npm run build

# 发布到 npm
npm publish

📁 项目结构

frontend-scaffold-cli/
├── bin/
│   └── index.js          # 主入口文件
├── lib/
│   ├── network.js        # 网络检测模块
│   ├── templates.js      # 模板管理模块
│   └── generator.js      # 项目生成模块
├── package.json          # 项目配置
├── .npmignore           # npm 忽略文件
├── .gitignore           # git 忽略文件
├── LICENSE              # 许可证
└── README.md            # 说明文档

🤝 贡献

欢迎提交 Issue 和 Pull Request！

1. Fork 本仓库
2. 创建您的特性分支 (git checkout -b feature/AmazingFeature)
3. 提交您的更改 (git commit -m 'Add some AmazingFeature')
4. 推送到分支 (git push origin feature/AmazingFeature)
5. 打开一个 Pull Request

📄 许可证

本项目基于 MIT 许可证开源 - 查看 LICENSE 文件了解详情。

🙏 致谢

感谢以下开源项目的支持：

• Commander.js - 命令行界面框架
• Inquirer.js - 交互式命令行工具
• Chalk - 终端字符串样式
• Ora - 优雅的终端加载动画
• Axios - HTTP 客户端
• download-git-repo - Git 仓库下载工具

📞 联系方式

如有问题或建议，请通过以下方式联系：

• 提交 Issue
• 发送邮件至: [email protected]

⭐ 如果这个项目对您有帮助，请给它一个星标！