@quobix/vacuum 0.17.12 → 0.18.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +29 -2
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -144,7 +144,27 @@ come say hi!
|
|
|
144
144
|
|
|
145
145
|
## Documentation
|
|
146
146
|
|
|
147
|
-
🔥 **New in** `v0.
|
|
147
|
+
🔥 **New in** `v0.18` 🔥 : **New dashboard, new lint command, new rules!**.
|
|
148
|
+
|
|
149
|
+
Upgrades all around. There is a completely new `dashboard` command with a completely new dashboard terminal UI. It's
|
|
150
|
+
completely interactive and allows you to explore, and filter violations, view full docs and see code. The `dashboard` command
|
|
151
|
+
also adds a new `-w` / `--watch` flag that will watch your OpenAPI file for changes and re-lint and re-render results automatically.
|
|
152
|
+
|
|
153
|
+
A re-written `lint` command that has a whole new rendering engine and output. Everything is much more readable,
|
|
154
|
+
easier to see on a screen, matches the new `dashboard` style. It's 100% backwards compatible with previous versions, all flags as they were.
|
|
155
|
+
|
|
156
|
+
New rules:
|
|
157
|
+
|
|
158
|
+
- [no-request-body](https://quobix.com/vacuum/rules/operations/no-request-body/) - Ensures `GET` and `DELETE` operations do not have request bodies.
|
|
159
|
+
- [duplicate-paths](https://quobix.com/vacuum/rules/operations/duplicate-paths/) - Ensures there are no duplicate paths exist
|
|
160
|
+
- [no-unnecessary-combinator](https://quobix.com/vacuum/rules/schemas/no-unnecessary-combinator/) - Ensures no `allOf`, `oneOf` or `anyOf` combinators exist with a single schema inside them.
|
|
161
|
+
- [camel-case-properties](https://quobix.com/vacuum/rules/schemas/camel-case-properties/) - Ensures all schema properties are `camelCase`.
|
|
162
|
+
|
|
163
|
+
---
|
|
164
|
+
|
|
165
|
+
|
|
166
|
+
|
|
167
|
+
`v0.17`: **Github Action**.
|
|
148
168
|
|
|
149
169
|
vacuum now has an official Github Action. [Read the docs](https://quobix.com/vacuum/github-action/), or check it out
|
|
150
170
|
in the [GitHub Marketplace](https://github.com/marketplace/actions/vacuum-openapi-linter-and-quality-analysis-tool).
|
|
@@ -345,7 +365,14 @@ vacuum will work at scale and is designed as a CLI (with a web or console UI) an
|
|
|
345
365
|
vacuum comes with an interactive dashboard (`vacuum dashboard <your-openapi-spec.yaml>`) allowing you to explore
|
|
346
366
|
rules and violations in a console, without having to scroll through thousands of results.
|
|
347
367
|
|
|
348
|
-
|
|
368
|
+
<a href="https://quobix.com/vacuum/commands/dashboard/">
|
|
369
|
+
<picture>
|
|
370
|
+
<source media="(prefers-color-scheme: dark)" srcset=".github/assets/dashboard.gif">
|
|
371
|
+
<img alt="speakeasy'" src=".github/sponsors/speakeasy-github-sponsor-light.svg">
|
|
372
|
+
</picture>
|
|
373
|
+
</a>
|
|
374
|
+
|
|
375
|
+
To read about the dashboard, see the [dashboard command docs](https://quobix.com/vacuum/commands/dashboard/).
|
|
349
376
|
|
|
350
377
|
### HTML Report
|
|
351
378
|
|