rattail/README.zh-CN.md

A Vite+ oriented, AI Agent friendly front-end toolchain

<div align="center">
  <a href="https://rattail.varletjs.org/zh">
    <img src="https://rattail.varletjs.org/logo.svg" width="150">
  </a>
  <h1>Rattail</h1>
  <p>面向 Vite+、AI Agent 友好的前端工具链</p>
  <p>
    <a href="https://rattail.varletjs.org/zh">文档</a> |
    <a href="https://github.com/varletjs/rattail/blob/main/README.md">ENGLISH README</a>
  </p>
  <p>
    <img src="https://img.shields.io/npm/v/rattail?style=flat-square" alt="version">
    <img src="https://img.shields.io/github/stars/varletjs/rattail" alt="stars">
    <img src="https://img.shields.io/npm/l/rattail.svg" alt="license">
    <img src="https://img.shields.io/codecov/c/github/varletjs/rattail" alt="coverage">
  </p>
</div>

---

### 特性

- ⚙️ &nbsp; 面向 [Vite+](https://viteplus.dev) 的开箱即用配置预设，覆盖代码检查、格式化、暂存区检查和 Git Hooks 等。
- 🔧 &nbsp; CLI 工具链，支持发布、日志、Git Hooks、Commit Lint、API 生成。
- 🧰 &nbsp; 140+ 工具函数，覆盖通用、字符串、数字、数组、对象、数学等场景。
- 🚀 &nbsp; 基于 axios 的渐进式请求工具，支持 Vue 组合式 API。
- 📏 &nbsp; 链式校验规则工厂，适配任意 UI 框架。
- 🏷️ &nbsp; 类型安全的枚举工具。
- 🤖 &nbsp; 提供 [Agent Skills](https://github.com/varletjs/rattail/tree/main/skills)，帮助 AI 编程助手理解和使用 Rattail。
- 🌲 &nbsp; 可 Tree-shake，轻量，TypeScript 完整类型支持。
- 💪 &nbsp; 90%+ 单元测试覆盖率。
- 📄 &nbsp; MIT 开源协议。

### 安装

```shell
# npm
npm i rattail -S
# yarn
yarn add rattail
# pnpm
pnpm add rattail
```

### 官方文档

- [文档首页](https://rattail.varletjs.org/zh)
- [快速开始](https://rattail.varletjs.org/zh/getting-started)
- [为什么选择 Rattail](https://rattail.varletjs.org/zh/why-rattail)
- [Vite+ 预设 / CLI 快速开始](https://rattail.varletjs.org/zh/cli/getting-started)
- [Axle 快速开始](https://rattail.varletjs.org/zh/axle/getting-started)
- [Ruler Factory](https://rattail.varletjs.org/zh/ruler/ruler-factory)