AI Arch Review

VS Code extension + local companion service to detect architectural smells (layer violations) in TS/JS, Python, and Java. Deterministic engine first, with optional LLM summaries (Ollama / Cloud opt‑in).

Features

• Analyze Workspace: scans the repo and reports findings in the Problems panel.
• Report Webview: opens a rendered report (Markdown → HTML).
• Privacy levels: strict / balanced / assist / cloud.
• Companion service: local FastAPI backend with deterministic rules.

Requirements

• Node.js (for the extension build)
• Python 3.10+ (for the companion service)
• Optional: Ollama for local LLM summaries

Setup (Local Development)

1. Install extension deps:

   cd extension
   npm install
   npm run compile
   

2. Set up companion:

   cd companion
   python3 -m venv .venv
   source .venv/bin/activate
   pip install -r requirements.txt
   ./run.sh
   

3. Run extension:

   • Open extension/ in VS Code
   • Press F5 (Extension Development Host)
   • In the new window, open arch-smell-sandbox/
   • Command Palette → AI Arch Review: Analyze Workspace
   • Command Palette → AI Arch Review: Open Report

Usage

• Analyze Workspace: AI Arch Review: Analyze Workspace
• Start Companion: AI Arch Review: Start Companion
• Stop Companion: AI Arch Review: Stop Companion
• Status: AI Arch Review: Status
• Open Report: AI Arch Review: Open Report

Settings

• aiArchReview.privacyLevel: strict | balanced | assist | cloud
• aiArchReview.companion.host: default 127.0.0.1
• aiArchReview.companion.port: default 8123
• aiArchReview.analysis.ignore: glob patterns to ignore
• aiArchReview.ollama.host: default 127.0.0.1
• aiArchReview.ollama.port: default 11434
• aiArchReview.ollama.model: default llama3
• aiArchReview.ollama.timeoutSec: default 60
• aiArchReview.cloud.allow: default false
• aiArchReview.cloud.redact: default true
• aiArchReview.cloud.endpoint: optional URL
• aiArchReview.cloud.timeoutSec: default 60

Privacy

• Strict: no code snippets sent anywhere.
• Balanced (default): snippets included locally.
• Assist: uses local Ollama only.
• Cloud: requires explicit opt‑in + optional redaction.

Troubleshooting

• No findings: ensure you opened arch-smell-sandbox/ in the Extension Host.
• Report not showing: run Open Report from the Command Palette.
• Ollama timeout: increase aiArchReview.ollama.timeoutSec.

License

MIT