@quobix/vacuum 0.20.5 → 0.21.3
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 +22 -7
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -12,7 +12,7 @@
|
|
|
12
12
|
|
|
13
13
|
An **ultra-super-fast**, lightweight OpenAPI linter and quality checking tool, written in golang and inspired by [Spectral](https://github.com/stoplightio/spectral).
|
|
14
14
|
|
|
15
|
-
It's
|
|
15
|
+
It's **fully compatible** with existing [Spectral](https://github.com/stoplightio/spectral) rulesets.
|
|
16
16
|
|
|
17
17
|
## Install using [homebrew](https://brew.sh) tap
|
|
18
18
|
|
|
@@ -133,11 +133,25 @@ come say hi!
|
|
|
133
133
|
|
|
134
134
|
## Documentation
|
|
135
135
|
|
|
136
|
-
🔥 **New in** `v0.
|
|
136
|
+
🔥 **New in** `v0.21` 🔥: **Change detection filtering**
|
|
137
|
+
|
|
138
|
+
Want to see linting results on **just** the changes you have made to an OpenAPI document? Or want to see just the results on the differences between two documents?
|
|
139
|
+
comes with a **what changed** mode. Using the new `--original` and `--changes-summary` global flags, you can filter out all the noise.
|
|
140
|
+
|
|
141
|
+
[documentation for change detection](https://quobix.com/vacuum/commands/change-detection/) is available to learn more.
|
|
142
|
+
|
|
143
|
+
vacuum now supports [JSON Path Plus](https://github.com/JSONPath-Plus/JSONPath) annotations. This means that vacuum is
|
|
144
|
+
compliant with **All Spectral Paths**. One of the last remaining gaps between vacuum and spectral has been closed.
|
|
145
|
+
|
|
146
|
+
[See all the newly supported annotations](https://quobix.com/vacuum/rulesets/custom-rulesets/#anatomy-of-a-rule)
|
|
147
|
+
|
|
148
|
+
---
|
|
149
|
+
|
|
150
|
+
`v0.20`: **Support for auto fixing custom rules**
|
|
137
151
|
|
|
138
152
|
Got some rules that don't really need a human to look at?
|
|
139
153
|
|
|
140
|
-
Well now you can define an `AutoFixFunction` for your rules, and when you run with the `--fix` flag, the fixes will
|
|
154
|
+
Well now you can define an `AutoFixFunction` for your rules, and when you run with the `--fix` flag, the fixes will be applied to the file, or use `--fix-file` to write them to a different file.
|
|
141
155
|
|
|
142
156
|
See [Auto-Fixing Rule Violations](#auto-fixing-rule-violations) for more specifics.
|
|
143
157
|
|
|
@@ -184,10 +198,11 @@ A different way to bundle exploded OpenAPI specifications into a single file. [R
|
|
|
184
198
|
|
|
185
199
|
---
|
|
186
200
|
|
|
201
|
+
`v0.16+` : **RFC 9535 Compliant**.
|
|
187
202
|
|
|
188
|
-
`v0.
|
|
203
|
+
`v0.21+` : **JSON Path Plus Support**.
|
|
189
204
|
|
|
190
|
-
vacuum now
|
|
205
|
+
vacuum now supports both [RFC 9535](https://www.rfc-editor.org/rfc/rfc9535) JSONPath and **JSON Path Plus** extensions - full Spectral compatibility!
|
|
191
206
|
|
|
192
207
|
---
|
|
193
208
|
|
|
@@ -200,8 +215,6 @@ $refs being used in path items.
|
|
|
200
215
|
|
|
201
216
|
---
|
|
202
217
|
|
|
203
|
-
|
|
204
|
-
|
|
205
218
|
### [Quick Start Guide 🚀](https://quobix.com/vacuum/start)
|
|
206
219
|
|
|
207
220
|
See all the documentation at https://quobix.com/vacuum
|
|
@@ -218,6 +231,8 @@ See all the documentation at https://quobix.com/vacuum
|
|
|
218
231
|
- [html-report](https://quobix.com/vacuum/commands/html-report/)
|
|
219
232
|
- [bundle](https://quobix.com/vacuum/commands/bundle/)
|
|
220
233
|
- [spectral-report](https://quobix.com/vacuum/commands/spectral-report/)
|
|
234
|
+
- [language-server](https://quobix.com/vacuum/commands/language-server/)
|
|
235
|
+
- [change-detection](https://quobix.com/vacuum/commands/change-detection/)
|
|
221
236
|
- [Developer API](https://quobix.com/vacuum/api/getting-started/)
|
|
222
237
|
- [Using The Index](https://quobix.com/vacuum/api/spec-index/)
|
|
223
238
|
- [RuleResultSet](https://quobix.com/vacuum/api/rule-resultset/)
|