spotlight-vscode

Lint your API descriptions as you write them, right in your editor.

spotlight-vscode is the Visual Studio Code companion to the Spotlight stack — a fork of Stoplight's vscode-spectral, rebranded and maintained under API Commons. It surfaces Spotlight's governance rules inline while you edit OpenAPI, AsyncAPI, and Arazzo documents, so problems show up in the Problems panel and as squiggles without leaving your editor.

Features

• Lint on save and lint on type for JSON/YAML API descriptions.
• Custom ruleset support — point it at your .spotlight.{yaml,yml,json,js} ruleset, or use the built-ins.
• Diagnostics in the Problems panel, sourced as spotlight, with severities mapped to errors/warnings/info/hints.
• Runs the same @spotlight-rules/spotlight-* engine as the CLI, so editor and CI agree.

Settings

All configuration lives under the spotlight.* namespace:

• spotlight.enable — turn linting on/off
• spotlight.rulesetFile — path to a custom ruleset
• spotlight.run — onType or onSave
• spotlight.validateFiles / spotlight.validateLanguages — scope which files are linted

Extension id: api-commons.spotlight