@quobix/vacuum 0.33.1 → 0.33.2
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 +14 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -137,6 +137,20 @@ like our _very kind_ sponsors, past and present:
|
|
|
137
137
|
Need help? Have a question? Want to share your work? [Join our discord](https://discord.gg/UAcUF78MQN) and
|
|
138
138
|
come say hi!
|
|
139
139
|
|
|
140
|
+
## Timeout behavior
|
|
141
|
+
|
|
142
|
+
Resolved rule lookups no longer retry against unresolved documents after a timeout or query error.
|
|
143
|
+
This applies to plain linting and dashboard commands, reports, and library callers as well as `--original` comparisons.
|
|
144
|
+
`lint` and `dashboard` return exit code 2 when a lookup or rule execution times out.
|
|
145
|
+
Without `--original`, `vacuum report` records these failures as execution errors; its findings can be incomplete.
|
|
146
|
+
Spectral and HTML output retain their existing formats and can omit findings from failed rules.
|
|
147
|
+
A comparison with `--original` stops with exit code 2 if either lint run fails and does not produce a comparison report.
|
|
148
|
+
Library callers must check `RuleSetExecutionResult.Errors`, including `RuleLookupError` and `RuleTimeoutError`.
|
|
149
|
+
|
|
150
|
+
For large documents, increase `--lookup-timeout` (milliseconds, default 500) if a JSONPath lookup needs more time,
|
|
151
|
+
or `--timeout` (seconds, default 5) if the complete rule needs more time. The rule budget must also allow the lookup to finish.
|
|
152
|
+
A timeout is an incomplete check, not evidence that the document is clean.
|
|
153
|
+
|
|
140
154
|
## Documentation
|
|
141
155
|
|
|
142
156
|
🔥 **New in** `v0.33` 🔥: **Arazzo workflow linting and a new `or` function**
|