@woodpeck/cli 0.1.0

package/README.md

@@ -0,0 +1,205 @@
+# Woodpeck 🐦 / Wood 啄木鸟
+
+基于 Git diff 的智能代码审查 CLI 工具，使用 Rust 编写。
+
+## ✨ 特性
+
+- 🔴 **严重级别**: unwrap()、unsafe 代码块、硬编码密钥等
+- 🟡 **中等级别**: TODO/FIXME、未使用变量、资源泄露等
+- 🟢 **初级别**: 魔法数字、长函数、代码风格等
+- 📊 **多格式输出**: Table/JSON/Markdown/SARIF
+- 🔧 **CI/CD 集成**: 支持失败阈值控制
+
+## 📦 安装
+
+### 方式 1: 直接下载二进制文件
+
+#### macOS
+```bash
+# Intel
+ curl -L -o wood.tar.gz https://github.com/yourusername/woodpeck/releases/latest/download/wood-macos-x64.tar.gz
+tar xzf wood.tar.gz
+sudo mv wood /usr/local/bin/
+
+# Apple Silicon
+curl -L -o wood.tar.gz https://github.com/yourusername/woodpeck/releases/latest/download/wood-macos-arm64.tar.gz
+tar xzf wood.tar.gz
+sudo mv wood /usr/local/bin/
+```
+
+#### Linux
+```bash
+curl -L -o wood.tar.gz https://github.com/yourusername/woodpeck/releases/latest/download/wood-linux-x64.tar.gz
+tar xzf wood.tar.gz
+sudo mv wood /usr/local/bin/
+```
+
+#### Windows
+下载 [wood-windows-x64.exe](https://github.com/yourusername/woodpeck/releases) 并重命名为 `wood.exe`，添加到 PATH。
+
+### 方式 2: 通过 npm 安装
+```bash
+npm install -g @woodpeck/cli
+```
+
+### 方式 3: 从源码编译
+```bash
+git clone https://github.com/yourusername/woodpeck.git
+cd woodpeck
+cargo build --release
+sudo cp target/release/woodpeck /usr/local/bin/wood
+```
+
+## 🚀 使用
+
+### 查看帮助
+```bash
+wood -h
+wood compare -h
+```
+
+### 基础分析
+```bash
+# 对比两个分支
+wood compare main feature-branch
+
+# 指定仓库路径
+wood compare main feature-branch --path=/path/to/repo
+
+# 只显示严重问题
+wood compare main feature-branch --severity=high
+```
+
+### 输出格式
+```bash
+# JSON 格式
+wood compare main feature-branch --format=json
+
+# Markdown 格式（适合 PR 描述）
+wood compare main feature-branch --format=markdown
+
+# 导出到文件
+wood compare main feature-branch --output=report.md
+```
+
+### CI/CD 集成
+```bash
+# 如果有严重问题则 CI 失败
+wood compare main feature-branch --fail-on=high:0
+
+# 允许最多 5 个中等问题
+wood compare main feature-branch --fail-on=medium:5
+```
+
+## 📊 输出示例
+
+```
+Woodpeck Analysis Report
+main → feature/test
+
++-----------+---------+------+---------------------+----------------------------------+
+| Severity  | File    | Line | Rule                | Description                      |
++=======================================================================================+
+| 🔴 High   | main.rs | 3    | RUST_UNWRAP_IN_PROD | Using unwrap() can cause panics  |
+|-----------+---------+------+---------------------+----------------------------------|
+| 🟡 Medium | main.rs | 10   | RUST_TODO           | TODO comment found               |
+|-----------+---------+------+---------------------+----------------------------------|
+| 🟢 Low    | main.rs | 13   | RUST_MAGIC_NUMBER   | Unnamed numeric constant         |
++-----------+---------+------+---------------------+----------------------------------+
+
+Summary:
+  Total files: 1
+  Total issues: 3
+    🔴 High: 1
+    🟡 Medium: 1
+    🟢 Low: 1
+```
+
+## ⚙️ 配置
+
+创建 `woodpeck.toml` 配置文件：
+
+```toml
+# 默认只显示严重和中等问题
+default_severity = "medium"
+
+# 默认 JSON 格式
+default_format = "json"
+
+[output]
+color = "auto"
+show_summary = true
+
+[rules.overrides.RUST_UNWRAP_IN_PROD]
+enabled = true
+severity = "high"
+```
+
+## 🔌 GitHub Actions 集成
+
+```yaml
+name: Code Review
+
+on: [pull_request]
+
+jobs:
+  woodpeck:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+
+      - name: Download Woodpeck
+        run: |
+          curl -L -o wood.tar.gz https://github.com/yourusername/woodpeck/releases/latest/download/wood-linux-x64.tar.gz
+          tar xzf wood.tar.gz
+          chmod +x wood
+          sudo mv wood /usr/local/bin/
+
+      - name: Run Woodpeck
+        run: wood compare origin/main HEAD --fail-on=high:0
+```
+
+## 🛠️ 开发
+
+### 构建
+```bash
+cargo build --release
+```
+
+### 测试
+```bash
+cargo test
+```
+
+### 运行
+```bash
+cargo run -- compare main feature-branch
+```
+
+## 📋 支持的规则
+
+| 规则 ID | 级别 | 描述 |
+|---------|------|------|
+| RUST_UNWRAP_IN_PROD | 🔴 High | 生产代码中使用 unwrap() |
+| RUST_UNSAFE_BLOCK | 🔴 High | unsafe 代码块 |
+| JS_DANGEROUS_EVAL | 🔴 High | 使用 eval() |
+| RUST_TODO | 🟡 Medium | TODO/FIXME/XXX 注释 |
+| RUST_UNUSED_VARIABLE | 🟡 Medium | 未使用的变量 |
+| RUST_MAGIC_NUMBER | 🟢 Low | 魔法数字 |
+| RUST_LONG_FUNCTION | 🟢 Low | 过长的函数 |
+
+## 📄 许可证
+
+MIT
+
+## 🤝 贡献
+
+欢迎提交 Issue 和 PR！
+
+## 🙏 鸣谢
+
+- [clap](https://github.com/clap-rs/clap) - CLI 框架
+- [git2](https://github.com/rust-lang/git2-rs) - Git 操作
+- [regex](https://github.com/rust-lang/regex) - 正则表达式

package/bin/wood

@@ -0,0 +1,9 @@
+#!/usr/bin/env node
+const path = require('path');
+const { spawn } = require('child_process');
+
+const binary = path.join(__dirname, process.platform === 'win32' ? 'wood.exe' : 'wood');
+const args = process.argv.slice(2);
+
+const child = spawn(binary, args, { stdio: 'inherit' });
+child.on('exit', (code) => process.exit(code));

package/install.js

@@ -0,0 +1,117 @@
+#!/usr/bin/env node
+
+const { execSync } = require('child_process');
+const fs = require('fs');
+const path = require('path');
+const https = require('https');
+const { platform, arch } = process;
+
+const VERSION = require('./package.json').version;
+const REPO = 'yourusername/woodpeck';
+
+function getBinaryName() {
+  const platformMap = {
+    'darwin': 'macos',
+    'linux': 'linux',
+    'win32': 'windows'
+  };
+  
+  const archMap = {
+    'x64': 'x64',
+    'arm64': 'arm64'
+  };
+  
+  const platformName = platformMap[platform];
+  const archName = archMap[arch] || 'x64';
+  
+  if (!platformName) {
+    throw new Error(`不支持的平台: ${platform}`);
+  }
+  
+  if (platform === 'win32') {
+    return `wood-${platformName}-${archName}.exe`;
+  }
+  return `wood-${platformName}-${archName}`;
+}
+
+function getDownloadUrl() {
+  const binaryName = getBinaryName();
+  return `https://github.com/${REPO}/releases/download/v${VERSION}/${binaryName}`;
+}
+
+function downloadFile(url, dest) {
+  return new Promise((resolve, reject) => {
+    const file = fs.createWriteStream(dest);
+    https.get(url, (response) => {
+      if (response.statusCode === 302 || response.statusCode === 301) {
+        downloadFile(response.headers.location, dest)
+          .then(resolve)
+          .catch(reject);
+        return;
+      }
+      
+      if (response.statusCode !== 200) {
+        reject(new Error(`下载失败，状态码: ${response.statusCode}`));
+        return;
+      }
+      
+      response.pipe(file);
+      file.on('finish', () => {
+        file.close();
+        resolve();
+      });
+    }).on('error', (err) => {
+      fs.unlink(dest, () => {});
+      reject(err);
+    });
+  });
+}
+
+async function install() {
+  try {
+    const binaryName = getBinaryName();
+    const binDir = path.join(__dirname, 'bin');
+    const binaryPath = path.join(binDir, platform === 'win32' ? 'wood.exe' : 'wood');
+    
+    // 创建 bin 目录
+    if (!fs.existsSync(binDir)) {
+      fs.mkdirSync(binDir, { recursive: true });
+    }
+    
+    // 如果本地已存在二进制文件，跳过下载
+    if (fs.existsSync(binaryPath)) {
+      console.log('✓ 二进制文件已存在，跳过下载');
+      return;
+    }
+    
+    console.log(`正在下载 wood ${VERSION}...`);
+    console.log(`平台: ${platform} (${arch})`);
+    console.log(`目标: ${binaryName}`);
+    
+    // 开发阶段：从本地复制
+    const localBinary = path.join(__dirname, 'target', 'release', 'wood');
+    if (fs.existsSync(localBinary)) {
+      console.log('使用本地构建的二进制文件...');
+      fs.copyFileSync(localBinary, binaryPath);
+    } else {
+      // 生产阶段：从 GitHub 下载
+      const url = getDownloadUrl();
+      console.log(`下载地址: ${url}`);
+      await downloadFile(url, binaryPath);
+    }
+    
+    // 设置执行权限
+    if (platform !== 'win32') {
+      fs.chmodSync(binaryPath, 0o755);
+    }
+    
+    console.log('✓ 安装完成！');
+    console.log(`运行: wood --help`);
+    
+  } catch (error) {
+    console.error('安装失败:', error.message);
+    process.exit(1);
+  }
+}
+
+install();

package/package.json

@@ -0,0 +1,50 @@
+{
+  "name": "@woodpeck/cli",
+  "version": "0.1.0",
+  "description": "基于 Git diff 的代码审查工具 - 发现代码中的潜在问题",
+  "main": "index.js",
+  "bin": {
+    "wood": "./bin/wood",
+    "woodpeck": "./bin/wood"
+  },
+  "scripts": {
+    "postinstall": "node install.js",
+    "test": "echo \"Binary only package, no tests\""
+  },
+  "keywords": [
+    "code-review",
+    "git",
+    "static-analysis",
+    "rust",
+    "cli",
+    "code-quality"
+  ],
+  "author": "Woodpeck Team",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/jxhhdx/Woodpeck.git"
+  },
+  "bugs": {
+    "url": "https://github.com/jxhhdx/Woodpeck/issues"
+  },
+  "homepage": "https://github.com/jxhhdx/Woodpeck#readme",
+  "engines": {
+    "node": ">=14.0.0"
+  },
+  "os": [
+    "darwin",
+    "linux",
+    "win32"
+  ],
+  "cpu": [
+    "x64",
+    "arm64"
+  ],
+  "files": [
+    "bin/",
+    "install.js",
+    "README.md",
+    "LICENSE"
+  ]
+}