micro-contracts 0.17.17 → 0.17.19
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 -3
- package/cli-contract.yaml +1 -1
- package/dist/micro-contracts.bundle.mjs +243 -243
- package/dist/micro-contracts.bundle.mjs.map +3 -3
- package/docs/cli-reference.md +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -209,9 +209,12 @@ project/
|
|
|
209
209
|
| `x-micro-contracts-depend-on` | string[] | Explicit dependencies on other modules' published APIs |
|
|
210
210
|
| `x-private` | boolean | Schema-level. A published endpoint that can reach it fails linting (`PUBLIC_ENDPOINT_PRIVATE_RESPONSE`) |
|
|
211
211
|
|
|
212
|
-
"Can reach it" covers every way one schema refers to another
|
|
213
|
-
items, `additionalProperties`, `allOf`/`oneOf`/`anyOf`,
|
|
214
|
-
|
|
212
|
+
"Can reach it" covers every way one schema refers to another (properties, array
|
|
213
|
+
items, `additionalProperties`, `allOf`/`oneOf`/`anyOf`, `$ref` targets) and every
|
|
214
|
+
part of an operation that reaches a schema: request bodies, parameters and
|
|
215
|
+
responses of any status code, including through `components.requestBodies`,
|
|
216
|
+
`components.parameters` and `components.responses`. `contract-published` contains
|
|
217
|
+
exactly what that same reachability finds, so nothing can ship unchecked.
|
|
215
218
|
|
|
216
219
|
### Screen Spec Extensions
|
|
217
220
|
|
|
@@ -388,6 +391,10 @@ Generate code from OpenAPI specifications.
|
|
|
388
391
|
| `--force` | Bypass input hash cache and always regenerate |
|
|
389
392
|
| `--no-cache` | Run without reading or writing input hash cache |
|
|
390
393
|
|
|
394
|
+
A run that generates a subset (`--output`, `--module`, or any `--*-only`) does not
|
|
395
|
+
record the input hash, so the next full run regenerates rather than reporting no
|
|
396
|
+
changes.
|
|
397
|
+
|
|
391
398
|
### init \<module\>
|
|
392
399
|
|
|
393
400
|
Initialize a new module structure with starter templates.
|
|
@@ -455,6 +462,10 @@ Run full guardrails pipeline: **Gate 1,2 → Generate → Gate 3,4,5**.
|
|
|
455
462
|
| `--force` | Bypass input hash cache and always regenerate |
|
|
456
463
|
| `--no-cache` | Run without reading or writing input hash cache |
|
|
457
464
|
|
|
465
|
+
A run that generates a subset (`--output`, `--module`, or any `--*-only`) does not
|
|
466
|
+
record the input hash, so the next full run regenerates rather than reporting no
|
|
467
|
+
changes.
|
|
468
|
+
|
|
458
469
|
> See **[Enforceable Guardrails](docs/development-guardrails.md)** for gate details and CI configuration.
|
|
459
470
|
|
|
460
471
|
### deps
|
package/cli-contract.yaml
CHANGED