@dao-style/cli/README.md

CLI tool for DAO Style projects - providing project scaffolding, template generation and dependency management

# @dao-style/cli

DAO Style 项目的命令行工具 - 提供项目脚手架、模板生成和依赖管理功能。

## 前置要求

- Node.js >= 20.0.0
- pnpm >= 9.0.0

## 安装

```bash
npm install -g @dao-style/cli
或
pnpm add -g @dao-style/cli
```


## 使用方法

### 创建新项目

`project-name` 为项目名称，无需包含 `ui` ，`ui` 会根据项目名称自动生成。

```bash
dao create <project-name>
```

例如:

```bash
dao create my-app
```

**由于使用 auto-import 插件，该插件依赖初次运行时生成的 `auto-imports.d.ts` 与 `auto-imports.json` 文件，因此在第一次提交时需要运行 `pnpm serve` 生成文件。否则可能会导致 lint 等功能无法正常使用。**

这将创建一个新的项目，包含以下特性：
- 基于 Vue 3 + TypeScript
- 使用 Rsbuild 构建工具
- 内置单元测试配置 (Vitest)
- 开发服务器热重载

在创建项目时会包含以下功能：

1. **代码规范 (Lint)**
   - ESLint
   - Stylelint
   - Prettier
   - Husky
   - Commitizen
   - Textlint

2. **CI/CD 配置**
   - GitLab CI/CD 配置
   - 自动化发布流程
   - Nginx 配置

## 项目结构

创建的项目将包含以下基本结构：

```
my-app/
├── src/
│ ├── App.vue
│ └── main.ts
├── tests/
│ └── unit/
├── rsbuild.config.ts
├── tsconfig.json
├── package.json
└── README.md
```


## 可用的 npm 脚本

### 基础命令

```bash
开发服务器
pnpm serve
生产环境预览
pnpm serve:build
构建项目
pnpm build
运行单元测试
pnpm test:unit
```

### Lint 相关命令 

```bash
# 运行所有 lint 检查
pnpm lint
# ESLint 检查并修复
pnpm lint:fix
```