Catch API breaking changes as you type
1
Install the extension
Search for "CodeRifts" in the VS Code Extensions panel, or run: ext install coderifts.coderifts-vscode
2
Add your API key
Open VS Code Settings and add your CodeRifts API key:
{ "coderifts.apiKey": "cr_live_..." }3
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 — Shows the current analysis state at a glance:
CodeRifts: SAFE,CodeRifts: 3 warnings,CodeRifts: BLOCK (3 breaking). Click to open the Analysis Panel. - Analysis panel — A dedicated sidebar panel shows the full analysis: risk score (0–100), breaking changes list with severity, and a direct link to the CodeRifts dashboard.
Configuration#
All settings live under the coderifts.* namespace in settings.json:
{
// Your CodeRifts API key
"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 |
Installation#
Recommended: search "CodeRifts" in the VS Code Extensions panel (Ctrl+Shift+X), or use Quick Open: ext install coderifts.coderifts-vscode. Also published to npm for programmatic install: npm install @coderifts/vscode-extension.