CodeRifts — API Breaking Change Detector

Real-time breaking change detection for OpenAPI specs, right inside VS Code.

Get inline diagnostics, status bar alerts, and a full risk analysis panel as you edit your OpenAPI/Swagger files — before commit, before PR, before CI.

Install from VS Code Marketplace

Search for "CodeRifts" in the VS Code Extensions panel, or install directly:

ext install coderifts.coderifts-vscode

Quick Start

1. Add your API key to VS Code settings:

   {
     "coderifts.apiKey": "cr_live_your_key_here"
   }

   Get a free API key at app.coderifts.com.

2. Open an OpenAPI file (.yaml, .yml, or .json matching OpenAPI patterns).

3. Save the file — CodeRifts automatically compares your changes against the git HEAD baseline and shows inline diagnostics.

Features

Real-time diff on save

When you save an OpenAPI file, the extension:

1. Fetches the git baseline (git show HEAD:<file>)
2. Sends both versions to the CodeRifts API
3. Shows inline squiggly lines for breaking changes
4. Updates the status bar with a summary

Inline diagnostics

| Squiggly colour | Severity | Example | |---|---|---| | Red (error) | BLOCK — deployment-blocking | Endpoint removed, auth changed | | Yellow (warning) | WARN — breaking for consumers | Field removed, type changed | | Blue (information) | INFO — risky but not breaking | Description changed, new optional field |

Example diagnostic message:

CodeRifts: ENDPOINT_REMOVAL — DELETE /users/legacy — Risk: BLOCK | P_break: 0.89 | Blast radius: 3 consumers

Status bar

The status bar shows the current analysis state:

| Status | Meaning | |---|---| | $(shield) CodeRifts: SAFE | No breaking changes | | $(warning) CodeRifts: 3 warnings | Warning-level changes | | $(error) CodeRifts: BLOCK (13 breaking) | Deployment-blocking changes |

Click the status bar item to open the Analysis Panel.

Analysis Panel

A dedicated sidebar panel showing:

• Current file analysis results
• Risk score (0–100)
• Breaking changes list with severity
• Synaptic weight of changed endpoints
• Token cost impact
• "View in Dashboard" link

Commands

| Command | Description | |---|---| | CodeRifts: Analyze Current File | Manually trigger analysis | | CodeRifts: Open Dashboard | Open app.coderifts.com | | CodeRifts: Configure Settings | Open CodeRifts settings | | CodeRifts: Clear Diagnostics | Remove all squiggly lines |

Screenshot

Inline diagnostics highlighting a removed endpoint (red) and a changed response type (yellow)

Configuration

All settings are under the coderifts.* namespace:

| Setting | Default | Description | |---|---|---| | coderifts.apiKey | "" | Your CodeRifts API key | | coderifts.apiUrl | https://app.coderifts.com | API base URL | | coderifts.autoAnalyze | true | Analyze on save | | coderifts.showInlineHints | true | Show squiggly lines | | coderifts.severity | "warning" | Minimum severity to show |

Requirements

• VS Code 1.85+
• Git installed and available in PATH
• A CodeRifts API key (get one free)

Links

• Documentation
• Dashboard
• GitHub
• Report an issue