readyorai

ReadyOrAI

零成本的本地代码检查 MCP 服务。分析代码是否遵循整洁代码实践和最佳实践，并提供可执行的建议——不会修改代码，也不会进行 API 调用。

功能

• 9 种分析器：复杂度、命名、结构、模式、导入、文档、安全、重复代码、AI 生成代码检测
• 多语言支持：JS/TS、Python、Go、Rust（深度分析）+ Java、C#、Ruby、PHP 等（基于正则表达式）
• 零成本：所有分析均在本地运行——无需 API 密钥，也不会进行外部调用
• MCP 服务：通过 stdio 传输与 Claude Desktop、Claude Code 和 VS Code 配合使用
• CLI 工具：通过 ready @filename 和 AI 终端命令独立使用
• SARIF 输出：导出结果，以便集成 GitHub Code Scanning
• 监视模式：文件更改时持续重新分析
• 基线/差异模式：跟踪渐进式采用情况——只查看新问题
• 配置文件：项目级 .readyorai.json，用于共享设置
• 行内抑制：使用 // readyorai-ignore 注释隐藏特定发现

安装

作为 MCP 服务

Claude Desktop（claude_desktop_config.json）：

{
  "mcpServers": {
    "readyorai": {
      "command": "npx",
      "args": ["-y", "readyorai"]
    }
  }
}

Claude Code：

claude mcp add readyorai -- npx -y readyorai

VS Code（.vscode/mcp.json）：

{
  "servers": {
    "readyorai": {
      "command": "npx",
      "args": ["-y", "readyorai"]
    }
  }
}

作为 CLI 工具

npm install -g readyorai

CLI 用法

ready @src/index.ts                          # Inspect a single file
ready @src/                                  # Inspect a directory
ready @src/index.ts --checks security,naming # Run specific checks
ready @src/index.ts --json                   # JSON output
ready @src/index.ts --sarif                  # SARIF output (GitHub Code Scanning)
ready @src/index.ts --severity warning       # Only warnings and errors
ready @src/index.ts --watch                  # Re-analyze on file changes
ready @src/ --baseline baseline.json         # Compare against saved baseline
ready @src/ --save-baseline baseline.json    # Save current results as baseline
AI                                           # Inspect current directory
AI @src/utils.ts                             # Alias with file target

退出代码

代码	含义
0	未发现问题
1	发现警告
2	发现错误
3	运行时错误

配置

在项目根目录中创建 .readyorai.json：

{
  "checks": ["complexity", "naming", "security"],
  "severity": "warning",
  "exclude": ["dist/**", "node_modules/**"]
}

行内抑制

隐藏某一行中的特定发现：

eval(code); // readyorai-ignore

MCP 工具

工具	说明
inspect_file	分析单个文件中的代码质量问题
inspect_directory	批量分析目录中的所有源文件
get_metrics	获取量化指标（LOC、复杂度、函数数量）
compare_files	比较两个文件版本，并显示已修复、新增或未变更的发现
suggest_fixes	针对每项发现，结合上下文提供可执行的修复建议

MCP 提示词

提示词	说明
review-code	结构化代码审查，可选择关注领域
health-check	项目级健康状况评估

检查项

检查项	检测内容
complexity	圈复杂度/认知复杂度、深层嵌套
naming	命名约定违规、单字母变量、布尔值前缀
structure	文件/函数过长、参数过多、行过长
patterns	console.log、空 catch、魔法数字、嵌套三元表达式、TODO
imports	未使用的导入、通配符导入、分散的导入
documentation	缺少 JSDoc/docstring、注释比例过低
security	硬编码密钥、eval()、SQL 注入、XSS 模式
duplication	重复代码块、重复的魔法字符串
ai-detection	检测 AI 生成代码中常见的模式

语言支持

级别	语言	分析方式
1	JavaScript、TypeScript、Python、Go、Rust	基于完整 AST 的分析
2	Java、C#、Ruby、PHP、Swift、Kotlin、C、C++	基于正则表达式和启发式的分析
3	任意文本文件	基于行的检查（长度、TODO、密钥、重复代码）

开发

git clone https://github.com/TedoNeObichaJavaScript/ReadyOrAI.git
cd ReadyOrAI
npm install
npm run build
npm test

支持

如果 ReadyOrAI 对你有帮助，请考虑支持这个项目：

• Borko — 5 欧元

许可证

MIT