https://github.com/stoplightio/vscode-spectral
VS Code extension bringing the awesome Spectral JSON/YAML linter with OpenAPI/AsyncAPI support
https://github.com/stoplightio/vscode-spectral
stoplight-oss stoplight-spectral
Last synced: 3 months ago
JSON representation
VS Code extension bringing the awesome Spectral JSON/YAML linter with OpenAPI/AsyncAPI support
- Host: GitHub
- URL: https://github.com/stoplightio/vscode-spectral
- Owner: stoplightio
- License: apache-2.0
- Created: 2019-12-12T13:02:36.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2025-03-28T22:22:24.000Z (over 1 year ago)
- Last Synced: 2026-03-05T10:56:30.494Z (4 months ago)
- Topics: stoplight-oss, stoplight-spectral
- Language: TypeScript
- Homepage: https://marketplace.visualstudio.com/items?itemName=stoplight.spectral
- Size: 1.63 MB
- Stars: 77
- Watchers: 13
- Forks: 26
- Open Issues: 41
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.txt
- Code of conduct: .github/CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Spectral Linter for VS Code
The Spectral VS Code Extension brings the power of [Spectral](https://stoplight.io/open-source/spectral?utm_source=github.com&utm_medium=referral&utm_campaign=github_repo_vs_code_spectral) to your favorite editor.
Spectral is a flexible object linter with out of the box support for [OpenAPI](https://openapis.org/) v2 and v3, [Arazzo](https://www.openapis.org/arazzo), [JSON Schema](https://json-schema.org/), and [AsyncAPI](https://www.asyncapi.com/) v2 and v3.
## Features
- Lint-on-save
- Lint-on-type
- Custom ruleset support (`.spectral.json`, `.spectral.yaml`, `.spectral.yml` or `.spectral.js`)
- Intellisense for custom ruleset editing
- Support for JSON and YAML input
## Requirements
- Node.js ^12.21 or >=14.13
- Visual Studio Code version 1.48 or higher.
## Installation
- Install from the [Visual Studio Code Marketplace](https://marketplace.visualstudio.com/items?itemName=stoplight.spectral)
- Install via the CLI: `code --install-extension stoplight.spectral`
## Extension Settings
This extension contributes the following settings:
- `spectral.enable`: Controls whether or not Spectral is enabled.
- `spectral.rulesetFile`: Location of the ruleset file to use when validating. If omitted, the default is a `.spectral.(json|yaml|yml)` in the same folder as the document being validated. Paths are relative to the workspace. This can also be a remote HTTP url.
- `spectral.run`: Run the linter on save (`onSave`) or as you type (`onType`).
- `spectral.validateFiles`: An array of file globs (e.g., `**/*.yaml`) which should be validated by Spectral. If language identifiers are also specified, the file must match both in order to be validated. You can also use negative file globs (e.g., `!**/package.json`) here to exclude files.
- `spectral.validateLanguages`: An array of language IDs (e.g., `yaml`, `json`) which should be validated by Spectral. If file globs are also specified, the file must match both in order to be validated.
## Thanks
- [Mike Ralphson](https://github.com/MikeRalphson)
- [Travis Illig](https://github.com/tillig)
## License
[Apache-2.0](LICENSE.txt)