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> を実行します。
エージェント / LLM 連携	pip install "diffsense[mcp]" で MCP サーバーをインストールして diffsense-mcp を実行するか、JSON コントラクト / SARIF を直接利用します。詳細はエージェント連携ガイドをご覧ください。

完全な手順は diffsense/docs/quickstart.md で確認できます。

任意: リポジトリのルートに .diffsense.yaml を追加すると、ほとんどのチームに適した公式推奨設定を使用できます。

---

機能

• CI / ローカル: MR/PR の差分に対してセマンティックなリスク監査を実行し、review_level と推奨アクションを出力します。変更された内容のみを解析するため、パイプラインを遅くしません。品質の低いルールは自動的にダウングレードされます。CI ステータスを自動的に変更することはなく、ブロックするかどうかの判断は手動または下流のプロセスによって行われます。
• エージェント / LLM 連携: エージェントや CI ゲート向けの決定論的で機械可読なインターフェース — バージョン管理された JSON コントラクト（schema_version）、SARIF 2.1.0 出力、および読み取り専用の MCP サーバー（audit_diff / audit_replay / list_rules / explain_rule）。詳細はエージェント連携ガイドおよび CLI コントラクトをご覧ください。
• VSCode 拡張機能: このリポジトリの vscode-extension ディレクトリで管理されています（デュアルアーティファクト構成）。Marketplace からインストールするか、Releases から VSIX をダウンロードしてください。

---

クイックスタート（詳細）

GitHub Actions

diffsense/docs/quickstart.md（方法 1）の完全な YAML を、リポジトリの .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 | 中文版（存档）