vacuum OpenAPI linter for VSCode

The world's fastest OpenAPI linter

This is a VSCode extension that allows you to use the world's fastest OpenAPI linter inside VSCode.

Install vacuum

If you don't have vacuum installed, make sure you do that first (requires v0.9.1 or later).

vacuum does not come bundled with the plugin.

npm install -g @quobix/vacuum

Or via yarn using yarn global add @quobix/vacuum

You can also use homebrew to install vacuum on MacOS X

brew install daveshanley/vacuum/vacuum

See more installation options.

---

Enabling vacuum

Open up the command palette and type vacuum and select Lint OpenAPI using vacuum.

YAML and JSON files will be automatically detected (if they are OpenAPI) and linted using vacuum.

Disabling vacuum

If you want to disable vacuum, open up the command palette and type vacuum and select Stop Linting OpenAPI using vacuum.

Configuration

To configure vacuum to use your own rules, rulesets and custom functions, you can provide a configuration file.

To change the configuration, you will need to disable and re-enable vacuum.

Documentation

Learn more about vacuum by visiting the vacuum documentation.

vacuum documentation vacuum online demo