Woof 🐕

⚡ 极速 Go 语言 Linter & Formatter —— 比传统工具快 10-100 倍

Woof 是用 Rust 编写的极速 Go 代码质量工具，将 Python 生态中 Ruff 的体验带到 Go 世界。从零开始设计，追求极致性能。

🚀 极致性能

速度对比

测试环境：12核 CPU，SSD 硬盘

为什么这么快？

🦀 Rust 原生性能
   ├─ 零成本抽象
   ├─ 无 GC 停顿
   └─ 极致内存控制

⚡ 智能缓存架构
   ├─ Parser 池化（复用率 99%）
   ├─ AST LRU 缓存（1000 slots）
   └─ 热运行 2ms 响应

🔄 并行处理
   ├─ 数据级并行（Rayon）
   ├─ 12核 3.55x 加速
   └─ 256核层级调度支持

💾 内存优化
   ├─ Arena 分配器
   ├─ 零拷贝 I/O（mmap）
   └─ 峰值内存降低 60%

📊 性能详情

冷启动 vs 热运行

并行扩展性

CPU 核心 │ 耗时    │ 加速比 │ 效率
─────────┼─────────┼────────┼────────
   1     │ 6,211ms │ 1.00x  │ 100%
   2     │ 3,488ms │ 1.78x  │  89%  
   4     │ 2,573ms │ 2.41x  │  60%
   8     │ 2,130ms │ 2.91x  │  36%
  12     │ 1,749ms │ 3.55x  │  30%

测试项目：500 文件，~50,000 行 Go 代码

内存效率

✨ 功能特性

📦 安装

从 crates.io

cargo install woofmt

从源码

git clone https://github.com/GWinfinity/woof.git
cd woof
cargo install --path . --release

预编译二进制

# Linux x86_64
curl -L https://github.com/GWinfinity/woof/releases/latest/download/woof-linux-amd64 -o woof
chmod +x woof
sudo mv woof /usr/local/bin/

🚀 快速开始

# 检查当前目录
woof check .

# 检查并自动修复
woof check . --fix

# 格式化代码
woof format .

# 检查格式化（CI 模式）
woof format . --check

# 查看所有规则
woof rules

# 使用指定线程数
woof check . --threads 8

# JSON 输出
woof check . --format json

# 初始化配置
woof init

🎯 Lint 规则体系

规则前缀

示例规则

// SA1019: 使用了已弃用的函数
ioutil.ReadFile("file.txt")  // 应使用 os.ReadFile

// SA5000: 向 nil map 赋值
var m map[string]int
m["key"] = 1  // panic!

// SA2000: 错误的 WaitGroup 使用
go func() {
    wg.Add(1)  // 应在 goroutine 外调用
    defer wg.Done()
}()

// GEN002: 类型参数遮蔽内置类型
func process[int any](x int) {}  // int 遮蔽了内置类型

⚙️ 配置示例

创建 woof.toml：

[global]
target_go_version = "1.21"
respect_gitignore = true
exclude = ["vendor/", "*.gen.go", "*_test.go"]

[linter]
select = ["E", "F", "SA", "C"]
ignore = ["E101", "SA5008"]

[linter.rules.line-too-long]
enabled = true
severity = "error"
options = { max_length = 120 }

[formatter]
use_tabs = true
tab_width = 4
line_length = 120
simplify = true

[memory]
parser_pool_size = 8
ast_cache_size = 1000
batch_size = 100

Go 版本控制

通过 target_go_version 控制升级规则的启用：

示例：为 Go 1.25 项目启用所有升级建议

[global]
target_go_version = "1.25"

🏗️ 架构亮点

┌─────────────────────────────────────────────────────────────┐
│                    Woof 高性能架构                           │
├─────────────────────────────────────────────────────────────┤
│                                                              │
│  ┌─────────────┐    ┌─────────────┐    ┌─────────────┐     │
│  │ Parser Pool │    │  AST Cache  │    │ Arena Alloc │     │
│  │  (8 items)  │    │ (LRU: 1000) │    │ (per thread)│     │
│  └──────┬──────┘    └──────┬──────┘    └──────┬──────┘     │
│         │                  │                  │             │
│         ▼                  ▼                  ▼             │
│  ┌─────────────────────────────────────────────────────┐   │
│  │         Parallel Linting (Rayon)                    │   │
│  │  ┌─────┐ ┌─────┐ ┌─────┐        ┌─────┐            │   │
│  │  │Worker│ │Worker│ │Worker│  ...  │Worker│            │   │
│  │  │  1   │ │  2   │ │  3   │       │  N   │            │   │
│  │  └──┬──┘ └──┬──┘ └──┬──┘        └──┬──┘            │   │
│  └─────┼───────┼───────┼──────────────┼───────────────┘   │
│        └───────┴───────┴──────┬───────┘                   │
│                               ▼                            │
│                    Lock-Free Result Channel                 │
│                               │                            │
│                        ┌──────┴──────┐                     │
│                        │ Sort & Output │                    │
│                        └─────────────┘                     │
│                                                             │
└─────────────────────────────────────────────────────────────┘

核心技术

🔬 基准测试

测试方法

# 克隆测试仓库
git clone https://github.com/kubernetes/kubernetes.git /tmp/k8s
cd /home/mey/woof

# 运行对比测试
./benchmark/run_parallel_comparison.sh /tmp/k8s

# 可视化分析
python3 benchmark/visualize_speedup.py /tmp/k8s

实际项目测试

💡 使用场景

IDE 集成（2ms 响应）

用户保存文件 → woof lint → 显示结果
总延迟: ~5ms (含 IDE 开销)
体验: ✅ 即时反馈，无感知延迟

Git Pre-commit Hook

#!/bin/bash
# .git/hooks/pre-commit
woof check . --fix
woof format . --check

CI/CD 管道

# .github/workflows/lint.yml
- name: Lint with Woof
  uses: GWinfinity/woof-action@v1
  with:
    args: 'check . --format github'

大规模代码库

# 256 核服务器
woof check . --threads 64
# 处理 10,000+ 文件仅需数秒

📚 文档

• API 文档
• 配置参考
• 规则目录
• 性能报告
• 架构设计

🤝 贡献

欢迎贡献！请查看 CONTRIBUTING.md。

# 开发环境
git clone https://github.com/GWinfinity/woof.git
cd woof
cargo test
cargo bench

📄 许可证

Apache License 2.0 © GWinfinity

Made with ❤️ and 🦀 Rust

"Woof 让 Go 代码检查快到忘记它存在。"