@wgoo/cli/README.md

Wgoo Cli 是一个 React 组件库构建工具，通过 Wgoo Cli 可以快速搭建一套功能完备的 React 组件库。

# Wgoo Cli

Wgoo Cli 是一个 React 组件库构建工具，通过 Wgoo Cli 可以快速搭建一套功能完备的 React 组件库。

### 特性

- 提供丰富的命令，涵盖从开发测试到构建发布的完整流程
- 基于约定的目录结构，自动生成优雅的文档站点和组件示例
- 内置 ESlint、Stylelint 校验规则，提交代码时自动执行校验
- 构建后的组件库默认支持按需引入、主题定制、Tree Shaking

### 快速上手

执行以下命令可以快速创建一个基于 Wgoo Cli 的项目：

### 手动安装

```shell
# 通过 npm 安装
npm i @wgoo/cli -D

# 通过 yarn 安装
yarn add @wgoo/cli --dev
```

安装完成后，请将以下配置添加到 package.json 文件中

```json
{
  "scripts": {
    "dev": "wgoo-cli dev",
    "build": "wgoo-cli build",
    "build-site": "wgoo-cli build-site"
  },
  "lint-staged": {
    "*.md": "prettier --write",
    "*.{ts,tsx,js,less,scss}": "prettier --write",
    "*.{ts,tsx,js}": "eslint --fix",
    "*.{css,less,scss}": "stylelint --fix"
  },
  "eslintConfig": {
    "root": true,
    "extends": ["@wgoo"]
  },
  "prettier": {
    "singleQuote": true
  },
  "browserslist": ["Chrome >= 51", "iOS >= 8"]
}
```

## 详细文档

- [命令](docs/commands.md)
- [配置指南](docs/config.md)
- [目录结构](docs/directory.md)
- [桌面端组件](docs/desktop.md)
- [更新日志](docs/markdown/changelog.zh-CN.md)