VS Code Extension

Catch API breaking changes
as you type

The CodeRifts VS Code extension gives you real-time inline diagnostics for OpenAPI breaking changes — before commit, before PR, before CI. Red squiggles for BLOCK-level changes, yellow for warnings, blue for informational.

Install from VS Code Marketplace Install on GitHub

openapi.yaml — CodeRifts Analysis

paths:

/users/legacy:

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

delete:

summary: Delete legacy user

/users/{id}:

get:

responses:

"200":

content:

application/json:

schema:

type: integer

CodeRifts: TYPE_CHANGE — GET /users/{id} response.id type changed string → integer | Risk: WARN

$(error) CodeRifts: BLOCK (2 breaking)

Quick start

Install the extension

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

ext install coderifts.coderifts-vscode

Add your API key

Open VS Code Settings and add your CodeRifts API key:

{
  "coderifts.apiKey": "cr_live_..."
}

Open an OpenAPI file

Open any .yaml, .yml, or .json OpenAPI spec. Save the file — CodeRifts automatically compares against the git HEAD baseline and shows inline diagnostics.

Features

Real-time diff on save

Every time you save an OpenAPI file, the extension fetches the git HEAD baseline (git show HEAD:<file>), sends both versions to the CodeRifts API, and updates diagnostics in under a second.

Inline diagnostics

Breaking changes appear as squiggly lines directly on the affected lines. Red for BLOCK-level (endpoint removed, auth changed), yellow for WARN (field removed, type changed), blue for INFO (risky but non-breaking).

Status bar item

The status bar shows the current analysis state at a glance. Click to open the Analysis Panel.

$(shield) CodeRifts: SAFE $(warning) CodeRifts: 3 warnings $(error) CodeRifts: BLOCK (13 breaking)

Analysis Panel

A dedicated sidebar panel shows the full analysis: risk score (0–100), breaking changes list with severity, synaptic weight of changed endpoints, token cost impact, and a direct link to the CodeRifts dashboard.

Installation

Two installation methods are available.

VS Code Marketplace (recommended)

Search for "CodeRifts" in the VS Code Extensions panel (Ctrl+Shift+X), or use the Quick Open command:

ext install coderifts.coderifts-vscode

Open in VS Code Marketplace →

Manual install via npm

The extension is also published to npm for programmatic install or CI environments:

npm install @coderifts/vscode-extension

Or check the latest version:

npm info @coderifts/vscode-extension version

Configuration

All settings live under the coderifts.* namespace in your VS Code settings.json.

{
  // Your CodeRifts API key — get one at app.coderifts.com
  "coderifts.apiKey": "cr_live_your_key_here",

  // API base URL (advanced — do not change unless self-hosting)
  "coderifts.apiUrl": "https://app.coderifts.com",

  // Analyze automatically on every save (default: true)
  "coderifts.autoAnalyze": true,

  // Show inline squiggly lines (default: true)
  "coderifts.showInlineHints": true,

  // Minimum severity to show: "error" | "warning" | "information"
  "coderifts.severity": "warning"
}

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

Start catching breaking changes in your editor

Install the extension, add your API key, and get inline feedback on every save. Free during beta.