@quobix/vacuum 0.31.0 → 0.32.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
|
@@ -226,6 +226,28 @@ target exactly what we want to change. vacuum now supports a new `apply-overlay`
|
|
|
226
226
|
|
|
227
227
|
- [Learn more about the apply-overlay command](https://quobix.com/vacuum/commands/apply-overlay)
|
|
228
228
|
|
|
229
|
+
`apply-overlay` can also build a fail-closed publication document after applying
|
|
230
|
+
the standard Overlay actions:
|
|
231
|
+
|
|
232
|
+
```bash
|
|
233
|
+
vacuum apply-overlay internal.yaml public.overlay.yaml public.yaml \
|
|
234
|
+
--include-tag public \
|
|
235
|
+
--tag-match any \
|
|
236
|
+
--prune-unused
|
|
237
|
+
```
|
|
238
|
+
|
|
239
|
+
Inclusive tags are exact and case-sensitive; `any` keeps operations with at
|
|
240
|
+
least one included tag and `all` requires every included tag. Untagged
|
|
241
|
+
operations are removed. Filtering runs after Overlay actions and before
|
|
242
|
+
reachability-based component pruning. These opt-in transforms require a
|
|
243
|
+
bundled, self-contained OpenAPI document. Top-level Tag Objects are retained.
|
|
244
|
+
YAML aliases and merge keys are expanded when filtering. Retained mapping
|
|
245
|
+
order, comments, and scalar styles are preserved. Pruning rejects schema
|
|
246
|
+
`$id` scopes that cannot be resolved safely. Link Objects targeting filtered
|
|
247
|
+
operations are retained and reported as warnings. Document output remains
|
|
248
|
+
pure on stdout; warnings are written to stderr. The warning summary uses the `apply-overlay produced` prefix to
|
|
249
|
+
cover both Overlay actions and publication transforms.
|
|
250
|
+
|
|
229
251
|
---
|
|
230
252
|
|
|
231
253
|
|
|
@@ -623,9 +645,14 @@ lint:
|
|
|
623
645
|
|
|
624
646
|
### Environment variables
|
|
625
647
|
|
|
626
|
-
You can configure global
|
|
648
|
+
You can configure global and command-local flags with `VACUUM_<FLAG>`
|
|
649
|
+
environment variables. Use uppercase flag names and replace `-` with `_`.
|
|
650
|
+
Explicit command-line flags take precedence over environment variables;
|
|
651
|
+
environment variables take precedence over configuration files.
|
|
627
652
|
|
|
628
|
-
|
|
653
|
+
Collection flags accept comma-separated values. For example,
|
|
654
|
+
`VACUUM_INCLUDE_TAG='public,partner'` sets the included tags for
|
|
655
|
+
`apply-overlay`.
|
|
629
656
|
|
|
630
657
|
|
|
631
658
|
## Auto-fixing rule violations
|