@quobix/vacuum 0.20.0 → 0.20.1
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 +1 -112
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -181,8 +181,6 @@ New rules:
|
|
|
181
181
|
|
|
182
182
|
---
|
|
183
183
|
|
|
184
|
-
|
|
185
|
-
|
|
186
184
|
`v0.17`: **Github Action**.
|
|
187
185
|
|
|
188
186
|
vacuum now has an official Github Action. [Read the docs](https://quobix.com/vacuum/github-action/), or check it out
|
|
@@ -213,116 +211,7 @@ $refs being used in path items.
|
|
|
213
211
|
|
|
214
212
|
---
|
|
215
213
|
|
|
216
|
-
`v0.14+`: **Engine Speedup**.
|
|
217
|
-
|
|
218
|
-
**Speed!** We've made some significant improvements to how efficiently large documents are walked
|
|
219
|
-
Which means vacuum is now faster than ever.
|
|
220
|
-
|
|
221
|
-
---
|
|
222
|
-
|
|
223
|
-
`v0.12+` : Core functions support JSON Path.
|
|
224
|
-
|
|
225
|
-
Now all **core** functions return the **correct and accurate JSON path for each linting result**. Previously this was not possible
|
|
226
|
-
at all, but with some clever engineering, we have made it happen. It's a small thing, but with huge impact.
|
|
227
|
-
|
|
228
|
-
This feature has been available on the OpenAPI functions for some time, however core functions were without a comparison.
|
|
229
|
-
But no more! core functions have joined the party.
|
|
230
|
-
|
|
231
|
-
A new `--no-clip` flag is available on the `lint` command. This prevents message/path truncation.
|
|
232
|
-
|
|
233
|
-
---
|
|
234
|
-
|
|
235
|
-
`v0.11+`: Ignore Linting Errors/Violations.
|
|
236
|
-
|
|
237
|
-
v0.11 introduces the ability to ignore specific linting errors. This is useful for when you want to implement new
|
|
238
|
-
rules to existing production APIs. In some cases, correcting the lint errors would result in a breaking change.
|
|
239
|
-
|
|
240
|
-
Having a way to ignore these errors allows you to implement the new rules for new APIs while maintaining
|
|
241
|
-
backwards compatibility for existing ones.
|
|
242
|
-
|
|
243
|
-
[Learn more about ignoring violations](https://quobix.com/vacuum/ignoring/)
|
|
244
|
-
|
|
245
|
-
---
|
|
246
|
-
|
|
247
|
-
`v0.10+` : **Quality release**.
|
|
248
|
-
|
|
249
|
-
v0.10 is a quality release, with a number of fixes and improvements to rule schemas, function names and more.
|
|
250
|
-
vacuum now powers [The OpenAPI doctor](https://pb33f.io/doctor/). To enable correct ruleset management and automation
|
|
251
|
-
a number of functions have been renamed, interfaces have been upgraded and rule functions schemas are now accurate.
|
|
252
|
-
|
|
253
|
-
This is a breaking change for anyone using vacuum as a library with custom rules.
|
|
254
|
-
|
|
255
|
-
---
|
|
256
|
-
|
|
257
|
-
`v0.9+` : **Built in Language Server**.
|
|
258
|
-
|
|
259
|
-
A new command is available `language-server`. This starts vacuum as an LSP compatible language server. Run vacuum
|
|
260
|
-
in your favorite IDE and get linting and validation as you type, in realtime.
|
|
261
|
-
|
|
262
|
-
Will support any LSP compatible editor, like VSCode, Sublime, vim, etc.
|
|
263
|
-
|
|
264
|
-
[Install the VSCode extension](https://marketplace.visualstudio.com/items?itemName=pb33f.vacuum)
|
|
265
|
-
[Learn more about the language-server command](https://quobix.com/vacuum/commands/language-server/)
|
|
266
|
-
|
|
267
|
-
---
|
|
268
|
-
|
|
269
|
-
`v0.8+` : **OpenAPI Bundler**.
|
|
270
|
-
|
|
271
|
-
A new command is available `bundle` will bundle all external references for an OpenAPI file into a single file.
|
|
272
|
-
|
|
273
|
-
[Learn more about the bundle command](https://quobix.com/vacuum/commands/bundle/)
|
|
274
214
|
|
|
275
|
-
A new linting rule is available `oas-schema-check` will perform type checks and validation on all schemas in your
|
|
276
|
-
OpenAPI file. It's enabled by default in the recommended ruleset.
|
|
277
|
-
|
|
278
|
-
[oas-schema-check rule docs](https://quobix.com/vacuum/rules/schemas/oas-schema-check/)
|
|
279
|
-
|
|
280
|
-
---
|
|
281
|
-
|
|
282
|
-
`v0.7+` : **Hard Mode**.
|
|
283
|
-
|
|
284
|
-
Want to lint your spec with the most strict ruleset possible? Now you can! Use the `-z` / `--hard-mode` flag to enable
|
|
285
|
-
|
|
286
|
-
---
|
|
287
|
-
|
|
288
|
-
`v0.6+` : **Sharable / distributed rulesets** now available.
|
|
289
|
-
|
|
290
|
-
Want to share / extend / distribute your own rulesets? Now you can!
|
|
291
|
-
|
|
292
|
-
[Learn more about sharable rulesets](https://quobix.com/vacuum/rulesets/sharing/)
|
|
293
|
-
|
|
294
|
-
---
|
|
295
|
-
|
|
296
|
-
`v0.5+` : **Multi-file linting** now available for the `lint` command.
|
|
297
|
-
|
|
298
|
-
Want to lint multiple files at once? Now you can!
|
|
299
|
-
|
|
300
|
-
```shell
|
|
301
|
-
vacuum lint file1.json path/to/file2.yaml file3.json
|
|
302
|
-
```
|
|
303
|
-
|
|
304
|
-
Want to suck in a ton of files? Use a **glob** pattern!
|
|
305
|
-
|
|
306
|
-
```shell
|
|
307
|
-
vacuum lint some/path/**/*.yaml
|
|
308
|
-
```
|
|
309
|
-
|
|
310
|
-
|
|
311
|
-
---
|
|
312
|
-
`v0.3+`: [Custom JavaScript Functions](https://quobix.com/vacuum/api/custom-javascript-functions/) are now available out of the box.
|
|
313
|
-
|
|
314
|
-
Write custom functions in JavaScript and use them in any ruleset. No need
|
|
315
|
-
to compile golang code to extend vacuum anymore!
|
|
316
|
-
|
|
317
|
-
[Learn more about building custom JavaScript functions](https://quobix.com/vacuum/api/custom-javascript-functions/).
|
|
318
|
-
|
|
319
|
-
|
|
320
|
-
---
|
|
321
|
-
`v0.2+`: [OWASP API rules](https://quobix.com/vacuum/rules/owasp/) are now available out of the box.
|
|
322
|
-
|
|
323
|
-
[Learn more about enabling OWASP API rules](https://quobix.com/vacuum/rulesets/owasp/).
|
|
324
|
-
|
|
325
|
-
---
|
|
326
215
|
|
|
327
216
|
### [Quick Start Guide 🚀](https://quobix.com/vacuum/start)
|
|
328
217
|
|
|
@@ -375,7 +264,7 @@ See all the documentation at https://quobix.com/vacuum
|
|
|
375
264
|
Designed to reliably lint OpenAPI specifications, **very, very quickly**. Including _very large_ ones. Spectral can be quite slow
|
|
376
265
|
when used as an API and does not scale for enterprise applications.
|
|
377
266
|
|
|
378
|
-
vacuum will tell you what is wrong with your spec, why, where and how to fix it.
|
|
267
|
+
vacuum will tell you what is wrong with your spec, why, where, and how to fix it.
|
|
379
268
|
|
|
380
269
|
vacuum will work at scale and is designed as a CLI (with a web or console UI) and a library to be consumed in other applications.
|
|
381
270
|
|