Ahh, the traditional generated HTML report. Quite often, they are a real let-down.

I wanted to do something not awful when it comes to the HTML report. vacuum can generate a self-contained interactive UI experience for exploring linting results from an OpenAPI specification, or a vacuum report.

The report has no dependencies, and it makes no network calls. The HTML file that is generated, is fully self-contained, it can be used without an internet connection.

It’s ideal for rendering in a CI/CD pipeline, easily viewable by anyone.

The report is generated in milliseconds and loads just as fast, even for enormous

The report uses WebComponents via Lit, which means it renders really, really fast.


Build a report from an OpenAPI Spec

Use the html-report command followed by a path to your OpenAPI Spec. There is a second optional argument that allows the naming of the report file, otherwise it defaults to report.html.

html report

There should be a file named report.html in the current working direction. Open it up in your favorite browser.s

Change the report output file

html report

Load a vacuum report

Load a vacuum report and render the results as they were recorded, without re-running any linting rules or indexing.

html report

Global Flags

lint supports the following global flags

Short Full Input Description
-r –ruleset string Use an existing ruleset file for linting

Examples

Want to see an example report? Don’t have an OpenAPI spec?

Make sure you have checked out the source, and you’re in the vacuum directory, then you can use example specs:

Stripe

report for stripe

Asana

report for asana

Kubernetes

report for kubernetes