@maverickcer/env-cap 0.7.4 → 0.7.6
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/ADOPTION.md +106 -124
- package/AGENTS.md +94 -128
- package/CHANGELOG.md +42 -0
- package/CODE_REVIEW.md +69 -173
- package/CONTRIBUTING.md +57 -74
- package/GUIDE.md +405 -866
- package/README.md +112 -89
- package/RELEASING.md +81 -65
- package/SECURITY.md +76 -227
- package/SUPPORT.md +21 -45
- package/VERSIONING.md +69 -105
- package/benchmarks/READING-BENCHMARKS.md +103 -81
- package/benchmarks/README.md +12 -9
- package/benchmarks/WRITING-BENCHMARKS.md +90 -80
- package/benchmarks/performance-buildtime/BENCHMARKS.md +20 -20
- package/benchmarks/performance-runtime/BENCHMARKS.md +107 -107
- package/dist/.dts/_ipc/build-fs.d.ts +12 -17
- package/dist/.dts/_ipc/build-fs.d.ts.map +1 -1
- package/dist/.dts/_ipc/compiler-api.d.ts +6 -6
- package/dist/.dts/_ipc/display-path.d.ts +1 -1
- package/dist/.dts/_ipc/display-path.d.ts.map +1 -1
- package/dist/.dts/_ipc/generated-banner.d.ts +8 -8
- package/dist/.dts/_ipc/glob.d.ts +9 -8
- package/dist/.dts/_ipc/glob.d.ts.map +1 -1
- package/dist/.dts/_ipc/no-node-fs.d.ts +2 -2
- package/dist/.dts/_ipc/no-node-fs.d.ts.map +1 -1
- package/dist/.dts/_ipc/resolve-tsconfig-paths.d.ts +16 -16
- package/dist/.dts/_ipc/resolve-tsconfig-paths.d.ts.map +1 -1
- package/dist/.dts/_ipc/typescript.d.ts +4 -4
- package/dist/.dts/build/assemble-project.d.ts +14 -15
- package/dist/.dts/build/assemble-project.d.ts.map +1 -1
- package/dist/.dts/build/change-model.d.ts +14 -14
- package/dist/.dts/build/change-model.d.ts.map +1 -1
- package/dist/.dts/build/check-artifacts.d.ts +4 -4
- package/dist/.dts/build/check-artifacts.d.ts.map +1 -1
- package/dist/.dts/build/citation-verification.d.ts +13 -14
- package/dist/.dts/build/citation-verification.d.ts.map +1 -1
- package/dist/.dts/build/compatibility.d.ts +24 -24
- package/dist/.dts/build/compatibility.d.ts.map +1 -1
- package/dist/.dts/build/contract-model.d.ts +10 -10
- package/dist/.dts/build/contract-model.d.ts.map +1 -1
- package/dist/.dts/build/deep-equal.d.ts +2 -2
- package/dist/.dts/build/deep-freeze.d.ts +2 -2
- package/dist/.dts/build/dependency-graph.d.ts +48 -55
- package/dist/.dts/build/dependency-graph.d.ts.map +1 -1
- package/dist/.dts/build/dependency-model.d.ts +18 -18
- package/dist/.dts/build/dependency-model.d.ts.map +1 -1
- package/dist/.dts/build/discover.d.ts +11 -11
- package/dist/.dts/build/discover.d.ts.map +1 -1
- package/dist/.dts/build/docs.d.ts +34 -38
- package/dist/.dts/build/docs.d.ts.map +1 -1
- package/dist/.dts/build/env-example.d.ts +13 -13
- package/dist/.dts/build/env-example.d.ts.map +1 -1
- package/dist/.dts/build/errors.d.ts +8 -8
- package/dist/.dts/build/evidence-cache.d.ts +23 -23
- package/dist/.dts/build/evidence-cache.d.ts.map +1 -1
- package/dist/.dts/build/evidence-model.d.ts +3 -3
- package/dist/.dts/build/evidence-reference.d.ts +15 -15
- package/dist/.dts/build/evidence-reference.d.ts.map +1 -1
- package/dist/.dts/build/evidence-snapshot.d.ts +47 -53
- package/dist/.dts/build/evidence-snapshot.d.ts.map +1 -1
- package/dist/.dts/build/exclusive-group.d.ts +4 -4
- package/dist/.dts/build/exclusive-group.d.ts.map +1 -1
- package/dist/.dts/build/finding-model.d.ts +12 -12
- package/dist/.dts/build/finding-model.d.ts.map +1 -1
- package/dist/.dts/build/generate-documentation.d.ts +19 -19
- package/dist/.dts/build/generate-documentation.d.ts.map +1 -1
- package/dist/.dts/build/generate-env-artifacts.d.ts +43 -43
- package/dist/.dts/build/generate-env-artifacts.d.ts.map +1 -1
- package/dist/.dts/build/generate-evidence.d.ts +19 -19
- package/dist/.dts/build/generate-evidence.d.ts.map +1 -1
- package/dist/.dts/build/generate-manifest.d.ts +11 -12
- package/dist/.dts/build/generate-manifest.d.ts.map +1 -1
- package/dist/.dts/build/generate-usage.d.ts +23 -24
- package/dist/.dts/build/generate-usage.d.ts.map +1 -1
- package/dist/.dts/build/generated-banner.d.ts +5 -5
- package/dist/.dts/build/governance-fields.d.ts +7 -7
- package/dist/.dts/build/humanize-key.d.ts +1 -1
- package/dist/.dts/build/humanize-key.d.ts.map +1 -1
- package/dist/.dts/build/index.d.ts +20 -36
- package/dist/.dts/build/index.d.ts.map +1 -1
- package/dist/.dts/build/lifecycle-model.d.ts +90 -83
- package/dist/.dts/build/lifecycle-model.d.ts.map +1 -1
- package/dist/.dts/build/link.d.ts +38 -39
- package/dist/.dts/build/link.d.ts.map +1 -1
- package/dist/.dts/build/literal-eval.d.ts +2 -2
- package/dist/.dts/build/literal-eval.d.ts.map +1 -1
- package/dist/.dts/build/live-expirations.d.ts +14 -13
- package/dist/.dts/build/live-expirations.d.ts.map +1 -1
- package/dist/.dts/build/manifest.d.ts +6 -6
- package/dist/.dts/build/map-utils.d.ts +4 -4
- package/dist/.dts/build/merge-documentation.d.ts +9 -8
- package/dist/.dts/build/merge-documentation.d.ts.map +1 -1
- package/dist/.dts/build/ownership-model.d.ts +14 -15
- package/dist/.dts/build/ownership-model.d.ts.map +1 -1
- package/dist/.dts/build/parse.d.ts +20 -21
- package/dist/.dts/build/parse.d.ts.map +1 -1
- package/dist/.dts/build/reference-projections.d.ts +36 -38
- package/dist/.dts/build/reference-projections.d.ts.map +1 -1
- package/dist/.dts/build/resolution/resolve-import.d.ts +18 -14
- package/dist/.dts/build/resolution/resolve-import.d.ts.map +1 -1
- package/dist/.dts/build/resolution/resolve-package-schema.d.ts +26 -26
- package/dist/.dts/build/resolution/resolve-package-schema.d.ts.map +1 -1
- package/dist/.dts/build/resolution/resolve-within-root.d.ts +9 -9
- package/dist/.dts/build/sarif.d.ts +5 -5
- package/dist/.dts/build/sarif.d.ts.map +1 -1
- package/dist/.dts/build/scan-dependencies.d.ts +17 -16
- package/dist/.dts/build/scan-dependencies.d.ts.map +1 -1
- package/dist/.dts/build/sort-by-identity.d.ts +1 -1
- package/dist/.dts/build/source-position.d.ts +13 -13
- package/dist/.dts/build/tool-version.d.ts +1 -1
- package/dist/.dts/build/usage-report.d.ts +19 -19
- package/dist/.dts/build/usage-report.d.ts.map +1 -1
- package/dist/.dts/eslint-plugin/index.d.ts +16 -5
- package/dist/.dts/eslint-plugin/index.d.ts.map +1 -1
- package/dist/.dts/eslint-plugin/no-raw-process-env.d.ts +4 -4
- package/dist/.dts/evidence/define-projection.d.ts +15 -16
- package/dist/.dts/evidence/define-projection.d.ts.map +1 -1
- package/dist/.dts/evidence/index.d.ts +11 -15
- package/dist/.dts/evidence/index.d.ts.map +1 -1
- package/dist/.dts/helpers/index.d.ts +15 -18
- package/dist/.dts/helpers/index.d.ts.map +1 -1
- package/dist/.dts/helpers/validators.d.ts +2 -2
- package/dist/.dts/helpers/validators.d.ts.map +1 -1
- package/dist/.dts/node/index.d.ts +19 -0
- package/dist/.dts/node/index.d.ts.map +1 -1
- package/dist/.dts/runtime/create.d.ts +6 -3
- package/dist/.dts/runtime/create.d.ts.map +1 -1
- package/dist/.dts/runtime/document.d.ts +91 -97
- package/dist/.dts/runtime/document.d.ts.map +1 -1
- package/dist/.dts/runtime/errors.d.ts +5 -5
- package/dist/.dts/runtime/index.d.ts +11 -10
- package/dist/.dts/runtime/index.d.ts.map +1 -1
- package/dist/.dts/runtime/reset.d.ts +1 -1
- package/dist/.dts/runtime/types.d.ts +39 -24
- package/dist/.dts/runtime/types.d.ts.map +1 -1
- package/dist/.dts/runtime/validate.d.ts +15 -2
- package/dist/.dts/runtime/validate.d.ts.map +1 -1
- package/dist/.dts7/_ipc/build-fs.d.ts +48 -0
- package/dist/.dts7/_ipc/build-fs.d.ts.map +1 -0
- package/dist/.dts7/_ipc/compiler-api.d.ts +17 -0
- package/dist/.dts7/_ipc/compiler-api.d.ts.map +1 -0
- package/dist/.dts7/_ipc/display-path.d.ts +27 -0
- package/dist/.dts7/_ipc/display-path.d.ts.map +1 -0
- package/dist/.dts7/_ipc/generated-banner.d.ts +58 -0
- package/dist/.dts7/_ipc/generated-banner.d.ts.map +1 -0
- package/dist/.dts7/_ipc/glob.d.ts +23 -0
- package/dist/.dts7/_ipc/glob.d.ts.map +1 -0
- package/dist/.dts7/_ipc/no-node-fs.d.ts +21 -0
- package/dist/.dts7/_ipc/no-node-fs.d.ts.map +1 -0
- package/dist/.dts7/_ipc/resolve-tsconfig-paths.d.ts +134 -0
- package/dist/.dts7/_ipc/resolve-tsconfig-paths.d.ts.map +1 -0
- package/dist/.dts7/_ipc/typescript.d.ts +20 -0
- package/dist/.dts7/_ipc/typescript.d.ts.map +1 -0
- package/dist/.dts7/build/assemble-project.d.ts +46 -0
- package/dist/.dts7/build/assemble-project.d.ts.map +1 -0
- package/dist/.dts7/build/change-model.d.ts +63 -0
- package/dist/.dts7/build/change-model.d.ts.map +1 -0
- package/dist/.dts7/build/check-artifacts.d.ts +48 -0
- package/dist/.dts7/build/check-artifacts.d.ts.map +1 -0
- package/dist/.dts7/build/citation-verification.d.ts +61 -0
- package/dist/.dts7/build/citation-verification.d.ts.map +1 -0
- package/dist/.dts7/build/compatibility.d.ts +83 -0
- package/dist/.dts7/build/compatibility.d.ts.map +1 -0
- package/dist/.dts7/build/compiler-api.d.ts +12 -0
- package/dist/.dts7/build/compiler-api.d.ts.map +1 -0
- package/dist/.dts7/build/contract-model.d.ts +93 -0
- package/dist/.dts7/build/contract-model.d.ts.map +1 -0
- package/dist/.dts7/build/deep-equal.d.ts +9 -0
- package/dist/.dts7/build/deep-equal.d.ts.map +1 -0
- package/dist/.dts7/build/deep-freeze.d.ts +20 -0
- package/dist/.dts7/build/deep-freeze.d.ts.map +1 -0
- package/dist/.dts7/build/dependency-graph.d.ts +163 -0
- package/dist/.dts7/build/dependency-graph.d.ts.map +1 -0
- package/dist/.dts7/build/dependency-model.d.ts +81 -0
- package/dist/.dts7/build/dependency-model.d.ts.map +1 -0
- package/dist/.dts7/build/discover.d.ts +41 -0
- package/dist/.dts7/build/discover.d.ts.map +1 -0
- package/dist/.dts7/build/display-path.d.ts +6 -0
- package/dist/.dts7/build/display-path.d.ts.map +1 -0
- package/dist/.dts7/build/docs.d.ts +172 -0
- package/dist/.dts7/build/docs.d.ts.map +1 -0
- package/dist/.dts7/build/env-example.d.ts +85 -0
- package/dist/.dts7/build/env-example.d.ts.map +1 -0
- package/dist/.dts7/build/errors.d.ts +78 -0
- package/dist/.dts7/build/errors.d.ts.map +1 -0
- package/dist/.dts7/build/evidence-cache.d.ts +74 -0
- package/dist/.dts7/build/evidence-cache.d.ts.map +1 -0
- package/dist/.dts7/build/evidence-model.d.ts +50 -0
- package/dist/.dts7/build/evidence-model.d.ts.map +1 -0
- package/dist/.dts7/build/evidence-reference.d.ts +67 -0
- package/dist/.dts7/build/evidence-reference.d.ts.map +1 -0
- package/dist/.dts7/build/evidence-snapshot.d.ts +142 -0
- package/dist/.dts7/build/evidence-snapshot.d.ts.map +1 -0
- package/dist/.dts7/build/exclusive-group.d.ts +19 -0
- package/dist/.dts7/build/exclusive-group.d.ts.map +1 -0
- package/dist/.dts7/build/finding-model.d.ts +80 -0
- package/dist/.dts7/build/finding-model.d.ts.map +1 -0
- package/dist/.dts7/build/generate-documentation.d.ts +176 -0
- package/dist/.dts7/build/generate-documentation.d.ts.map +1 -0
- package/dist/.dts7/build/generate-env-artifacts.d.ts +191 -0
- package/dist/.dts7/build/generate-env-artifacts.d.ts.map +1 -0
- package/dist/.dts7/build/generate-evidence.d.ts +77 -0
- package/dist/.dts7/build/generate-evidence.d.ts.map +1 -0
- package/dist/.dts7/build/generate-manifest.d.ts +100 -0
- package/dist/.dts7/build/generate-manifest.d.ts.map +1 -0
- package/dist/.dts7/build/generate-usage.d.ts +94 -0
- package/dist/.dts7/build/generate-usage.d.ts.map +1 -0
- package/dist/.dts7/build/generated-banner.d.ts +43 -0
- package/dist/.dts7/build/generated-banner.d.ts.map +1 -0
- package/dist/.dts7/build/glob.d.ts +6 -0
- package/dist/.dts7/build/glob.d.ts.map +1 -0
- package/dist/.dts7/build/governance-fields.d.ts +34 -0
- package/dist/.dts7/build/governance-fields.d.ts.map +1 -0
- package/dist/.dts7/build/humanize-key.d.ts +14 -0
- package/dist/.dts7/build/humanize-key.d.ts.map +1 -0
- package/dist/.dts7/build/index.d.ts +89 -0
- package/dist/.dts7/build/index.d.ts.map +1 -0
- package/dist/.dts7/build/lifecycle-model.d.ts +181 -0
- package/dist/.dts7/build/lifecycle-model.d.ts.map +1 -0
- package/dist/.dts7/build/link.d.ts +222 -0
- package/dist/.dts7/build/link.d.ts.map +1 -0
- package/dist/.dts7/build/literal-eval.d.ts +24 -0
- package/dist/.dts7/build/literal-eval.d.ts.map +1 -0
- package/dist/.dts7/build/live-expirations.d.ts +48 -0
- package/dist/.dts7/build/live-expirations.d.ts.map +1 -0
- package/dist/.dts7/build/manifest.d.ts +31 -0
- package/dist/.dts7/build/manifest.d.ts.map +1 -0
- package/dist/.dts7/build/map-utils.d.ts +8 -0
- package/dist/.dts7/build/map-utils.d.ts.map +1 -0
- package/dist/.dts7/build/merge-documentation.d.ts +36 -0
- package/dist/.dts7/build/merge-documentation.d.ts.map +1 -0
- package/dist/.dts7/build/ownership-model.d.ts +58 -0
- package/dist/.dts7/build/ownership-model.d.ts.map +1 -0
- package/dist/.dts7/build/parse.d.ts +206 -0
- package/dist/.dts7/build/parse.d.ts.map +1 -0
- package/dist/.dts7/build/reference-projections.d.ts +168 -0
- package/dist/.dts7/build/reference-projections.d.ts.map +1 -0
- package/dist/.dts7/build/resolution/resolve-import.d.ts +62 -0
- package/dist/.dts7/build/resolution/resolve-import.d.ts.map +1 -0
- package/dist/.dts7/build/resolution/resolve-package-schema.d.ts +83 -0
- package/dist/.dts7/build/resolution/resolve-package-schema.d.ts.map +1 -0
- package/dist/.dts7/build/resolution/resolve-tsconfig-paths.d.ts +18 -0
- package/dist/.dts7/build/resolution/resolve-tsconfig-paths.d.ts.map +1 -0
- package/dist/.dts7/build/resolution/resolve-within-root.d.ts +35 -0
- package/dist/.dts7/build/resolution/resolve-within-root.d.ts.map +1 -0
- package/dist/.dts7/build/sarif.d.ts +66 -0
- package/dist/.dts7/build/sarif.d.ts.map +1 -0
- package/dist/.dts7/build/scan-dependencies.d.ts +71 -0
- package/dist/.dts7/build/scan-dependencies.d.ts.map +1 -0
- package/dist/.dts7/build/sort-by-identity.d.ts +14 -0
- package/dist/.dts7/build/sort-by-identity.d.ts.map +1 -0
- package/dist/.dts7/build/source-position.d.ts +69 -0
- package/dist/.dts7/build/source-position.d.ts.map +1 -0
- package/dist/.dts7/build/tool-version.d.ts +8 -0
- package/dist/.dts7/build/tool-version.d.ts.map +1 -0
- package/dist/.dts7/build/types.d.ts +7 -0
- package/dist/.dts7/build/types.d.ts.map +1 -0
- package/dist/.dts7/build/typescript.d.ts +6 -0
- package/dist/.dts7/build/typescript.d.ts.map +1 -0
- package/dist/.dts7/build/usage-report.d.ts +124 -0
- package/dist/.dts7/build/usage-report.d.ts.map +1 -0
- package/dist/.dts7/cli/filesystem.d.ts +7 -0
- package/dist/.dts7/cli/filesystem.d.ts.map +1 -0
- package/dist/.dts7/eslint-plugin/glob.d.ts +7 -0
- package/dist/.dts7/eslint-plugin/glob.d.ts.map +1 -0
- package/dist/.dts7/eslint-plugin/index.d.ts +38 -0
- package/dist/.dts7/eslint-plugin/index.d.ts.map +1 -0
- package/dist/.dts7/eslint-plugin/no-node-fs.d.ts +15 -0
- package/dist/.dts7/eslint-plugin/no-node-fs.d.ts.map +1 -0
- package/dist/.dts7/eslint-plugin/no-raw-process-env.d.ts +23 -0
- package/dist/.dts7/eslint-plugin/no-raw-process-env.d.ts.map +1 -0
- package/dist/.dts7/evidence/define-projection.d.ts +51 -0
- package/dist/.dts7/evidence/define-projection.d.ts.map +1 -0
- package/dist/.dts7/evidence/index.d.ts +19 -0
- package/dist/.dts7/evidence/index.d.ts.map +1 -0
- package/dist/.dts7/helpers/index.d.ts +132 -0
- package/dist/.dts7/helpers/index.d.ts.map +1 -0
- package/dist/.dts7/helpers/processors.d.ts +32 -0
- package/dist/.dts7/helpers/processors.d.ts.map +1 -0
- package/dist/.dts7/helpers/validators.d.ts +68 -0
- package/dist/.dts7/helpers/validators.d.ts.map +1 -0
- package/dist/.dts7/node/index.d.ts +21 -0
- package/dist/.dts7/node/index.d.ts.map +1 -0
- package/dist/.dts7/runtime/cache.d.ts +17 -0
- package/dist/.dts7/runtime/cache.d.ts.map +1 -0
- package/dist/.dts7/runtime/create.d.ts +23 -0
- package/dist/.dts7/runtime/create.d.ts.map +1 -0
- package/dist/.dts7/runtime/document.d.ts +214 -0
- package/dist/.dts7/runtime/document.d.ts.map +1 -0
- package/dist/.dts7/runtime/errors.d.ts +55 -0
- package/dist/.dts7/runtime/errors.d.ts.map +1 -0
- package/dist/.dts7/runtime/index.d.ts +25 -0
- package/dist/.dts7/runtime/index.d.ts.map +1 -0
- package/dist/.dts7/runtime/registry.d.ts +12 -0
- package/dist/.dts7/runtime/registry.d.ts.map +1 -0
- package/dist/.dts7/runtime/reset.d.ts +8 -0
- package/dist/.dts7/runtime/reset.d.ts.map +1 -0
- package/dist/.dts7/runtime/types.d.ts +190 -0
- package/dist/.dts7/runtime/types.d.ts.map +1 -0
- package/dist/.dts7/runtime/validate.d.ts +27 -0
- package/dist/.dts7/runtime/validate.d.ts.map +1 -0
- package/dist/{build-6XFHJFQK.js → build-UEENZEUX.js} +43 -42
- package/dist/build-UEENZEUX.js.map +1 -0
- package/dist/build.cjs +42 -41
- package/dist/build.cjs.map +1 -1
- package/dist/build.js +42 -41
- package/dist/build.js.map +1 -1
- package/dist/build.ts7.d.cts +1 -0
- package/dist/build.ts7.d.ts +1 -0
- package/dist/{chunk-RL5KFVUT.js → chunk-TBL3O7IG.js} +2 -2
- package/dist/cli/index.js +29 -28
- package/dist/cli/index.js.map +1 -1
- package/dist/eslint-plugin/index.cjs.map +1 -1
- package/dist/eslint-plugin/index.js.map +1 -1
- package/dist/eslint-plugin/index.ts7.d.cts +1 -0
- package/dist/eslint-plugin/index.ts7.d.ts +1 -0
- package/dist/evidence.cjs +1 -1
- package/dist/evidence.cjs.map +1 -1
- package/dist/evidence.js +1 -1
- package/dist/evidence.js.map +1 -1
- package/dist/evidence.ts7.d.cts +1 -0
- package/dist/evidence.ts7.d.ts +1 -0
- package/dist/helpers.cjs +4 -4
- package/dist/helpers.cjs.map +1 -1
- package/dist/helpers.js +4 -4
- package/dist/helpers.js.map +1 -1
- package/dist/helpers.ts7.d.cts +1 -0
- package/dist/helpers.ts7.d.ts +1 -0
- package/dist/index.cjs.map +1 -1
- package/dist/index.js.map +1 -1
- package/dist/index.ts7.d.cts +1 -0
- package/dist/index.ts7.d.ts +1 -0
- package/dist/node.ts7.d.cts +1 -0
- package/dist/node.ts7.d.ts +1 -0
- package/examples/README.md +46 -80
- package/package.json +43 -12
- package/schemas/contract-model.schema.json +7 -7
- package/schemas/env-cap-report.schema.json +88 -88
- package/skills/env-cap/SKILL.md +12 -13
- package/skills/env-cap/references/api.md +1 -1
- package/specs/architecture.md +147 -122
- package/specs/decisions/0001-runtime-documentation-separation.md +1 -1
- package/specs/decisions/0014-cross-package-schema-discovery.md +4 -1
- package/specs/decisions/0023-tsconfig-path-alias-resolution.md +4 -1
- package/specs/decisions/0049-typescript-7-scanner-uses-a-bundled-typescript-6.md +13 -8
- package/specs/generated-artifacts.md +91 -71
- package/specs/migrations/README.md +6 -6
- package/specs/migrations/from-centralized-schema.md +1 -1
- package/specs/migrations/from-t3-env.md +9 -9
- package/PROMPT.md +0 -89
- package/dist/build-6XFHJFQK.js.map +0 -1
- /package/dist/{chunk-RL5KFVUT.js.map → chunk-TBL3O7IG.js.map} +0 -0
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
"$schema": "http://json-schema.org/draft-07/schema#",
|
|
3
3
|
"$id": "https://maverickcer.github.io/env-cap/schema/env-cap-report.schema.json",
|
|
4
4
|
"title": "env-cap --json report",
|
|
5
|
-
"description": "Machine-readable envelope emitted by `env-cap --json` (see README's --json section and ADR 0013). Generated from src/cli/json.ts's JsonReportPayload type
|
|
5
|
+
"description": "Machine-readable envelope emitted by `env-cap --json` (see README's --json section and ADR 0013). Generated from src/cli/json.ts's JsonReportPayload type, never by hand.",
|
|
6
6
|
"$ref": "#/definitions/JsonReportPayload",
|
|
7
7
|
"definitions": {
|
|
8
8
|
"JsonReportPayload": {
|
|
@@ -14,7 +14,7 @@
|
|
|
14
14
|
"$ref": "#/definitions/JsonErrorPayload"
|
|
15
15
|
}
|
|
16
16
|
],
|
|
17
|
-
"description": "The complete `--json` envelope shape, success or failure
|
|
17
|
+
"description": "The complete `--json` envelope shape, success or failure: the target type the published JSON Schema (`schemas/env-cap-report.schema.json`, `npm run schema`) is generated from. See ADR 0019."
|
|
18
18
|
},
|
|
19
19
|
"JsonSuccessPayload": {
|
|
20
20
|
"type": "object",
|
|
@@ -48,11 +48,11 @@
|
|
|
48
48
|
},
|
|
49
49
|
"requested": {
|
|
50
50
|
"$ref": "#/definitions/JsonRequestedPasses",
|
|
51
|
-
"description": "Which passes this invocation requested
|
|
51
|
+
"description": "Which passes this invocation requested: always present, so \"not requested\" is never confused with \"computed empty.\" See JsonRequestedPasses."
|
|
52
52
|
},
|
|
53
53
|
"evidence": {
|
|
54
54
|
"$ref": "#/definitions/EvidenceModel",
|
|
55
|
-
"description": "Present only when the caller
|
|
55
|
+
"description": "Present only when the caller requested `--evidence`. `GenerateEnvArtifactsResult.evidence` itself is always populated (ADR 0038, \"free to compute, always real\"). The `--json` envelope omits it by default so an ordinary `--location` report doesn't silently grow by the full evidence model every time."
|
|
56
56
|
},
|
|
57
57
|
"checkResult": {
|
|
58
58
|
"type": "object",
|
|
@@ -183,7 +183,7 @@
|
|
|
183
183
|
"items": {
|
|
184
184
|
"type": "string"
|
|
185
185
|
},
|
|
186
|
-
"description": "Every file declaring a conflicting definition. A pairwise comparison (compatibility.ts, exclusive-group.ts) always produces exactly two
|
|
186
|
+
"description": "Every file declaring a conflicting definition. A pairwise comparison (compatibility.ts, exclusive-group.ts) always produces exactly two. A finding escalated from another family (generate-env-artifacts.ts's `escalatedFindings()`, via `findingFiles()`) can produce zero, one, or two, depending on the location information that finding carries. So the arity varies, and this is not a tuple."
|
|
187
187
|
},
|
|
188
188
|
"reason": {
|
|
189
189
|
"type": "string",
|
|
@@ -191,7 +191,7 @@
|
|
|
191
191
|
},
|
|
192
192
|
"code": {
|
|
193
193
|
"$ref": "#/definitions/CompatibilityIssueCode",
|
|
194
|
-
"description": "Stable, machine-readable identifier for CI filtering / doc-linking / GitHub Action annotations / IDE integration. `undefined` only for checks that don't
|
|
194
|
+
"description": "Stable, machine-readable identifier for CI filtering / doc-linking / GitHub Action annotations / IDE integration. `undefined` only for checks that don't set one yet. CompatibilityIssueCode lists every value a check in this file can produce."
|
|
195
195
|
}
|
|
196
196
|
},
|
|
197
197
|
"required": [
|
|
@@ -212,7 +212,7 @@
|
|
|
212
212
|
"DUPLICATE_VARIABLE_DOCUMENTATION",
|
|
213
213
|
"DUPLICATE_VARIABLE_SHAPE_ACROSS_CONTRACTS"
|
|
214
214
|
],
|
|
215
|
-
"description": "Every stable `code` a check in this file (or `exclusive-group.ts`) can emit. Documented as an enumerated union so a consumer filtering/linking on `code` has a closed list to switch over, rather than an arbitrary string
|
|
215
|
+
"description": "Every stable `code` a check in this file (or `exclusive-group.ts`) can emit. Documented as an enumerated union so a consumer filtering/linking on `code` has a closed list to switch over, rather than an arbitrary string: see ADR 0024/0026. `exclusive-group.ts`'s check does not (yet) set one; see that file's own comment for why."
|
|
216
216
|
},
|
|
217
217
|
"ParseWarning": {
|
|
218
218
|
"type": "object",
|
|
@@ -231,7 +231,7 @@
|
|
|
231
231
|
"message"
|
|
232
232
|
],
|
|
233
233
|
"additionalProperties": false,
|
|
234
|
-
"description": "A recoverable issue found while statically parsing or linking one schema file
|
|
234
|
+
"description": "A recoverable issue found while statically parsing or linking one schema file: never fatal, always surfaced to the caller as data."
|
|
235
235
|
},
|
|
236
236
|
"GenerateDocumentationResult": {
|
|
237
237
|
"type": "object",
|
|
@@ -256,7 +256,7 @@
|
|
|
256
256
|
"items": {
|
|
257
257
|
"$ref": "#/definitions/CatalogContract"
|
|
258
258
|
},
|
|
259
|
-
"description": "Same descriptive content as the generated Markdown Catalog, reshaped for programmatic consumers
|
|
259
|
+
"description": "Same descriptive content as the generated Markdown Catalog, reshaped for programmatic consumers: see `buildCatalog()` in `docs.ts`."
|
|
260
260
|
},
|
|
261
261
|
"parseWarnings": {
|
|
262
262
|
"type": "array",
|
|
@@ -303,7 +303,7 @@
|
|
|
303
303
|
"items": {
|
|
304
304
|
"type": "string"
|
|
305
305
|
},
|
|
306
|
-
"description": "Variables live in an existing example file whose feature is no longer active, and that no other active feature still needs
|
|
306
|
+
"description": "Variables live in an existing example file whose feature is no longer active, and that no other active feature still needs: safe to comment out."
|
|
307
307
|
},
|
|
308
308
|
"variablesToAdd": {
|
|
309
309
|
"type": "array",
|
|
@@ -455,11 +455,11 @@
|
|
|
455
455
|
},
|
|
456
456
|
"context": {
|
|
457
457
|
"type": "string",
|
|
458
|
-
"description": "The variable's declared validation context, if any
|
|
458
|
+
"description": "The variable's declared validation context, if any: see ADR 0022. Participation data, not documentation: describes when `validateEnv()` processes this variable, not who may access it or what a bundler includes."
|
|
459
459
|
},
|
|
460
460
|
"evidence": {
|
|
461
461
|
"$ref": "#/definitions/DiscoveredVariableEvidence",
|
|
462
|
-
"description": "The `evidence` sub-object from this variable's linked documentation
|
|
462
|
+
"description": "The `evidence` sub-object from this variable's linked documentation: re-verified every run, unlike every declared-only field above. See ADR 0037."
|
|
463
463
|
}
|
|
464
464
|
},
|
|
465
465
|
"required": [
|
|
@@ -471,7 +471,7 @@
|
|
|
471
471
|
"additionalProperties": false,
|
|
472
472
|
"description": "Same data `renderCatalog()` renders to Markdown for one variable, reshaped for JSON/ programmatic consumers instead of prose."
|
|
473
473
|
},
|
|
474
|
-
"description": "Keyed by variable name
|
|
474
|
+
"description": "Keyed by variable name: unique within one contract (a schema object-literal property name), unlike `contractName` at the top level."
|
|
475
475
|
}
|
|
476
476
|
},
|
|
477
477
|
"required": [
|
|
@@ -492,7 +492,7 @@
|
|
|
492
492
|
"items": {
|
|
493
493
|
"type": "string"
|
|
494
494
|
},
|
|
495
|
-
"description": "Well-formed `\"path:line:column\"` entries from `evidence.dynamicAccess`, if set to an array of string literals
|
|
495
|
+
"description": "Well-formed `\"path:line:column\"` entries from `evidence.dynamicAccess`, if set to an array of string literals: a malformed entry warns and is dropped, never included here. See ADR 0037."
|
|
496
496
|
}
|
|
497
497
|
},
|
|
498
498
|
"additionalProperties": false,
|
|
@@ -589,7 +589,7 @@
|
|
|
589
589
|
"items": {
|
|
590
590
|
"$ref": "#/definitions/NonstandardSensitivityEntry"
|
|
591
591
|
},
|
|
592
|
-
"description": "Contract- or variable-level `sensitivity` values outside STANDARD_SENSITIVITY_LEVELS. Advisory only
|
|
592
|
+
"description": "Contract- or variable-level `sensitivity` values outside STANDARD_SENSITIVITY_LEVELS. Advisory only: the declared level is always honored verbatim; this exists purely so vocabulary drift across a repo stays visible."
|
|
593
593
|
},
|
|
594
594
|
"unresolvedLinks": {
|
|
595
595
|
"type": "array",
|
|
@@ -623,7 +623,7 @@
|
|
|
623
623
|
"unresolvedLinks"
|
|
624
624
|
],
|
|
625
625
|
"additionalProperties": false,
|
|
626
|
-
"description": "Everything generateDocumentation found that isn't fully documented or up to date
|
|
626
|
+
"description": "Everything generateDocumentation found that isn't fully documented or up to date: never blocks generation; a team that wants to gate CI on this reads `Finding[]` (the \"documentation\" family) from the persisted evidence artifact and decides for itself. See ADR 0038."
|
|
627
627
|
},
|
|
628
628
|
"ExpiringEntry": {
|
|
629
629
|
"type": "object",
|
|
@@ -708,7 +708,7 @@
|
|
|
708
708
|
"items": {
|
|
709
709
|
"$ref": "#/definitions/UnresolvedConsumerFinding"
|
|
710
710
|
},
|
|
711
|
-
"description": "Advisory only, never gates `onOwnershipIssue
|
|
711
|
+
"description": "Advisory only, never gates `onOwnershipIssue`: a contract only reaches here when an ambiguous barrel re-export makes \"abandoned\" or \"consumed\" both unprovable."
|
|
712
712
|
},
|
|
713
713
|
"unconsumedOwnedVariables": {
|
|
714
714
|
"type": "array",
|
|
@@ -729,21 +729,21 @@
|
|
|
729
729
|
"items": {
|
|
730
730
|
"$ref": "#/definitions/AssertedDynamicAccessFinding"
|
|
731
731
|
},
|
|
732
|
-
"description": "Variables a developer has re-acknowledged via `dynamicAccess`, freshly
|
|
732
|
+
"description": "Variables a developer has re-acknowledged via `dynamicAccess`, freshly: see ADR 0037."
|
|
733
733
|
},
|
|
734
734
|
"parseWarnings": {
|
|
735
735
|
"type": "array",
|
|
736
736
|
"items": {
|
|
737
737
|
"$ref": "#/definitions/ParseWarning"
|
|
738
738
|
},
|
|
739
|
-
"description": "Schema-discovery parse warnings plus, since ADR 0014, any `packages` resolution failures
|
|
739
|
+
"description": "Schema-discovery parse warnings plus, since ADR 0014, any `packages` resolution failures: surfaced here too (not just from `generateEnvManifest`/`generateDocumentation`) so a team relying only on `--ownership` output still learns when a cross-package contract failed to resolve."
|
|
740
740
|
},
|
|
741
741
|
"scannedSurfaces": {
|
|
742
742
|
"type": "array",
|
|
743
743
|
"items": {
|
|
744
744
|
"$ref": "#/definitions/ScannedSurface"
|
|
745
745
|
},
|
|
746
|
-
"description": "Every surface actually scanned for usage
|
|
746
|
+
"description": "Every surface actually scanned for usage: see ADR 0036. Named explicitly next to `unconsumedOwnedVariables` so \"no consumer found\" is never read as a stronger claim than what was actually searched."
|
|
747
747
|
},
|
|
748
748
|
"reportPath": {
|
|
749
749
|
"type": "string",
|
|
@@ -787,7 +787,7 @@
|
|
|
787
787
|
"items": {
|
|
788
788
|
"type": "string"
|
|
789
789
|
},
|
|
790
|
-
"description": "Files coupled to this contract (imported it, referenced it, or read a member from it)
|
|
790
|
+
"description": "Files coupled to this contract (imported it, referenced it, or read a member from it): contract-level \"who depends on this,\" NOT proof any specific variable was read. Blast radius if this contract changes is `consumers.length`, computed by callers/renderers on demand rather than stored redundantly here."
|
|
791
791
|
}
|
|
792
792
|
},
|
|
793
793
|
"required": [
|
|
@@ -844,7 +844,7 @@
|
|
|
844
844
|
"reason"
|
|
845
845
|
],
|
|
846
846
|
"additionalProperties": false,
|
|
847
|
-
"description": "A contract reachable only through an unresolved barrel re-export
|
|
847
|
+
"description": "A contract reachable only through an unresolved barrel re-export: can't be proven abandoned or consumed."
|
|
848
848
|
},
|
|
849
849
|
"UnconsumedOwnedVariableFinding": {
|
|
850
850
|
"type": "object",
|
|
@@ -866,7 +866,7 @@
|
|
|
866
866
|
"items": {
|
|
867
867
|
"$ref": "#/definitions/DynamicAccessCitationProblem"
|
|
868
868
|
},
|
|
869
|
-
"description": "Every `dynamicAccess` citation for this variable that's currently `\"stale\"` or `\"missing\"` (empty when none exist
|
|
869
|
+
"description": "Every `dynamicAccess` citation for this variable that's currently `\"stale\"` or `\"missing\"` (empty when none exist: see ADR 0037). Empty is the *strongest* \"looks unused\" signal: no developer has ever claimed otherwise. A non-empty list means someone specifically claimed dynamic access here once, and that claim can no longer be verified. That is worth a human check before deleting, not a stronger reason to trust \"unconsumed.\" The list holds the raw citations, not a collapsed `high`/`low` label, matching this codebase's \"show the receipt\" pattern (ADR 0036/0037). A reader can judge confidence from the actual evidence rather than trusting a derived summary. See ADR 0038."
|
|
870
870
|
}
|
|
871
871
|
},
|
|
872
872
|
"required": [
|
|
@@ -896,7 +896,7 @@
|
|
|
896
896
|
},
|
|
897
897
|
"position": {
|
|
898
898
|
"$ref": "#/definitions/SourcePosition",
|
|
899
|
-
"description": "Where the citation points
|
|
899
|
+
"description": "Where the citation points: not the variable's own declaration."
|
|
900
900
|
},
|
|
901
901
|
"acknowledgment": {
|
|
902
902
|
"type": "string",
|
|
@@ -915,7 +915,7 @@
|
|
|
915
915
|
"acknowledgment"
|
|
916
916
|
],
|
|
917
917
|
"additionalProperties": false,
|
|
918
|
-
"description": "One `dynamicAccess` citation env-cap can no longer vouch for
|
|
918
|
+
"description": "One `dynamicAccess` citation env-cap can no longer vouch for: the direct input to `finding-model.ts`'s `\"STALE_DYNAMIC_ACCESS_CITATION\"`/`\"MISSING_DYNAMIC_ACCESS_CITATION\"` findings. See ADR 0037."
|
|
919
919
|
},
|
|
920
920
|
"SourcePosition": {
|
|
921
921
|
"type": "object",
|
|
@@ -939,7 +939,7 @@
|
|
|
939
939
|
"column"
|
|
940
940
|
],
|
|
941
941
|
"additionalProperties": false,
|
|
942
|
-
"description": "A precise pointer into a source file
|
|
942
|
+
"description": "A precise pointer into a source file. Every exact-position fact in the build pipeline (declaration sites, usage sites, dynamic-access sites) shares this shape. So a consumer never has to reconcile three ad hoc `{ file; line; column }` shapes that happen to mean the same thing. See ADR 0036."
|
|
943
943
|
},
|
|
944
944
|
"IndeterminateOwnershipFinding": {
|
|
945
945
|
"type": "object",
|
|
@@ -961,7 +961,7 @@
|
|
|
961
961
|
"items": {
|
|
962
962
|
"$ref": "#/definitions/SourcePosition"
|
|
963
963
|
},
|
|
964
|
-
"description": "Every AST-observed dynamic-access site backing `reason`, structured
|
|
964
|
+
"description": "Every AST-observed dynamic-access site backing `reason`, structured: see ADR 0036."
|
|
965
965
|
},
|
|
966
966
|
"staleOrMissingCitations": {
|
|
967
967
|
"type": "array",
|
|
@@ -979,7 +979,7 @@
|
|
|
979
979
|
"staleOrMissingCitations"
|
|
980
980
|
],
|
|
981
981
|
"additionalProperties": false,
|
|
982
|
-
"description": "A variable accessed only via dynamic (computed) property access
|
|
982
|
+
"description": "A variable accessed only via dynamic (computed) property access: usage cannot be determined statically."
|
|
983
983
|
},
|
|
984
984
|
"AssertedDynamicAccessFinding": {
|
|
985
985
|
"type": "object",
|
|
@@ -1015,7 +1015,7 @@
|
|
|
1015
1015
|
"dynamicAccessAssertions"
|
|
1016
1016
|
],
|
|
1017
1017
|
"additionalProperties": false,
|
|
1018
|
-
"description": "A variable that would otherwise be reported `unconsumedOwnedVariables`/`indeterminate`, but has at least one `\"fresh\"` developer-declared `dynamicAccess` citation
|
|
1018
|
+
"description": "A variable that would otherwise be reported `unconsumedOwnedVariables`/`indeterminate`, but has at least one `\"fresh\"` developer-declared `dynamicAccess` citation: the raw static status is always shown alongside the assertion, never replaced by it. See ADR 0037."
|
|
1019
1019
|
},
|
|
1020
1020
|
"DynamicAccessAssertion": {
|
|
1021
1021
|
"type": "object",
|
|
@@ -1039,11 +1039,11 @@
|
|
|
1039
1039
|
"stale",
|
|
1040
1040
|
"missing"
|
|
1041
1041
|
],
|
|
1042
|
-
"description": "`\"fresh\"
|
|
1042
|
+
"description": "`\"fresh\"`: the cited file currently exists and either matches the committed baseline hash or has no baseline yet (a brand-new citation, nothing to contradict it yet). `\"stale\"`: the cited file exists but its content has changed since the committed baseline. `\"missing\"`: the cited file no longer exists at all. Re-derived from scratch every run; never cached across runs."
|
|
1043
1043
|
},
|
|
1044
1044
|
"contentHash": {
|
|
1045
1045
|
"type": "string",
|
|
1046
|
-
"description": "SHA-256 hex digest of the cited file's content *as observed this run
|
|
1046
|
+
"description": "SHA-256 hex digest of the cited file's content *as observed this run*: `undefined` iff `acknowledgment === \"missing\"` (nothing to hash). This is the one field that makes freshness checking possible without a snapshot-only shadow type. The live `EvidenceModel.dependency` a caller gets back has the exact same shape as the persisted evidence snapshot a later run reads back as its baseline. So this run's `contentHash` becomes next run's comparison target directly. See `evidence-snapshot.ts` and ADR 0037."
|
|
1047
1047
|
}
|
|
1048
1048
|
},
|
|
1049
1049
|
"required": [
|
|
@@ -1053,7 +1053,7 @@
|
|
|
1053
1053
|
"line"
|
|
1054
1054
|
],
|
|
1055
1055
|
"additionalProperties": false,
|
|
1056
|
-
"description": "One developer-declared runtime.VariableEvidenceDocs.dynamicAccess citation's current acknowledgment state
|
|
1056
|
+
"description": "One developer-declared runtime.VariableEvidenceDocs.dynamicAccess citation's current acknowledgment state: a claim, never an observation. Kept fully separate from `VariableAccessStatus` (which stays exactly 3-valued and purely AST-derived) so a developer's assertion can never make env-cap claim it observed something it didn't. See `evidence-snapshot.ts`'s `computeDynamicAccessAcknowledgments()` (where this is computed) and ADR 0037."
|
|
1057
1057
|
},
|
|
1058
1058
|
"ScannedSurface": {
|
|
1059
1059
|
"type": "object",
|
|
@@ -1072,7 +1072,7 @@
|
|
|
1072
1072
|
"root"
|
|
1073
1073
|
],
|
|
1074
1074
|
"additionalProperties": false,
|
|
1075
|
-
"description": "One named surface `buildDependencyGraph()`'s scan actually covered
|
|
1075
|
+
"description": "One named surface `buildDependencyGraph()`'s scan actually covered: the application's own root, plus one entry per allow-listed `packages` (ADR 0014) name whose source was also scanned. See ADR 0036. A claim like \"no consumer found\" is only as strong as what was searched. This lets a renderer say so explicitly, not imply an unbounded guarantee."
|
|
1076
1076
|
},
|
|
1077
1077
|
"JsonRequestedPasses": {
|
|
1078
1078
|
"type": "object",
|
|
@@ -1101,7 +1101,7 @@
|
|
|
1101
1101
|
"evidence"
|
|
1102
1102
|
],
|
|
1103
1103
|
"additionalProperties": false,
|
|
1104
|
-
"description": "Which passes this invocation actually asked for
|
|
1104
|
+
"description": "Which passes this invocation actually asked for: recorded explicitly so a consumer never has to infer intent from which top-level keys happen to be present."
|
|
1105
1105
|
},
|
|
1106
1106
|
"EvidenceModel": {
|
|
1107
1107
|
"type": "object",
|
|
@@ -1163,7 +1163,7 @@
|
|
|
1163
1163
|
"toolVersion"
|
|
1164
1164
|
],
|
|
1165
1165
|
"additionalProperties": false,
|
|
1166
|
-
"description": "Who/when/what produced a given `EvidenceModel` instance. Caller-supplied, never ambient-detected
|
|
1166
|
+
"description": "Who/when/what produced a given `EvidenceModel` instance. Caller-supplied, never ambient-detected: `generateEvidenceModel()` never shells out to `git` itself, mirroring ADR 0012's live-expiration-callback precedent."
|
|
1167
1167
|
},
|
|
1168
1168
|
"ContractModel": {
|
|
1169
1169
|
"type": "object",
|
|
@@ -1184,7 +1184,7 @@
|
|
|
1184
1184
|
"contracts"
|
|
1185
1185
|
],
|
|
1186
1186
|
"additionalProperties": false,
|
|
1187
|
-
"description": "The versioned, JSON-serializable root of the Contract Model
|
|
1187
|
+
"description": "The versioned, JSON-serializable root of the Contract Model: every discovered `createEnv()` contract (active or not), each with its own full statically-discoverable shape. See ContractModelContract."
|
|
1188
1188
|
},
|
|
1189
1189
|
"ContractModelContract": {
|
|
1190
1190
|
"type": "object",
|
|
@@ -1229,7 +1229,7 @@
|
|
|
1229
1229
|
},
|
|
1230
1230
|
"file": {
|
|
1231
1231
|
"type": "string",
|
|
1232
|
-
"description": "Root-relative, POSIX-separated
|
|
1232
|
+
"description": "Root-relative, POSIX-separated: matches `DiscoveredContractSummary.file`."
|
|
1233
1233
|
},
|
|
1234
1234
|
"exportName": {
|
|
1235
1235
|
"type": "string"
|
|
@@ -1393,7 +1393,7 @@
|
|
|
1393
1393
|
},
|
|
1394
1394
|
"evidence": {
|
|
1395
1395
|
"$ref": "#/definitions/DiscoveredVariableEvidence",
|
|
1396
|
-
"description": "The `evidence` sub-object from this variable's linked documentation
|
|
1396
|
+
"description": "The `evidence` sub-object from this variable's linked documentation: re-verified every run, unlike every declared-only field above. See runtime.VariableEvidenceDocs and ADR 0037."
|
|
1397
1397
|
},
|
|
1398
1398
|
"declaration": {
|
|
1399
1399
|
"$ref": "#/definitions/SourcePosition",
|
|
@@ -1438,7 +1438,7 @@
|
|
|
1438
1438
|
"packageDir"
|
|
1439
1439
|
],
|
|
1440
1440
|
"additionalProperties": false,
|
|
1441
|
-
"description": "Both the authored and resolved forms are kept
|
|
1441
|
+
"description": "Both the authored and resolved forms are kept: diagnostics benefit from showing exactly what a package author wrote versus what it resolved to."
|
|
1442
1442
|
},
|
|
1443
1443
|
"DependencyModel": {
|
|
1444
1444
|
"type": "object",
|
|
@@ -1458,7 +1458,7 @@
|
|
|
1458
1458
|
"items": {
|
|
1459
1459
|
"$ref": "#/definitions/DependencyModelConsumer"
|
|
1460
1460
|
},
|
|
1461
|
-
"description": "Inverse of `contracts[].consumingFiles
|
|
1461
|
+
"description": "Inverse of `contracts[].consumingFiles`: one entry per file that consumes at least one contract, listing which contracts it reads."
|
|
1462
1462
|
},
|
|
1463
1463
|
"warnings": {
|
|
1464
1464
|
"type": "array",
|
|
@@ -1471,7 +1471,7 @@
|
|
|
1471
1471
|
"items": {
|
|
1472
1472
|
"$ref": "#/definitions/ScannedSurface"
|
|
1473
1473
|
},
|
|
1474
|
-
"description": "Every surface actually scanned for usage
|
|
1474
|
+
"description": "Every surface actually scanned for usage: see ADR 0036. Always has at least one entry (the application root)."
|
|
1475
1475
|
}
|
|
1476
1476
|
},
|
|
1477
1477
|
"required": [
|
|
@@ -1482,14 +1482,14 @@
|
|
|
1482
1482
|
"scannedSurfaces"
|
|
1483
1483
|
],
|
|
1484
1484
|
"additionalProperties": false,
|
|
1485
|
-
"description": "The versioned, JSON-serializable root of the Dependency Model
|
|
1485
|
+
"description": "The versioned, JSON-serializable root of the Dependency Model: see this module's own doc comment for the full picture."
|
|
1486
1486
|
},
|
|
1487
1487
|
"DependencyModelContract": {
|
|
1488
1488
|
"type": "object",
|
|
1489
1489
|
"properties": {
|
|
1490
1490
|
"file": {
|
|
1491
1491
|
"type": "string",
|
|
1492
|
-
"description": "Root-relative, POSIX-separated
|
|
1492
|
+
"description": "Root-relative, POSIX-separated: matches `ContractModelContract.file`."
|
|
1493
1493
|
},
|
|
1494
1494
|
"exportName": {
|
|
1495
1495
|
"type": "string"
|
|
@@ -1514,7 +1514,7 @@
|
|
|
1514
1514
|
"items": {
|
|
1515
1515
|
"type": "string"
|
|
1516
1516
|
},
|
|
1517
|
-
"description": "Every file coupled to this contract
|
|
1517
|
+
"description": "Every file coupled to this contract: contract-level \"who depends on this,\" not proof any specific variable was read."
|
|
1518
1518
|
},
|
|
1519
1519
|
"ambiguousBarrelFiles": {
|
|
1520
1520
|
"type": "array",
|
|
@@ -1528,7 +1528,7 @@
|
|
|
1528
1528
|
"items": {
|
|
1529
1529
|
"$ref": "#/definitions/SourcePosition"
|
|
1530
1530
|
},
|
|
1531
|
-
"description": "Every computed (dynamic) property-access site observed anywhere on this contract
|
|
1531
|
+
"description": "Every computed (dynamic) property-access site observed anywhere on this contract: see ADR 0036."
|
|
1532
1532
|
}
|
|
1533
1533
|
},
|
|
1534
1534
|
"required": [
|
|
@@ -1559,14 +1559,14 @@
|
|
|
1559
1559
|
"items": {
|
|
1560
1560
|
"$ref": "#/definitions/SourcePosition"
|
|
1561
1561
|
},
|
|
1562
|
-
"description": "Empty unless `status === \"used\"`.
|
|
1562
|
+
"description": "Empty unless `status === \"used\"`. Each entry is a full position with its file (ADR 0027, ADR 0036)."
|
|
1563
1563
|
},
|
|
1564
1564
|
"dynamicAccessAssertions": {
|
|
1565
1565
|
"type": "array",
|
|
1566
1566
|
"items": {
|
|
1567
1567
|
"$ref": "#/definitions/DynamicAccessAssertion"
|
|
1568
1568
|
},
|
|
1569
|
-
"description": "Every developer-declared `dynamicAccess` citation's current freshness for this variable
|
|
1569
|
+
"description": "Every developer-declared `dynamicAccess` citation's current freshness for this variable: a wholly separate, independent fact from `status` above, never folded into it. Empty when no citation was declared, or when no manifest snapshot baseline was available to check against (the manifest pass wasn't also requested). See ADR 0037."
|
|
1570
1570
|
}
|
|
1571
1571
|
},
|
|
1572
1572
|
"required": [
|
|
@@ -1585,7 +1585,7 @@
|
|
|
1585
1585
|
"unconsumed",
|
|
1586
1586
|
"indeterminate"
|
|
1587
1587
|
],
|
|
1588
|
-
"description": "What env-cap's static scan could prove about one variable's consumption
|
|
1588
|
+
"description": "What env-cap's static scan could prove about one variable's consumption. It was member-accessed somewhere (`\"used\"`), or never accessed within the scanned surfaces (`\"unconsumed\"`). Or a computed (dynamic) property access on the owning contract makes the answer unprovable (`\"indeterminate\"`)."
|
|
1589
1589
|
},
|
|
1590
1590
|
"DependencyModelConsumer": {
|
|
1591
1591
|
"type": "object",
|
|
@@ -1606,18 +1606,18 @@
|
|
|
1606
1606
|
"contracts"
|
|
1607
1607
|
],
|
|
1608
1608
|
"additionalProperties": false,
|
|
1609
|
-
"description": "One consuming file, and every contract it depends on
|
|
1609
|
+
"description": "One consuming file, and every contract it depends on: the inverse of `DependencyModelContract.consumingFiles`."
|
|
1610
1610
|
},
|
|
1611
1611
|
"DependencyModelContractRef": {
|
|
1612
1612
|
"$ref": "#/definitions/ContractRef",
|
|
1613
|
-
"description": "One contract, as referenced from the inverse (`consumers`) index
|
|
1613
|
+
"description": "One contract, as referenced from the inverse (`consumers`) index: see ContractRef for why no `contractName` is carried here."
|
|
1614
1614
|
},
|
|
1615
1615
|
"ContractRef": {
|
|
1616
1616
|
"type": "object",
|
|
1617
1617
|
"properties": {
|
|
1618
1618
|
"file": {
|
|
1619
1619
|
"type": "string",
|
|
1620
|
-
"description": "Root-relative, POSIX-separated path of the file declaring the contract
|
|
1620
|
+
"description": "Root-relative, POSIX-separated path of the file declaring the contract: see `displayPath()`."
|
|
1621
1621
|
},
|
|
1622
1622
|
"exportName": {
|
|
1623
1623
|
"type": "string",
|
|
@@ -1629,7 +1629,7 @@
|
|
|
1629
1629
|
"exportName"
|
|
1630
1630
|
],
|
|
1631
1631
|
"additionalProperties": false,
|
|
1632
|
-
"description": "The one shape every model in this package uses to point at a declared contract: the file it's declared in, and the binding it's exported as. Nothing else
|
|
1632
|
+
"description": "The one shape every model in this package uses to point at a declared contract: the file it's declared in, and the binding it's exported as. Nothing else: see ADR 0039."
|
|
1633
1633
|
},
|
|
1634
1634
|
"OwnershipModel": {
|
|
1635
1635
|
"type": "object",
|
|
@@ -1666,14 +1666,14 @@
|
|
|
1666
1666
|
"unownedVariables"
|
|
1667
1667
|
],
|
|
1668
1668
|
"additionalProperties": false,
|
|
1669
|
-
"description": "The versioned, JSON-serializable root of the Ownership Model
|
|
1669
|
+
"description": "The versioned, JSON-serializable root of the Ownership Model: see this module's own doc comment for the full picture."
|
|
1670
1670
|
},
|
|
1671
1671
|
"OwnershipModelContract": {
|
|
1672
1672
|
"type": "object",
|
|
1673
1673
|
"properties": {
|
|
1674
1674
|
"file": {
|
|
1675
1675
|
"type": "string",
|
|
1676
|
-
"description": "Root-relative, POSIX-separated
|
|
1676
|
+
"description": "Root-relative, POSIX-separated: matches `ContractModelContract.file`."
|
|
1677
1677
|
},
|
|
1678
1678
|
"exportName": {
|
|
1679
1679
|
"type": "string"
|
|
@@ -1683,7 +1683,7 @@
|
|
|
1683
1683
|
},
|
|
1684
1684
|
"owner": {
|
|
1685
1685
|
"type": "string",
|
|
1686
|
-
"description": "The contract's own default owner
|
|
1686
|
+
"description": "The contract's own default owner: not \"effective\" the way a variable's is, since there's no level above a contract to fall back to."
|
|
1687
1687
|
},
|
|
1688
1688
|
"variables": {
|
|
1689
1689
|
"type": "array",
|
|
@@ -1709,7 +1709,7 @@
|
|
|
1709
1709
|
},
|
|
1710
1710
|
"owner": {
|
|
1711
1711
|
"type": "string",
|
|
1712
|
-
"description": "The variable's own `owner`, falling back to the contract's
|
|
1712
|
+
"description": "The variable's own `owner`, falling back to the contract's: see `effectiveOwner()`."
|
|
1713
1713
|
}
|
|
1714
1714
|
},
|
|
1715
1715
|
"required": [
|
|
@@ -1720,14 +1720,14 @@
|
|
|
1720
1720
|
},
|
|
1721
1721
|
"OwnershipModelContractRef": {
|
|
1722
1722
|
"$ref": "#/definitions/ContractRef",
|
|
1723
|
-
"description": "One contract, referenced by identity only
|
|
1723
|
+
"description": "One contract, referenced by identity only: see ContractRef for why no `contractName` is carried here. Resolve one from `ContractModel` when a renderer needs display text."
|
|
1724
1724
|
},
|
|
1725
1725
|
"OwnershipModelVariableRef": {
|
|
1726
1726
|
"type": "object",
|
|
1727
1727
|
"properties": {
|
|
1728
1728
|
"file": {
|
|
1729
1729
|
"type": "string",
|
|
1730
|
-
"description": "Root-relative, POSIX-separated path of the file declaring the contract
|
|
1730
|
+
"description": "Root-relative, POSIX-separated path of the file declaring the contract: see `displayPath()`."
|
|
1731
1731
|
},
|
|
1732
1732
|
"exportName": {
|
|
1733
1733
|
"type": "string",
|
|
@@ -1743,7 +1743,7 @@
|
|
|
1743
1743
|
"key"
|
|
1744
1744
|
],
|
|
1745
1745
|
"additionalProperties": false,
|
|
1746
|
-
"description": "One variable, referenced by its owning contract's identity plus its own key
|
|
1746
|
+
"description": "One variable, referenced by its owning contract's identity plus its own key: see ContractRef."
|
|
1747
1747
|
},
|
|
1748
1748
|
"LifecycleModel": {
|
|
1749
1749
|
"type": "object",
|
|
@@ -1764,7 +1764,7 @@
|
|
|
1764
1764
|
"items": {
|
|
1765
1765
|
"$ref": "#/definitions/ExpiringEntry"
|
|
1766
1766
|
},
|
|
1767
|
-
"description": "Every contract-/variable-level `expiresAt` within the configured window, soonest-first
|
|
1767
|
+
"description": "Every contract-/variable-level `expiresAt` within the configured window, soonest-first: see `computeExpiringEntries()`. `file` is root-relative and POSIX-separated here, matching `LifecycleModelContract.file` and every other canonical model. `ExpiringEntry`'s own doc comment describes a different case: `computeExpiringEntries()`'s other direct consumers (e.g. `DocumentationFindings.expiringSoon`). There `file` stays the absolute path `renderDocs()` itself expects."
|
|
1768
1768
|
}
|
|
1769
1769
|
},
|
|
1770
1770
|
"required": [
|
|
@@ -1773,14 +1773,14 @@
|
|
|
1773
1773
|
"expiring"
|
|
1774
1774
|
],
|
|
1775
1775
|
"additionalProperties": false,
|
|
1776
|
-
"description": "The versioned, JSON-serializable root of the Lifecycle Model
|
|
1776
|
+
"description": "The versioned, JSON-serializable root of the Lifecycle Model: see this module's own doc comment for the full picture."
|
|
1777
1777
|
},
|
|
1778
1778
|
"LifecycleModelContract": {
|
|
1779
1779
|
"type": "object",
|
|
1780
1780
|
"properties": {
|
|
1781
1781
|
"file": {
|
|
1782
1782
|
"type": "string",
|
|
1783
|
-
"description": "Root-relative, POSIX-separated
|
|
1783
|
+
"description": "Root-relative, POSIX-separated: matches `ContractModelContract.file`."
|
|
1784
1784
|
},
|
|
1785
1785
|
"exportName": {
|
|
1786
1786
|
"type": "string"
|
|
@@ -1806,7 +1806,7 @@
|
|
|
1806
1806
|
"items": {
|
|
1807
1807
|
"$ref": "#/definitions/LifecycleModelVariable"
|
|
1808
1808
|
},
|
|
1809
|
-
"description": "Only variables with at least one lifecycle field set (`expiresAt`, `refreshInstructions`, `deprecated`, `removeBy`, `renamedFrom`, `retention`, `authenticatorType`, `rotationPeriod`, `lastRotatedAt`, `rotationTriggerEvents`)
|
|
1809
|
+
"description": "Only variables with at least one lifecycle field set (`expiresAt`, `refreshInstructions`, `deprecated`, `removeBy`, `renamedFrom`, `retention`, `authenticatorType`, `rotationPeriod`, `lastRotatedAt`, `rotationTriggerEvents`). `renderLifecycleReport()` uses the same \"only what's relevant\" scope for its rows."
|
|
1810
1810
|
}
|
|
1811
1811
|
},
|
|
1812
1812
|
"required": [
|
|
@@ -1841,11 +1841,11 @@
|
|
|
1841
1841
|
},
|
|
1842
1842
|
"renamedFrom": {
|
|
1843
1843
|
"type": "string",
|
|
1844
|
-
"description": "The previous variable name this one renames, if set
|
|
1844
|
+
"description": "The previous variable name this one renames, if set: see `ManifestChangeReport`'s rename correlation (ADR 0029/0030)."
|
|
1845
1845
|
},
|
|
1846
1846
|
"retention": {
|
|
1847
1847
|
"type": "string",
|
|
1848
|
-
"description": "Descriptive retention policy (e.g. \"delete after 90 days\")
|
|
1848
|
+
"description": "Descriptive retention policy (e.g. \"delete after 90 days\"): a policy statement, never computed or parsed, deliberately independent of `expiresAt`'s actual temporal constraint. See ADR 0035."
|
|
1849
1849
|
},
|
|
1850
1850
|
"authenticatorType": {
|
|
1851
1851
|
"type": "string",
|
|
@@ -1868,7 +1868,7 @@
|
|
|
1868
1868
|
},
|
|
1869
1869
|
"rotationStatus": {
|
|
1870
1870
|
"$ref": "#/definitions/RotationComplianceStatus",
|
|
1871
|
-
"description": "Computed, not stored
|
|
1871
|
+
"description": "Computed, not stored: see RotationComplianceStatus and `computeRotationStatus()`."
|
|
1872
1872
|
}
|
|
1873
1873
|
},
|
|
1874
1874
|
"required": [
|
|
@@ -1886,7 +1886,7 @@
|
|
|
1886
1886
|
"expired",
|
|
1887
1887
|
"undeclared"
|
|
1888
1888
|
],
|
|
1889
|
-
"description": "One variable's computed NIST SP 800-53 IA-5 rotation
|
|
1889
|
+
"description": "One variable's computed NIST SP 800-53 IA-5 rotation status (a policy-window judgement): see `computeRotationStatus()` for exactly how it's derived. Always present on a `LifecycleModelVariable` (never `undefined`). A variable with nothing lifecycle-relevant set never reaches this model (`hasLifecycleData()` below). So `\"undeclared\"` is the honest value for \"reached this model for another lifecycle reason (e.g. `deprecated`) but declares none of the four rotation-specific fields\".\n\nThis is a policy-window judgement from the declared metadata (\"within the declared rotation period\"). It never states that any control is met or that a rotation happened. env-cap never checks a declaration against reality. Renaming the value `\"compliant\"` would be a breaking change, so it can only happen in a major release."
|
|
1890
1890
|
},
|
|
1891
1891
|
"FindingModel": {
|
|
1892
1892
|
"type": "object",
|
|
@@ -1907,7 +1907,7 @@
|
|
|
1907
1907
|
"findings"
|
|
1908
1908
|
],
|
|
1909
1909
|
"additionalProperties": false,
|
|
1910
|
-
"description": "The versioned, JSON-serializable root of the Finding Model
|
|
1910
|
+
"description": "The versioned, JSON-serializable root of the Finding Model: every rule violation and derived risk signal from this run, unified behind Finding 's one shape. See this module's own doc comment for the full picture."
|
|
1911
1911
|
},
|
|
1912
1912
|
"Finding": {
|
|
1913
1913
|
"type": "object",
|
|
@@ -1919,11 +1919,11 @@
|
|
|
1919
1919
|
"warning",
|
|
1920
1920
|
"info"
|
|
1921
1921
|
],
|
|
1922
|
-
"description": "`\"error\"` for a provable, always-blocking violation (e.g. an exclusive-group conflict); `\"warning\"` for everything gated by `onIncompatibility`/`onUndocumented`/`onOwnershipIssue`'s default \"warn\" behavior; `\"info\"` for an observation that is never actionable enough to block anything, even under `--strict
|
|
1922
|
+
"description": "`\"error\"` for a provable, always-blocking violation (e.g. an exclusive-group conflict); `\"warning\"` for everything gated by `onIncompatibility`/`onUndocumented`/`onOwnershipIssue`'s default \"warn\" behavior; `\"info\"` for an observation that is never actionable enough to block anything, even under `--strict`: see `INFO_ONLY_CODES` in `generate-env-artifacts.ts`."
|
|
1923
1923
|
},
|
|
1924
1924
|
"code": {
|
|
1925
1925
|
"$ref": "#/definitions/FindingCode",
|
|
1926
|
-
"description": "Stable, machine-readable identifier
|
|
1926
|
+
"description": "Stable, machine-readable identifier: always set, unlike CompatibilityIssue.code which stays optional on that narrower, pre-existing type."
|
|
1927
1927
|
},
|
|
1928
1928
|
"family": {
|
|
1929
1929
|
"$ref": "#/definitions/FindingFamily",
|
|
@@ -2028,7 +2028,7 @@
|
|
|
2028
2028
|
"documentation",
|
|
2029
2029
|
"ownership"
|
|
2030
2030
|
],
|
|
2031
|
-
"description": "Which source check produced a Finding
|
|
2031
|
+
"description": "Which source check produced a Finding: coarser than `code`, for a consumer that only wants to filter by kind (e.g. \"show me every documentation gap\") without enumerating every individual code."
|
|
2032
2032
|
},
|
|
2033
2033
|
"EvidenceReference": {
|
|
2034
2034
|
"anyOf": [
|
|
@@ -2042,7 +2042,7 @@
|
|
|
2042
2042
|
"$ref": "#/definitions/ChangeEvidenceReference"
|
|
2043
2043
|
}
|
|
2044
2044
|
],
|
|
2045
|
-
"description": "A structured pointer back to where a `Finding` (or, later, any other model's derived fact) came from
|
|
2045
|
+
"description": "A structured pointer back to where a `Finding` (or, later, any other model's derived fact) came from: never a formatted string. See ADR 0024 and ADR 0026."
|
|
2046
2046
|
},
|
|
2047
2047
|
"ContractEvidenceReference": {
|
|
2048
2048
|
"type": "object",
|
|
@@ -2053,7 +2053,7 @@
|
|
|
2053
2053
|
},
|
|
2054
2054
|
"file": {
|
|
2055
2055
|
"type": "string",
|
|
2056
|
-
"description": "Root-relative, POSIX-separated path of the file declaring the contract, when known
|
|
2056
|
+
"description": "Root-relative, POSIX-separated path of the file declaring the contract, when known: see `displayPath()`."
|
|
2057
2057
|
},
|
|
2058
2058
|
"exportName": {
|
|
2059
2059
|
"type": "string",
|
|
@@ -2065,14 +2065,14 @@
|
|
|
2065
2065
|
},
|
|
2066
2066
|
"position": {
|
|
2067
2067
|
"$ref": "#/definitions/SourcePosition",
|
|
2068
|
-
"description": "Exact file:line:column this finding is about
|
|
2068
|
+
"description": "Exact file:line:column this finding is about; the contract's `createEnv()` declaration, its `documentEnv()` declaration, or the specific variable's own declaration, whichever is most relevant to the finding. `undefined` only when no single position is more relevant than another (e.g. an `indeterminate-ownership` finding, which can have multiple candidate sites: see `IndeterminateOwnershipFinding.dynamicAccessSites` for the full list instead). See ADR 0036."
|
|
2069
2069
|
}
|
|
2070
2070
|
},
|
|
2071
2071
|
"required": [
|
|
2072
2072
|
"model"
|
|
2073
2073
|
],
|
|
2074
2074
|
"additionalProperties": false,
|
|
2075
|
-
"description": "Points at a declared contract and, optionally, one of its variables
|
|
2075
|
+
"description": "Points at a declared contract and, optionally, one of its variables: the shape every `CompatibilityIssue`/documentation finding can be resolved to. Unlike ContractRef, both identity fields are optional here: a finding can legitimately know only the file (an unresolvable `documentEnv()` link) or neither."
|
|
2076
2076
|
},
|
|
2077
2077
|
"OwnershipEvidenceReference": {
|
|
2078
2078
|
"type": "object",
|
|
@@ -2102,7 +2102,7 @@
|
|
|
2102
2102
|
"contractName"
|
|
2103
2103
|
],
|
|
2104
2104
|
"additionalProperties": false,
|
|
2105
|
-
"description": "Points at a contract by name for an ownership/usage finding
|
|
2105
|
+
"description": "Points at a contract by name for an ownership/usage finding: `usage-report.ts`'s finding types don't consistently carry `file`/`exportName` together, only `contractName`."
|
|
2106
2106
|
},
|
|
2107
2107
|
"ChangeEvidenceReference": {
|
|
2108
2108
|
"type": "object",
|
|
@@ -2121,7 +2121,7 @@
|
|
|
2121
2121
|
"path"
|
|
2122
2122
|
],
|
|
2123
2123
|
"additionalProperties": false,
|
|
2124
|
-
"description": "Points at a generated artifact's path
|
|
2124
|
+
"description": "Points at a generated artifact's path: what `checkEnvArtifacts()`'s drift findings are about, not a declared contract or variable at all."
|
|
2125
2125
|
},
|
|
2126
2126
|
"ChangeModel": {
|
|
2127
2127
|
"type": "object",
|
|
@@ -2132,7 +2132,7 @@
|
|
|
2132
2132
|
},
|
|
2133
2133
|
"manifest": {
|
|
2134
2134
|
"$ref": "#/definitions/ManifestChangeReport",
|
|
2135
|
-
"description": "The existing manifest change report, unmodified
|
|
2135
|
+
"description": "The existing manifest change report, unmodified: see ADR 0021. `addedVariables`/`removedVariables` still list a correlated rename's two halves separately; `renamedVariables` below is an additive, separately-computed view, not a filter over this field."
|
|
2136
2136
|
},
|
|
2137
2137
|
"renamedVariables": {
|
|
2138
2138
|
"type": "array",
|
|
@@ -2148,7 +2148,7 @@
|
|
|
2148
2148
|
"renamedVariables"
|
|
2149
2149
|
],
|
|
2150
2150
|
"additionalProperties": false,
|
|
2151
|
-
"description": "The versioned, JSON-serializable root of the Change Model
|
|
2151
|
+
"description": "The versioned, JSON-serializable root of the Change Model: what changed since the last persisted evidence snapshot. See this module's own doc comment for the full picture."
|
|
2152
2152
|
},
|
|
2153
2153
|
"ManifestChangeReport": {
|
|
2154
2154
|
"type": "object",
|
|
@@ -2205,18 +2205,18 @@
|
|
|
2205
2205
|
"updatedVariables"
|
|
2206
2206
|
],
|
|
2207
2207
|
"additionalProperties": false,
|
|
2208
|
-
"description": "The result of diffing two `ContractModel.contracts` arrays
|
|
2208
|
+
"description": "The result of diffing two `ContractModel.contracts` arrays: see `diffContracts()`. Comprehensive by construction. Every own field of `ContractModelContract`/`ContractModelVariable` participates: schema facts (`hasDefault`/`processorSource`/`validatorSource`/...) and documented metadata. Every discovered contract is covered, not only active ones. `diffContracts()` compares every field generically, so a new Contract Model field is diffed without an edit here."
|
|
2209
2209
|
},
|
|
2210
2210
|
"ManifestContractRef": {
|
|
2211
2211
|
"$ref": "#/definitions/ContractRef",
|
|
2212
|
-
"description": "Identifies one contract for ManifestChangeReport purposes
|
|
2212
|
+
"description": "Identifies one contract for ManifestChangeReport purposes: see ContractRef for why neither a `contractName` nor a pre-formatted `identity` is carried here."
|
|
2213
2213
|
},
|
|
2214
2214
|
"ManifestVariableRef": {
|
|
2215
2215
|
"type": "object",
|
|
2216
2216
|
"properties": {
|
|
2217
2217
|
"file": {
|
|
2218
2218
|
"type": "string",
|
|
2219
|
-
"description": "Root-relative, POSIX-separated path of the file declaring the contract
|
|
2219
|
+
"description": "Root-relative, POSIX-separated path of the file declaring the contract: see `displayPath()`."
|
|
2220
2220
|
},
|
|
2221
2221
|
"exportName": {
|
|
2222
2222
|
"type": "string",
|
|
@@ -2233,14 +2233,14 @@
|
|
|
2233
2233
|
"key"
|
|
2234
2234
|
],
|
|
2235
2235
|
"additionalProperties": false,
|
|
2236
|
-
"description": "Identifies one variable for ManifestChangeReport purposes
|
|
2236
|
+
"description": "Identifies one variable for ManifestChangeReport purposes: its owning contract's identity plus its own key. See ContractRef."
|
|
2237
2237
|
},
|
|
2238
2238
|
"ManifestContractUpdate": {
|
|
2239
2239
|
"type": "object",
|
|
2240
2240
|
"properties": {
|
|
2241
2241
|
"file": {
|
|
2242
2242
|
"type": "string",
|
|
2243
|
-
"description": "Root-relative, POSIX-separated path of the file declaring the contract
|
|
2243
|
+
"description": "Root-relative, POSIX-separated path of the file declaring the contract: see `displayPath()`."
|
|
2244
2244
|
},
|
|
2245
2245
|
"exportName": {
|
|
2246
2246
|
"type": "string",
|
|
@@ -2289,7 +2289,7 @@
|
|
|
2289
2289
|
"properties": {
|
|
2290
2290
|
"file": {
|
|
2291
2291
|
"type": "string",
|
|
2292
|
-
"description": "Root-relative, POSIX-separated path of the file declaring the contract
|
|
2292
|
+
"description": "Root-relative, POSIX-separated path of the file declaring the contract: see `displayPath()`."
|
|
2293
2293
|
},
|
|
2294
2294
|
"exportName": {
|
|
2295
2295
|
"type": "string",
|
|
@@ -2321,7 +2321,7 @@
|
|
|
2321
2321
|
"properties": {
|
|
2322
2322
|
"contractIdentity": {
|
|
2323
2323
|
"type": "string",
|
|
2324
|
-
"description": "The owning contract's identity (`${file}#${exportName}`)
|
|
2324
|
+
"description": "The owning contract's identity (`${file}#${exportName}`): a rename never crosses contracts."
|
|
2325
2325
|
},
|
|
2326
2326
|
"file": {
|
|
2327
2327
|
"type": "string"
|
|
@@ -2334,11 +2334,11 @@
|
|
|
2334
2334
|
},
|
|
2335
2335
|
"previousKey": {
|
|
2336
2336
|
"type": "string",
|
|
2337
|
-
"description": "The variable's key before the rename
|
|
2337
|
+
"description": "The variable's key before the rename: matches a `manifest.removedVariables` entry."
|
|
2338
2338
|
},
|
|
2339
2339
|
"currentKey": {
|
|
2340
2340
|
"type": "string",
|
|
2341
|
-
"description": "The variable's key after the rename
|
|
2341
|
+
"description": "The variable's key after the rename: matches a `manifest.addedVariables` entry."
|
|
2342
2342
|
}
|
|
2343
2343
|
},
|
|
2344
2344
|
"required": [
|