DiffSense

DiffSense

DiffSense 是 PR 阶段的变更风险关卡：它评估当前差异是否引入回归风险，不执行完整代码库扫描或风格检查。专为减少告警、提高精确度、降低延迟和提供可解释结果而设计。

---

快速开始

场景	操作
GitHub Pull Request	将 diffsense/docs/quickstart.md 中的工作流（方法 1）复制到目标仓库的 .github/workflows/diffsense.yml。使用默认的 GITHUB_TOKEN，无需额外配置。提交并创建或更新 PR 后，工作流会自动执行审计并在 PR 下发布结果。
本地审计	在仓库根目录运行 pip install -e diffsense，或运行 pip install "git+https://github.com/GoldenSupremeSaltedFish/DiffSense.git@main#subdirectory=diffsense"，然后执行 diffsense replay <path-to-diff>。
Agent / 大模型集成	使用 pip install "diffsense[mcp]" 安装 MCP 服务并运行 diffsense-mcp，或直接使用 JSON 契约 / SARIF。请参阅 Agent 集成指南。

完整步骤请参阅 diffsense/docs/quickstart.md。

可选：将 .diffsense.yaml 添加到仓库根目录，以使用官方推荐配置，适用于大多数团队。

---

功能

• CI / 本地：对 MR/PR 差异执行语义风险审计，输出 review_level 和建议操作。仅分析变更内容，不会拖慢流水线。低质量规则会自动降级。不会自动修改 CI 状态；是否拦截由人工或下游流程决定。
• Agent / 大模型集成：为 Agent 和 CI 关卡提供确定性、机器可读的接口——带版本的 JSON 契约（schema_version）、SARIF 2.1.0 输出，以及只读 MCP 服务（audit_diff / audit_replay / list_rules / explain_rule）。请参阅 Agent 集成指南和 CLI 契约。
• VSCode 扩展：在本仓库的 vscode-extension 目录中维护（双产物布局）。可从 Marketplace 安装，或从 Releases 下载 VSIX。

---

快速开始（详细说明）

GitHub Actions

将 diffsense/docs/quickstart.md 中的完整 YAML（方法 1）复制到仓库的 .github/workflows/diffsense.yml，即可启用 PR 审计。

GitLab CI

1. 在项目中前往 Settings → CI/CD → Variables，添加变量 DIFFSENSE_TOKEN（具有 api 权限的 Personal Access Token；建议勾选 Mask variable）。
2. 在 .gitlab-ci.yml 中添加相应的作业。示例请参阅 diffsense/gitlab-ci-example.yml。

VSCode 扩展

在本仓库的 vscode-extension 目录中维护。可从 Marketplace 安装，或从 Releases 下载 VSIX。

---

Project Structure (This Branch)

DiffSense/
├── diffsense/          # CLI, rule engine, GitHub/GitLab adapters, MCP server; see docs/quickstart.md for quick start
├── vscode-extension/   # VS Code extension (dual-artifact line)
├── AGENTS.md           # repository guide for AI coding agents
└── technical_documentation/

---

Development

git clone https://github.com/GoldenSupremeSaltedFish/DiffSense.git
cd DiffSense/diffsense
pip install -e ".[dev]"
pytest tests/ -v

See diffsense/CONTRIBUTING.md for details.

---

License & Links

• License: Apache-2.0
• Issues: Report a bug
• Marketplace: DiffSense

English | 中文版（存档）