@winner-fed/create-win

> 🚀 WinJS 框架官方脚手架工具，快速创建现代化前端应用项目

📋 项目简介

@winner-fed/create-win 是 WinJS 框架的官方脚手架工具，提供了丰富的项目模板和配置选项。通过交互式命令行界面，帮助开发者快速搭建基于 WinJS 框架的各类前端应用项目，包括 H5 应用、企业级 Web 应用、混合式移动应用等。

✨ 核心特性

- 🎯 多种项目模板 - 提供 6 种预设模板，覆盖不同应用场景
- 🛠️ 交互式配置 - 基于 clack-prompts 的友好命令行交互体验
- 📦 多包管理器支持 - 支持 npm、yarn、pnpm、bun 等包管理器
- 🔧 开箱即用 - 集成完整的开发工具链和最佳实践配置
- 🌐 现代化技术栈 - 基于 Vue 3、TypeScript、现代构建工具
- 📱 移动端优化 - 内置移动端适配和调试工具
- 🎨 代码规范 - 预配置 ESLint、Prettier、StyleLint 等代码质量工具
- ⚡ 快速开发 - 支持热更新、Mock 数据、代理等开发特性

🚀 快速开始

$3

``bash


使用 npm

npm create win@latest my-project

使用 yarn

yarn create win my-project

使用 pnpm

pnpm create win my-project

使用 bun

bun create win my-project
`

$3

`bash


全局安装

npm install -g @winner-fed/create-win

创建项目

create-win my-project
`

$3

`bash


交互式创建项目

create-win

指定项目名称

create-win my-project

查看版本

create-win --version

查看帮助

create-win --help
`

📚 项目模板

$3

适用场景： 移动端 H5 应用开发

技术栈：
- Vue 3.2+ + Vue Router 4.x
- TypeScript 5.0+
- WinJS 构建工具链
- Less + PostCSS
- 移动端适配解决方案

特性：
- 📱 移动端优化（REM 适配、VConsole 调试）
- 🔧 插件化架构（请求拦截、移动端调试等）
- 📦 模块联邦支持
- 🎨 完整样式解决方案

$3

适用场景： 企业级后台管理系统

技术栈：
- Vue 2.6.10 + Vue Router 3.x
- HUI 企业级组件库
- TypeScript 5.0+
- Webpack 构建工具

特性：
- 🎯 企业级架构（主子系统开发模式）
- 🔐 完整权限管理（菜单权限、路由权限）
- 🌐 国际化支持
- 📱 响应式设计

$3

适用场景： PC 端 Web 应用

技术栈：
- Vue 3.2.x + Vue Router 4.x
- TypeScript 5.x
- Vite 构建工具
- Less 预处理器

特性：
- 🎯 PC 端优化体验
- 📦 模块联邦支持
- 🚀 Vite 快速构建
- 🔍 完善的开发调试

$3

适用场景： 混合式移动应用

技术栈：
- Vue 3.2.x + Vue Router 4.x
- TypeScript 5.x
- Vite 构建工具
- 移动端特性库

特性：
- 📱 REM 适配方案
- 🔧 VConsole 移动端调试
- 🌈 鸿蒙系统 API 支持
- ⚡ Light SDK 轻量级集成

$3

适用场景： 学习示例和快速原型

技术栈：
- Vue 3.x 基础配置
- TypeScript
- 最小化依赖

特性：
- 📚 学习友好的代码结构
- 🚀 最小化配置
- 💡 最佳实践示例

$3

适用场景： WinJS 插件开发

技术栈：
- TypeScript
- WinJS 插件 API
- 测试工具链

特性：
- 🔌 插件开发框架
- 🧪 完整测试配置
- 📖 插件文档模板

🛠️ 配置选项

创建项目时，脚手架会询问以下配置选项：

- 项目名称 - 项目目录名和包名
- 项目模板 - 选择适合的项目模板
- 包管理器 - npm、yarn、pnpm、bun
- Git 初始化 - 是否初始化 Git 仓库
- 依赖安装 - 是否自动安装依赖
- 代码规范 - 是否启用 Husky Git hooks
- 作者信息 - 项目作者和邮箱

📁 生成的项目结构

`
my-project/
├── src/ # 源代码目录
│ ├── app.js # 应用入口文件
│ ├── global.less # 全局样式
│ ├── constant.js # 常量定义
│ ├── assets/ # 静态资源
│ ├── layouts/ # 布局组件
│ ├── pages/ # 页面组件
│ └── services/ # 服务层
├── .winrc.ts # WinJS 配置文件
├── package.json # 项目依赖配置
├── tsconfig.json # TypeScript 配置
├── .eslintrc.js # ESLint 配置
├── .prettierrc.js # Prettier 配置
├── .stylelintrc.js # StyleLint 配置
├── .gitignore # Git 忽略文件
└── README.md # 项目说明文档
``

🔧 开发工具链

所有模板都内置了完整的开发工具链：

$3

- ESLint - JavaScript/TypeScript 代码检查
- Prettier - 代码格式化工具
- StyleLint - CSS/Less 样式检查
- F2ELint - 前端代码规范工具

$3

- Husky - Git hooks 管理
- lint-staged - 暂存文件检查
- commitlint - 提交信息规范检查

$3

- WinJS - 现代化开发元框架
- Webpack/Vite/Rsbuild - 多种构建工具支持
- Babel - JavaScript 编译器
- PostCSS - CSS 后处理器

📖 环境要求

- Node.js >= 16.0.0
- npm >= 8.0.0 或其他包管理器的对应版本

🤝 贡献指南

我们欢迎任何形式的贡献！请查看 贡献指南 了解详细信息。

📄 许可证

本项目基于 MIT License 开源协议。

🔗 相关链接

- WinJS 官方文档
- 问题反馈
- 更新日志

---

如果这个项目对你有帮助，请给我们一个 ⭐！