@quobix/vacuum 0.5.0 → 0.5.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 +31 -4
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -93,7 +93,6 @@ like our _very kind_ sponsors:
|
|
|
93
93
|
[zuplo](https://zuplo.com)
|
|
94
94
|
|
|
95
95
|
|
|
96
|
-
|
|
97
96
|
---
|
|
98
97
|
|
|
99
98
|
## Come chat with us
|
|
@@ -103,8 +102,23 @@ come say hi!
|
|
|
103
102
|
|
|
104
103
|
## Documentation
|
|
105
104
|
|
|
105
|
+
🔥 **New in** `v0.5+` 🔥 : **Multi-file linting** now available for the `lint` command.
|
|
106
|
+
|
|
107
|
+
Want to lint multiple files at once? Now you can!
|
|
108
|
+
|
|
109
|
+
```shell
|
|
110
|
+
vacuum lint file1.json path/to/file2.yaml file3.json`
|
|
111
|
+
```
|
|
112
|
+
|
|
113
|
+
Want to suck in a ton of files? Use a **glob** pattern!
|
|
114
|
+
|
|
115
|
+
```shell
|
|
116
|
+
vacuum lint some/path/**/*.yaml`
|
|
117
|
+
```
|
|
118
|
+
|
|
119
|
+
|
|
106
120
|
---
|
|
107
|
-
|
|
121
|
+
`v0.3+`: [Custom JavaScript Functions](https://quobix.com/vacuum/api/custom-javascript-functions/) are now available out of the box.
|
|
108
122
|
|
|
109
123
|
Write custom functions in JavaScript and use them in any ruleset. No need
|
|
110
124
|
to compile golang code to extend vacuum anymore!
|
|
@@ -113,7 +127,7 @@ to compile golang code to extend vacuum anymore!
|
|
|
113
127
|
|
|
114
128
|
|
|
115
129
|
---
|
|
116
|
-
|
|
130
|
+
`v0.2+`: [OWASP API rules](https://quobix.com/vacuum/rules/owasp/) are now available out of the box.
|
|
117
131
|
|
|
118
132
|
[Learn more about enabling OWASP API rules](https://quobix.com/vacuum/rulesets/owasp/).
|
|
119
133
|
|
|
@@ -163,7 +177,7 @@ See all the documentation at https://quobix.com/vacuum
|
|
|
163
177
|
|
|
164
178
|
---
|
|
165
179
|
|
|
166
|
-
> **vacuum can suck all the lint of a 5mb OpenAPI spec in
|
|
180
|
+
> **vacuum can suck all the lint of a 5mb OpenAPI spec in milliseconds.**
|
|
167
181
|
|
|
168
182
|
Designed to reliably lint OpenAPI specifications, **very, very quickly**. Including _very large_ ones. Spectral can be quite slow
|
|
169
183
|
when used as an API and does not scale for enterprise applications.
|
|
@@ -230,6 +244,19 @@ in your favorite browser and explore the results.
|
|
|
230
244
|
./vacuum lint -d <your-openapi-spec.yaml>
|
|
231
245
|
```
|
|
232
246
|
|
|
247
|
+
|
|
248
|
+
## Lint multiple files at once
|
|
249
|
+
|
|
250
|
+
```
|
|
251
|
+
./vacuum lint -d <spec1.yaml> <spec2.yaml> <spec3.yaml>
|
|
252
|
+
```
|
|
253
|
+
|
|
254
|
+
## Lint multiple files using a glob pattern
|
|
255
|
+
|
|
256
|
+
```
|
|
257
|
+
./vacuum lint -d some/path/**/*.yaml
|
|
258
|
+
```
|
|
259
|
+
|
|
233
260
|
## See full linting report with inline code snippets
|
|
234
261
|
|
|
235
262
|
```
|