{"_id":"@coderifts/vscode-extension","_rev":"2-d342ca8f9e312bd831fe0a83a9fb28ec","name":"@coderifts/vscode-extension","dist-tags":{"latest":"1.0.0"},"versions":{"1.0.0":{"name":"@coderifts/vscode-extension","version":"1.0.0","keywords":["openapi","swagger","api","breaking-changes","coderifts","diagnostics"],"license":"MIT","_id":"@coderifts/vscode-extension@1.0.0","maintainers":[{"name":"zsobpeter","email":"zsobpeter@gmail.com"}],"homepage":"https://coderifts.com/integrations/vscode/","bugs":{"url":"https://github.com/coderifts/vscode-extension/issues"},"dist":{"shasum":"ad1f02607ce39950442753f84ec6c0d935f8026a","tarball":"https://registry.npmjs.org/@coderifts/vscode-extension/-/vscode-extension-1.0.0.tgz","fileCount":13,"integrity":"sha512-KojaviOt/FqjSmo+Fjoh+d2ZWStNcb99KwiCewgy7kgf/ySErd8PM+qLl1JEtBDXHia8OZeMP3Q2dxwKf1s4Mg==","signatures":[{"sig":"MEYCIQCVDmbpSuZiENScFvbeAUjNFyXkb4N5qgoSdKtvTilrxQIhAKhiBw0v8j1v0SRgmE8iOVXbfG3S4QhayBX9SEs3Xi0Y","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":56870},"icon":"images/icon.png","main":"./dist/extension.js","engines":{"node":">=18.0.0","vscode":"^1.85.0"},"gitHead":"f7747c143e562ca108fe8a036f6734987240d613","scripts":{"lint":"eslint src --ext .ts","test":"node test/analyzer.test.js","build":"tsc -p tsconfig.json","watch":"tsc -watch -p tsconfig.json","package":"vsce package","vscode:prepublish":"npm run build"},"_npmUser":{"name":"zsobpeter","email":"zsobpeter@gmail.com"},"publisher":"coderifts","categories":["Linters","Other"],"repository":{"url":"git+https://github.com/coderifts/vscode-extension.git","type":"git"},"_npmVersion":"10.9.2","contributes":{"views":{"coderifts":[{"id":"coderifts.panel","name":"Analysis","type":"webview"}]},"commands":[{"title":"CodeRifts: Analyze Current File","command":"coderifts.analyze","category":"CodeRifts"},{"title":"CodeRifts: Open Dashboard","command":"coderifts.openDashboard","category":"CodeRifts"},{"title":"CodeRifts: Configure Settings","command":"coderifts.configure","category":"CodeRifts"},{"title":"CodeRifts: Clear Diagnostics","command":"coderifts.clearDiagnostics","category":"CodeRifts"},{"title":"CodeRifts: Open Analysis Panel","command":"coderifts.openPanel","category":"CodeRifts"}],"configuration":{"title":"CodeRifts","properties":{"coderifts.apiKey":{"type":"string","default":"","description":"Your CodeRifts API key (cr_live_...)","markdownDescription":"Your CodeRifts API key. Get one at [app.coderifts.com](https://app.coderifts.com)."},"coderifts.apiUrl":{"type":"string","default":"https://app.coderifts.com","description":"CodeRifts API base URL (advanced — do not change unless self-hosting)"},"coderifts.severity":{"enum":["error","warning","information"],"type":"string","default":"warning","description":"Minimum severity level to show as a diagnostic"},"coderifts.autoAnalyze":{"type":"boolean","default":true,"description":"Automatically analyze OpenAPI files on save"},"coderifts.showInlineHints":{"type":"boolean","default":true,"description":"Show inline diagnostics (squiggly lines) for breaking changes"}}},"viewsContainers":{"activitybar":[{"id":"coderifts","icon":"images/icon.png","title":"CodeRifts"}]}},"description":"Real-time breaking change detection for OpenAPI specs. Get inline diagnostics, status bar alerts, and risk scores as you edit.","directories":{},"displayName":"CodeRifts — API Breaking Change Detector","_nodeVersion":"22.13.0","_hasShrinkwrap":false,"devDependencies":{"typescript":"^5.3.0","@types/node":"^20.0.0","@types/vscode":"^1.85.0"},"activationEvents":["onLanguage:yaml","onLanguage:json","workspaceContains:**/openapi.yaml","workspaceContains:**/swagger.yaml"],"_npmOperationalInternal":{"tmp":"tmp/vscode-extension_1.0.0_1773782086378_0.7934562120250812","host":"s3://npm-registry-packages-npm-production"},"deprecated":"Not maintained on npm. The VS Code extension is on the Marketplace: coderifts.coderifts-vscode"}},"time":{"created":"2026-03-17T21:14:46.269Z","modified":"2026-10-04T18:13:23.942Z","1.0.0":"2026-03-17T21:14:46.516Z"},"bugs":{"url":"https://github.com/coderifts/vscode-extension/issues"},"license":"MIT","homepage":"https://coderifts.com/integrations/vscode/","keywords":["openapi","swagger","api","breaking-changes","coderifts","diagnostics"],"repository":{"url":"git+https://github.com/coderifts/vscode-extension.git","type":"git"},"description":"Real-time breaking change detection for OpenAPI specs. Get inline diagnostics, status bar alerts, and risk scores as you edit.","maintainers":[{"name":"zsobpeter","email":"zsobpeter@gmail.com"}],"readme":"# CodeRifts — API Breaking Change Detector\n\n**Real-time breaking change detection for OpenAPI specs, right inside VS Code.**\n\nGet inline diagnostics, status bar alerts, and a full risk analysis panel as you edit your OpenAPI/Swagger files — before commit, before PR, before CI.\n\n---\n\n## Install from VS Code Marketplace\n\nSearch for **\"CodeRifts\"** in the VS Code Extensions panel, or install directly:\n\n```\next install coderifts.coderifts-vscode\n```\n\n---\n\n## Quick Start\n\n1. **Add your API key** to VS Code settings:\n   ```json\n   {\n     \"coderifts.apiKey\": \"cr_live_your_key_here\"\n   }\n   ```\n   Get a free API key at [app.coderifts.com](https://app.coderifts.com).\n\n2. **Open an OpenAPI file** (`.yaml`, `.yml`, or `.json` matching OpenAPI patterns).\n\n3. **Save the file** — CodeRifts automatically compares your changes against the git HEAD baseline and shows inline diagnostics.\n\n---\n\n## Features\n\n### Real-time diff on save\n\nWhen you save an OpenAPI file, the extension:\n1. Fetches the git baseline (`git show HEAD:<file>`)\n2. Sends both versions to the CodeRifts API\n3. Shows inline squiggly lines for breaking changes\n4. Updates the status bar with a summary\n\n### Inline diagnostics\n\n| Squiggly colour | Severity | Example |\n|---|---|---|\n| Red (error) | BLOCK — deployment-blocking | Endpoint removed, auth changed |\n| Yellow (warning) | WARN — breaking for consumers | Field removed, type changed |\n| Blue (information) | INFO — risky but not breaking | Description changed, new optional field |\n\nExample diagnostic message:\n```\nCodeRifts: ENDPOINT_REMOVAL — DELETE /users/legacy — Risk: BLOCK | P_break: 0.89 | Blast radius: 3 consumers\n```\n\n### Status bar\n\nThe status bar shows the current analysis state:\n\n| Status | Meaning |\n|---|---|\n| `$(shield) CodeRifts: SAFE` | No breaking changes |\n| `$(warning) CodeRifts: 3 warnings` | Warning-level changes |\n| `$(error) CodeRifts: BLOCK (13 breaking)` | Deployment-blocking changes |\n\nClick the status bar item to open the Analysis Panel.\n\n### Analysis Panel\n\nA dedicated sidebar panel showing:\n- Current file analysis results\n- Risk score (0–100)\n- Breaking changes list with severity\n- Synaptic weight of changed endpoints\n- Token cost impact\n- \"View in Dashboard\" link\n\n### Commands\n\n| Command | Description |\n|---|---|\n| `CodeRifts: Analyze Current File` | Manually trigger analysis |\n| `CodeRifts: Open Dashboard` | Open app.coderifts.com |\n| `CodeRifts: Configure Settings` | Open CodeRifts settings |\n| `CodeRifts: Clear Diagnostics` | Remove all squiggly lines |\n\n---\n\n## Screenshot\n\n![CodeRifts inline diagnostics showing breaking changes in an OpenAPI YAML file](https://coderifts.com/integrations/vscode/screenshot.png)\n\n*Inline diagnostics highlighting a removed endpoint (red) and a changed response type (yellow)*\n\n---\n\n## Configuration\n\nAll settings are under the `coderifts.*` namespace:\n\n| Setting | Default | Description |\n|---|---|---|\n| `coderifts.apiKey` | `\"\"` | Your CodeRifts API key |\n| `coderifts.apiUrl` | `https://app.coderifts.com` | API base URL |\n| `coderifts.autoAnalyze` | `true` | Analyze on save |\n| `coderifts.showInlineHints` | `true` | Show squiggly lines |\n| `coderifts.severity` | `\"warning\"` | Minimum severity to show |\n\n---\n\n## Requirements\n\n- VS Code 1.85+\n- Git installed and available in PATH\n- A CodeRifts API key ([get one free](https://app.coderifts.com))\n\n---\n\n## Links\n\n- [Documentation](https://coderifts.com/integrations/vscode/)\n- [Dashboard](https://app.coderifts.com)\n- [GitHub](https://github.com/coderifts/vscode-extension)\n- [Report an issue](https://github.com/coderifts/vscode-extension/issues)\n","readmeFilename":"README.md"}