@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
|
@@ -0,0 +1,66 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* SARIF export: an adapter over Finding Model, not a new fact source.
|
|
3
|
+
* Produces a minimal, spec-conformant SARIF 2.1.0 log
|
|
4
|
+
* (https://docs.oasis-open.org/sarif/sarif/v2.1.0/) so env-cap's findings can
|
|
5
|
+
* be consumed by any SARIF-aware tool (GitHub code scanning, most CI security
|
|
6
|
+
* dashboards) without a bespoke integration.
|
|
7
|
+
*
|
|
8
|
+
* Pure and synchronous: every input is already computed by the time this
|
|
9
|
+
* runs, so this never re-derives a finding, never reads the filesystem, and
|
|
10
|
+
* never decides what is or isn't a problem; it only re-shapes what
|
|
11
|
+
* `buildFindingModel()` already concluded.
|
|
12
|
+
*/
|
|
13
|
+
import type { FindingModel } from "./finding-model.js";
|
|
14
|
+
/** SARIF's `level` enum: see the SARIF 2.1.0 spec, section 3.27.10. */
|
|
15
|
+
type SarifLevel = "none" | "note" | "warning" | "error";
|
|
16
|
+
interface SarifLocation {
|
|
17
|
+
readonly physicalLocation: {
|
|
18
|
+
readonly artifactLocation: {
|
|
19
|
+
readonly uri: string;
|
|
20
|
+
};
|
|
21
|
+
readonly region?: {
|
|
22
|
+
readonly startLine: number;
|
|
23
|
+
readonly startColumn: number;
|
|
24
|
+
};
|
|
25
|
+
};
|
|
26
|
+
}
|
|
27
|
+
interface SarifResult {
|
|
28
|
+
readonly ruleId: string;
|
|
29
|
+
readonly level: SarifLevel;
|
|
30
|
+
readonly message: {
|
|
31
|
+
readonly text: string;
|
|
32
|
+
};
|
|
33
|
+
readonly locations?: readonly SarifLocation[];
|
|
34
|
+
}
|
|
35
|
+
/** A minimal SARIF 2.1.0 log: only the properties this adapter actually populates, not the full spec surface. */
|
|
36
|
+
export interface SarifLog {
|
|
37
|
+
readonly $schema: string;
|
|
38
|
+
readonly version: "2.1.0";
|
|
39
|
+
readonly runs: readonly {
|
|
40
|
+
readonly tool: {
|
|
41
|
+
readonly driver: {
|
|
42
|
+
readonly name: string;
|
|
43
|
+
readonly informationUri: string;
|
|
44
|
+
readonly version: string;
|
|
45
|
+
readonly rules: readonly {
|
|
46
|
+
readonly id: string;
|
|
47
|
+
}[];
|
|
48
|
+
};
|
|
49
|
+
};
|
|
50
|
+
readonly results: readonly SarifResult[];
|
|
51
|
+
}[];
|
|
52
|
+
}
|
|
53
|
+
/**
|
|
54
|
+
* Projects Finding Model into a SARIF 2.1.0 log.
|
|
55
|
+
*
|
|
56
|
+
* @remarks
|
|
57
|
+
* `rules` lists every distinct `FindingCode` actually present in this run,
|
|
58
|
+
* sorted: not the full `FindingCode` union. A SARIF consumer treats the
|
|
59
|
+
* rules array as "what this tool reported", and advertising rules that
|
|
60
|
+
* produced no result makes a clean run look like it has unexplained silent
|
|
61
|
+
* rules. `results` preserves Finding Model's own order, which a caller wanting
|
|
62
|
+
* a different one sorts themselves.
|
|
63
|
+
*/
|
|
64
|
+
export declare function buildSarifLog(findingModel: FindingModel): SarifLog;
|
|
65
|
+
export {};
|
|
66
|
+
//# sourceMappingURL=sarif.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"sarif.d.ts","sourceRoot":"","sources":["../../../src/build/sarif.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;GAWG;AAEH,OAAO,KAAK,EAAW,YAAY,EAAE,MAAM,oBAAoB,CAAA;AAI/D,uEAAuE;AACvE,KAAK,UAAU,GAAG,MAAM,GAAG,MAAM,GAAG,SAAS,GAAG,OAAO,CAAA;AAOvD,UAAU,aAAa;IACrB,QAAQ,CAAC,gBAAgB,EAAE;QACzB,QAAQ,CAAC,gBAAgB,EAAE;YAAE,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAA;SAAE,CAAA;QACnD,QAAQ,CAAC,MAAM,CAAC,EAAE;YAAE,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;YAAC,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAA;SAAE,CAAA;KAC/E,CAAA;CACF;AAsCD,UAAU,WAAW;IACnB,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAA;IACvB,QAAQ,CAAC,KAAK,EAAE,UAAU,CAAA;IAC1B,QAAQ,CAAC,OAAO,EAAE;QAAE,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;KAAE,CAAA;IAC3C,QAAQ,CAAC,SAAS,CAAC,EAAE,SAAS,aAAa,EAAE,CAAA;CAC9C;AAED,iHAAiH;AACjH,MAAM,WAAW,QAAQ;IACvB,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAA;IACxB,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAA;IACzB,QAAQ,CAAC,IAAI,EAAE,SAAS;QACtB,QAAQ,CAAC,IAAI,EAAE;YACb,QAAQ,CAAC,MAAM,EAAE;gBACf,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;gBACrB,QAAQ,CAAC,cAAc,EAAE,MAAM,CAAA;gBAC/B,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAA;gBACxB,QAAQ,CAAC,KAAK,EAAE,SAAS;oBAAE,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAA;iBAAE,EAAE,CAAA;aACnD,CAAA;SACF,CAAA;QACD,QAAQ,CAAC,OAAO,EAAE,SAAS,WAAW,EAAE,CAAA;KACzC,EAAE,CAAA;CACJ;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,aAAa,CAAC,YAAY,EAAE,YAAY,GAAG,QAAQ,CAgClE"}
|
|
@@ -0,0 +1,71 @@
|
|
|
1
|
+
import type TS from "@typescript/typescript6";
|
|
2
|
+
import type { ImportBinding } from "./parse.js";
|
|
3
|
+
/**
|
|
4
|
+
* Why a tracked binding's value flowed somewhere this single-file, syntactic
|
|
5
|
+
* walk cannot follow: see ADR 0039. Each reason names the exact construct.
|
|
6
|
+
* So a downstream "cannot determine whether X is read" message can cite it,
|
|
7
|
+
* not a single opaque "escape" label.
|
|
8
|
+
*/
|
|
9
|
+
export type EscapeReason =
|
|
10
|
+
/** `const { ...rest } = contract`: a rest element captures every remaining key at once. */
|
|
11
|
+
"rest"
|
|
12
|
+
/** `const { X: { Y } } = contract`: the bound value itself gets destructured again, one level too deep for this pass. */
|
|
13
|
+
| "nested-pattern"
|
|
14
|
+
/** `const { [expr]: v } = contract` where `expr` isn't a string literal: the bound key can't be read without evaluating `expr`. */
|
|
15
|
+
| "computed-key"
|
|
16
|
+
/** `const e = contract` where `e` isn't file-unique/never-assigned (see `resolveAliasTargets`): the read is real, but this pass declines to follow `e` any further. */
|
|
17
|
+
| "reassignment";
|
|
18
|
+
/** One observed use of a tracked contract binding in a consumer file: see ADR 0039. Consumed by `dependency-graph.ts`. */
|
|
19
|
+
export type AccessSite = {
|
|
20
|
+
readonly kind: "member";
|
|
21
|
+
readonly member: string;
|
|
22
|
+
readonly line: number;
|
|
23
|
+
readonly column: number;
|
|
24
|
+
} | {
|
|
25
|
+
readonly kind: "dynamic";
|
|
26
|
+
readonly line: number;
|
|
27
|
+
readonly column: number;
|
|
28
|
+
} | {
|
|
29
|
+
readonly kind: "reference";
|
|
30
|
+
readonly line: number;
|
|
31
|
+
readonly column: number;
|
|
32
|
+
} | {
|
|
33
|
+
readonly kind: "escape";
|
|
34
|
+
readonly via: EscapeReason;
|
|
35
|
+
readonly line: number;
|
|
36
|
+
readonly column: number;
|
|
37
|
+
};
|
|
38
|
+
export interface FileScanResult {
|
|
39
|
+
readonly file: string;
|
|
40
|
+
readonly imports: ReadonlyMap<string, ImportBinding>;
|
|
41
|
+
readonly accessesByLocalName: ReadonlyMap<string, readonly AccessSite[]>;
|
|
42
|
+
/** True if this file contains a bare `export * from "..."`. Used only to
|
|
43
|
+
* flag ambiguous barrel forwarding elsewhere as "unresolved", never to
|
|
44
|
+
* follow it (see ADR 0010's scope boundary). */
|
|
45
|
+
readonly hasWildcardReExport: boolean;
|
|
46
|
+
}
|
|
47
|
+
/** One `const <name> = <identifier>` declaration: a candidate one-level alias of `<identifier>`, before file-uniqueness/never-assigned checks (see `resolveAliasTargets`). */
|
|
48
|
+
interface AliasCandidate {
|
|
49
|
+
readonly aliasName: string;
|
|
50
|
+
readonly baseName: string;
|
|
51
|
+
readonly declaration: TS.VariableDeclaration;
|
|
52
|
+
}
|
|
53
|
+
/**
|
|
54
|
+
* One whole-file pass collecting the three facts `resolveAliasTargets` needs:
|
|
55
|
+
*
|
|
56
|
+
* - How many times each name is introduced as *any* kind of binding. A name
|
|
57
|
+
* declared twice anywhere, even inside a nested scope, is not a trackable
|
|
58
|
+
* alias. Like every other check in this file, this pass is deliberately not
|
|
59
|
+
* scope-aware.
|
|
60
|
+
* - Which names are ever assigned to after their declaration.
|
|
61
|
+
* - Every plain `const <name> = <identifier>` declaration, as a raw candidate.
|
|
62
|
+
*/
|
|
63
|
+
/** @internal Exported for direct unit coverage. */
|
|
64
|
+
export declare function collectDeclarationFacts(sourceFile: TS.SourceFile): {
|
|
65
|
+
readonly declarationCounts: ReadonlyMap<string, number>;
|
|
66
|
+
readonly assignedNames: ReadonlySet<string>;
|
|
67
|
+
readonly constAliasCandidates: readonly AliasCandidate[];
|
|
68
|
+
};
|
|
69
|
+
export declare function scanFileForDependencies(filePath: string, sourceText: string): FileScanResult;
|
|
70
|
+
export {};
|
|
71
|
+
//# sourceMappingURL=scan-dependencies.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"scan-dependencies.d.ts","sourceRoot":"","sources":["../../../src/build/scan-dependencies.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,MAAM,YAAY,CAAA;AAGhC,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,YAAY,CAAA;AAG/C;;;;;GAKG;AACH,MAAM,MAAM,YAAY;AACtB,2FAA2F;AACzF,MAAM;AACR,yHAAyH;GACvH,gBAAgB;AAClB,mIAAmI;GACjI,cAAc;AAChB,uKAAuK;GACrK,cAAc,CAAA;AAElB,0HAA0H;AAC1H,MAAM,MAAM,UAAU,GAClB;IACE,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAA;IACvB,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAA;IACvB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;IACrB,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAA;CACxB,GACD;IAAE,QAAQ,CAAC,IAAI,EAAE,SAAS,CAAC;IAAC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IAAC,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAA;CAAE,GAC5E;IAAE,QAAQ,CAAC,IAAI,EAAE,WAAW,CAAC;IAAC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IAAC,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAA;CAAE,GAC9E;IACE,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAA;IACvB,QAAQ,CAAC,GAAG,EAAE,YAAY,CAAA;IAC1B,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;IACrB,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAA;CACxB,CAAA;AAEL,MAAM,WAAW,cAAc;IAC7B,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;IACrB,QAAQ,CAAC,OAAO,EAAE,WAAW,CAAC,MAAM,EAAE,aAAa,CAAC,CAAA;IACpD,QAAQ,CAAC,mBAAmB,EAAE,WAAW,CAAC,MAAM,EAAE,SAAS,UAAU,EAAE,CAAC,CAAA;IACxE;;qDAEiD;IACjD,QAAQ,CAAC,mBAAmB,EAAE,OAAO,CAAA;CACtC;AAYD,8KAA8K;AAC9K,UAAU,cAAc;IACtB,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAA;IAC1B,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAA;IACzB,QAAQ,CAAC,WAAW,EAAE,EAAE,CAAC,mBAAmB,CAAA;CAC7C;AAqGD;;;;;;;;;GASG;AACH,mDAAmD;AACnD,wBAAgB,uBAAuB,CAAC,UAAU,EAAE,EAAE,CAAC,UAAU,GAAG;IAClE,QAAQ,CAAC,iBAAiB,EAAE,WAAW,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IACvD,QAAQ,CAAC,aAAa,EAAE,WAAW,CAAC,MAAM,CAAC,CAAA;IAC3C,QAAQ,CAAC,oBAAoB,EAAE,SAAS,cAAc,EAAE,CAAA;CACzD,CAiBA;AA4ED,wBAAgB,uBAAuB,CAAC,QAAQ,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,GAAG,cAAc,CAgK5F"}
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* The canonical ordering every fact model's contract list is sorted by: `file`
|
|
3
|
+
* (root-relative, POSIX) then `exportName`. One definition so `JSON.stringify`
|
|
4
|
+
* output is stable and diffs cleanly across Contract / Ownership / Lifecycle /
|
|
5
|
+
* Dependency Models. Internal: not re-exported from the public `.` barrel.
|
|
6
|
+
*/
|
|
7
|
+
export declare function byContractIdentity(a: {
|
|
8
|
+
readonly file: string;
|
|
9
|
+
readonly exportName: string;
|
|
10
|
+
}, b: {
|
|
11
|
+
readonly file: string;
|
|
12
|
+
readonly exportName: string;
|
|
13
|
+
}): number;
|
|
14
|
+
//# sourceMappingURL=sort-by-identity.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"sort-by-identity.d.ts","sourceRoot":"","sources":["../../../src/build/sort-by-identity.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,wBAAgB,kBAAkB,CAChC,CAAC,EAAE;IAAE,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IAAC,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAA;CAAE,EACzD,CAAC,EAAE;IAAE,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IAAC,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAA;CAAE,GACxD,MAAM,CAER"}
|
|
@@ -0,0 +1,69 @@
|
|
|
1
|
+
import type ts from "@typescript/typescript6";
|
|
2
|
+
/**
|
|
3
|
+
* A precise pointer into a source file. Every exact-position fact in the build pipeline
|
|
4
|
+
* (declaration sites, usage sites, dynamic-access sites) shares this shape. So a consumer never
|
|
5
|
+
* has to reconcile three ad hoc `{ file; line; column }` shapes that happen to mean the same
|
|
6
|
+
* thing. See ADR 0036.
|
|
7
|
+
*/
|
|
8
|
+
export interface SourcePosition {
|
|
9
|
+
/** Root-relative, POSIX-separated. */
|
|
10
|
+
readonly file: string;
|
|
11
|
+
/** 1-indexed line number. */
|
|
12
|
+
readonly line: number;
|
|
13
|
+
/** 1-indexed column number. */
|
|
14
|
+
readonly column: number;
|
|
15
|
+
}
|
|
16
|
+
/**
|
|
17
|
+
* `node`'s starting line/column within `sourceFile`, both 1-indexed: TypeScript's own
|
|
18
|
+
* `getLineAndCharacterOfPosition()` returns 0-indexed values for both. Callers combine this with
|
|
19
|
+
* the file path they already have in scope to build a full {@link SourcePosition}; this returns
|
|
20
|
+
* only the two numbers so it's usable identically whether the caller's `file` is already
|
|
21
|
+
* root-relative or still absolute.
|
|
22
|
+
*/
|
|
23
|
+
export declare function positionOf(sourceFile: ts.SourceFile, node: ts.Node): {
|
|
24
|
+
line: number;
|
|
25
|
+
column: number;
|
|
26
|
+
};
|
|
27
|
+
/**
|
|
28
|
+
* Parses a developer-supplied `"<relative-path>:<line>:<column>"` citation
|
|
29
|
+
* (a {@link runtime.VariableEvidenceDocs.dynamicAccess} entry) into a
|
|
30
|
+
* {@link SourcePosition}. Splits on the *last* two colons so a path
|
|
31
|
+
* containing colons of its own (rare, but not impossible) still parses:
|
|
32
|
+
* only the trailing `:<line>:<column>` is treated as position syntax.
|
|
33
|
+
* Returns `undefined` for anything that isn't exactly that shape (missing
|
|
34
|
+
* segments, a non-positive-integer line/column, an empty path): callers
|
|
35
|
+
* treat that as a malformed citation, never a thrown error. See ADR 0037.
|
|
36
|
+
*/
|
|
37
|
+
export declare function parsePositionCitation(citation: string): SourcePosition | undefined;
|
|
38
|
+
/**
|
|
39
|
+
* One developer-declared {@link runtime.VariableEvidenceDocs.dynamicAccess} citation's
|
|
40
|
+
* current acknowledgment state: a claim, never an observation. Kept fully
|
|
41
|
+
* separate from `VariableAccessStatus` (which stays exactly 3-valued and
|
|
42
|
+
* purely AST-derived) so a developer's assertion can never make env-cap
|
|
43
|
+
* claim it observed something it didn't. See
|
|
44
|
+
* `evidence-snapshot.ts`'s `computeDynamicAccessAcknowledgments()` (where
|
|
45
|
+
* this is computed) and ADR 0037.
|
|
46
|
+
*/
|
|
47
|
+
export interface DynamicAccessAssertion extends SourcePosition {
|
|
48
|
+
/**
|
|
49
|
+
* `"fresh"`: the cited file currently exists and either matches the
|
|
50
|
+
* committed baseline hash or has no baseline yet (a brand-new citation,
|
|
51
|
+
* nothing to contradict it yet). `"stale"`: the cited file exists but its
|
|
52
|
+
* content has changed since the committed baseline. `"missing"`: the
|
|
53
|
+
* cited file no longer exists at all. Re-derived from scratch every run;
|
|
54
|
+
* never cached across runs.
|
|
55
|
+
*/
|
|
56
|
+
readonly acknowledgment: "fresh" | "stale" | "missing";
|
|
57
|
+
/**
|
|
58
|
+
* SHA-256 hex digest of the cited file's content *as observed this run*:
|
|
59
|
+
* `undefined` iff `acknowledgment === "missing"` (nothing to hash). This is
|
|
60
|
+
* the one field that makes freshness checking possible without a
|
|
61
|
+
* snapshot-only shadow type. The live `EvidenceModel.dependency` a caller
|
|
62
|
+
* gets back has the exact same shape as the persisted evidence snapshot a
|
|
63
|
+
* later run reads back as its baseline. So this run's `contentHash` becomes
|
|
64
|
+
* next run's comparison target directly. See `evidence-snapshot.ts` and
|
|
65
|
+
* ADR 0037.
|
|
66
|
+
*/
|
|
67
|
+
readonly contentHash: string | undefined;
|
|
68
|
+
}
|
|
69
|
+
//# sourceMappingURL=source-position.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"source-position.d.ts","sourceRoot":"","sources":["../../../src/build/source-position.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,YAAY,CAAA;AAEhC;;;;;GAKG;AACH,MAAM,WAAW,cAAc;IAC7B,sCAAsC;IACtC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;IACrB,6BAA6B;IAC7B,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;IACrB,+BAA+B;IAC/B,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAA;CACxB;AAED;;;;;;GAMG;AACH,wBAAgB,UAAU,CACxB,UAAU,EAAE,EAAE,CAAC,UAAU,EACzB,IAAI,EAAE,EAAE,CAAC,IAAI,GACZ;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,MAAM,CAAA;CAAE,CAGlC;AAED;;;;;;;;;GASG;AACH,wBAAgB,qBAAqB,CAAC,QAAQ,EAAE,MAAM,GAAG,cAAc,GAAG,SAAS,CAQlF;AAED;;;;;;;;GAQG;AACH,MAAM,WAAW,sBAAuB,SAAQ,cAAc;IAC5D;;;;;;;OAOG;IACH,QAAQ,CAAC,cAAc,EAAE,OAAO,GAAG,OAAO,GAAG,SAAS,CAAA;IACtD;;;;;;;;;OASG;IACH,QAAQ,CAAC,WAAW,EAAE,MAAM,GAAG,SAAS,CAAA;CACzC"}
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* env-cap's own installed version: stamped onto
|
|
3
|
+
* `EvidenceModel.provenance.toolVersion` and mixed into
|
|
4
|
+
* `computeSourceFingerprint()`. `./build` never reads its own manifest from
|
|
5
|
+
* disk (ADR 0040).
|
|
6
|
+
*/
|
|
7
|
+
export declare function readToolVersion(): string;
|
|
8
|
+
//# sourceMappingURL=tool-version.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"tool-version.d.ts","sourceRoot":"","sources":["../../../src/build/tool-version.ts"],"names":[],"mappings":"AASA;;;;;GAKG;AACH,wBAAgB,eAAe,IAAI,MAAM,CAExC"}
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* The filesystem capability `./build` requires from its caller, and the two small structural types it returns.
|
|
3
|
+
* Defined once in `../_ipc/build-fs.ts`, a managed copy of internal-package-contract's `runtime/build-fs.ts`, and
|
|
4
|
+
* re-exported here so the public `build` entry keeps exporting them. See ADR 0040.
|
|
5
|
+
*/
|
|
6
|
+
export type { BuildDirent, BuildFileSystem, BuildStats } from "../_ipc/build-fs.js";
|
|
7
|
+
//# sourceMappingURL=types.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/build/types.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,YAAY,EAAE,WAAW,EAAE,eAAe,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAA"}
|
|
@@ -0,0 +1,6 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* The TypeScript compiler the build-time scanner parses with. The behavior lives in `../_ipc/typescript.ts`, a
|
|
3
|
+
* managed copy of internal-package-contract's `runtime/typescript.ts`.
|
|
4
|
+
*/
|
|
5
|
+
export { ts } from "../_ipc/typescript.js";
|
|
6
|
+
//# sourceMappingURL=typescript.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"typescript.d.ts","sourceRoot":"","sources":["../../../src/build/typescript.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,OAAO,EAAE,EAAE,EAAE,MAAM,uBAAuB,CAAA"}
|
|
@@ -0,0 +1,124 @@
|
|
|
1
|
+
import type { ScannedSurface } from "./dependency-graph.js";
|
|
2
|
+
import type { DynamicAccessCitationProblem } from "./citation-verification.js";
|
|
3
|
+
import type { ParseWarning } from "./parse.js";
|
|
4
|
+
import type { DynamicAccessAssertion, SourcePosition } from "./source-position.js";
|
|
5
|
+
/** One contract's dependency-ownership summary: who owns it, and who depends on it. */
|
|
6
|
+
export interface OwnershipDependencyEntry {
|
|
7
|
+
/** Resolved display name (see {@link DiscoveredContract.contractName}). */
|
|
8
|
+
readonly contractName: string;
|
|
9
|
+
/** Root-relative path of the file declaring the contract. */
|
|
10
|
+
readonly file: string;
|
|
11
|
+
/** Contract-level default owner, if set. */
|
|
12
|
+
readonly owner: string | undefined;
|
|
13
|
+
/** Number of variables declared in this contract's schema. */
|
|
14
|
+
readonly variableCount: number;
|
|
15
|
+
/** Files coupled to this contract (imported it, referenced it, or read a
|
|
16
|
+
* member from it): contract-level "who depends on this," NOT proof any
|
|
17
|
+
* specific variable was read. Blast radius if this contract changes is
|
|
18
|
+
* `consumers.length`, computed by callers/renderers on demand rather than
|
|
19
|
+
* stored redundantly here. */
|
|
20
|
+
readonly consumers: readonly string[];
|
|
21
|
+
}
|
|
22
|
+
/** A contract never imported anywhere in the scanned repository. */
|
|
23
|
+
export interface AbandonedContractFinding {
|
|
24
|
+
/** Resolved display name (see {@link DiscoveredContract.contractName}). */
|
|
25
|
+
readonly contractName: string;
|
|
26
|
+
/** Root-relative path of the file declaring the contract. */
|
|
27
|
+
readonly file: string;
|
|
28
|
+
/** Contract-level default owner, if set. */
|
|
29
|
+
readonly owner: string | undefined;
|
|
30
|
+
}
|
|
31
|
+
/** A contract reachable only through an unresolved barrel re-export: can't be proven abandoned or consumed. */
|
|
32
|
+
export interface UnresolvedConsumerFinding {
|
|
33
|
+
/** Resolved display name (see {@link DiscoveredContract.contractName}). */
|
|
34
|
+
readonly contractName: string;
|
|
35
|
+
/** Root-relative path of the file declaring the contract. */
|
|
36
|
+
readonly file: string;
|
|
37
|
+
/** Human-readable explanation of why usage couldn't be resolved. */
|
|
38
|
+
readonly reason: string;
|
|
39
|
+
}
|
|
40
|
+
/** An owned variable with no consumer found in the scanned repository. */
|
|
41
|
+
export interface UnconsumedOwnedVariableFinding {
|
|
42
|
+
/** Resolved display name (see {@link DiscoveredContract.contractName}). */
|
|
43
|
+
readonly contractName: string;
|
|
44
|
+
/** The owning contract's default owner, if set. */
|
|
45
|
+
readonly owner: string | undefined;
|
|
46
|
+
/** The unconsumed environment variable name. */
|
|
47
|
+
readonly key: string;
|
|
48
|
+
/**
|
|
49
|
+
* Every `dynamicAccess` citation for this variable that's currently
|
|
50
|
+
* `"stale"` or `"missing"` (empty when none exist: see ADR 0037).
|
|
51
|
+
* Empty is the *strongest* "looks unused" signal: no developer has ever
|
|
52
|
+
* claimed otherwise. A non-empty list means someone specifically claimed
|
|
53
|
+
* dynamic access here once, and that claim can no longer be verified. That
|
|
54
|
+
* is worth a human check before deleting, not a stronger reason to trust
|
|
55
|
+
* "unconsumed." The list holds the raw citations, not a collapsed
|
|
56
|
+
* `high`/`low` label, matching this codebase's "show the receipt" pattern
|
|
57
|
+
* (ADR 0036/0037). A reader can judge confidence from the actual evidence
|
|
58
|
+
* rather than trusting a derived summary. See ADR 0038.
|
|
59
|
+
*/
|
|
60
|
+
readonly staleOrMissingCitations: readonly DynamicAccessCitationProblem[];
|
|
61
|
+
}
|
|
62
|
+
/** A variable accessed only via dynamic (computed) property access: usage cannot be determined statically. */
|
|
63
|
+
export interface IndeterminateOwnershipFinding {
|
|
64
|
+
/** Resolved display name (see {@link DiscoveredContract.contractName}). */
|
|
65
|
+
readonly contractName: string;
|
|
66
|
+
/** The environment variable name. */
|
|
67
|
+
readonly key: string;
|
|
68
|
+
/** Human-readable explanation of why usage couldn't be determined. */
|
|
69
|
+
readonly reason: string;
|
|
70
|
+
/** Every AST-observed dynamic-access site backing `reason`, structured: see ADR 0036. */
|
|
71
|
+
readonly dynamicAccessSites: readonly SourcePosition[];
|
|
72
|
+
/** See {@link UnconsumedOwnedVariableFinding.staleOrMissingCitations}. */
|
|
73
|
+
readonly staleOrMissingCitations: readonly DynamicAccessCitationProblem[];
|
|
74
|
+
}
|
|
75
|
+
/** 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. */
|
|
76
|
+
export interface AssertedDynamicAccessFinding {
|
|
77
|
+
/** Resolved display name (see {@link DiscoveredContract.contractName}). */
|
|
78
|
+
readonly contractName: string;
|
|
79
|
+
/** The environment variable name. */
|
|
80
|
+
readonly key: string;
|
|
81
|
+
/** What this variable's status would be without the fresh assertion. */
|
|
82
|
+
readonly wouldBeStatus: "unconsumed" | "indeterminate";
|
|
83
|
+
/** Every citation covering this variable, each with its own current freshness. */
|
|
84
|
+
readonly dynamicAccessAssertions: readonly DynamicAccessAssertion[];
|
|
85
|
+
}
|
|
86
|
+
/** Everything {@link renderUsageReport} needs to render the Dependency &
|
|
87
|
+
* Ownership Report: deliberately independent of (not derived from)
|
|
88
|
+
* `GenerateUsageReportResult` in `generate-usage.js`, the same way
|
|
89
|
+
* `RenderDocsOptions` in `docs.ts` doesn't derive from
|
|
90
|
+
* `GenerateDocumentationResult`. `generate-usage.ts` composes its own
|
|
91
|
+
* public result type from these building blocks instead, keeping this
|
|
92
|
+
* renderer module importable without its orchestrator. */
|
|
93
|
+
export interface RenderUsageReportOptions {
|
|
94
|
+
/** Every contract's ownership/dependency summary. */
|
|
95
|
+
readonly dependencyOwnership: readonly OwnershipDependencyEntry[];
|
|
96
|
+
/** Contracts never imported anywhere in the scanned repository. */
|
|
97
|
+
readonly abandonedContracts: readonly AbandonedContractFinding[];
|
|
98
|
+
/** Advisory only, never gates `onOwnershipIssue`: a contract only
|
|
99
|
+
* reaches here when an ambiguous barrel re-export makes "abandoned" or
|
|
100
|
+
* "consumed" both unprovable. */
|
|
101
|
+
readonly unresolvedConsumers: readonly UnresolvedConsumerFinding[];
|
|
102
|
+
/** Owned variables with no consumer found in the scanned repository. */
|
|
103
|
+
readonly unconsumedOwnedVariables: readonly UnconsumedOwnedVariableFinding[];
|
|
104
|
+
/** Variables accessed only via dynamic (computed) property access. */
|
|
105
|
+
readonly indeterminate: readonly IndeterminateOwnershipFinding[];
|
|
106
|
+
/** Variables a developer has re-acknowledged via `dynamicAccess`, freshly: see ADR 0037. */
|
|
107
|
+
readonly asserted: readonly AssertedDynamicAccessFinding[];
|
|
108
|
+
/** Schema-discovery parse warnings plus, since ADR 0014, any `packages`
|
|
109
|
+
* resolution failures: surfaced here too (not just from
|
|
110
|
+
* `generateEnvManifest`/`generateDocumentation`) so a team relying only
|
|
111
|
+
* on `--ownership` output still learns when a cross-package contract
|
|
112
|
+
* failed to resolve. */
|
|
113
|
+
readonly parseWarnings: readonly ParseWarning[];
|
|
114
|
+
/** 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. */
|
|
115
|
+
readonly scannedSurfaces: readonly ScannedSurface[];
|
|
116
|
+
}
|
|
117
|
+
/**
|
|
118
|
+
* Renders the Dependency & Ownership Report: who owns each variable, which
|
|
119
|
+
* features consume each contract, and what the blast radius is if it
|
|
120
|
+
* changes; structured around exactly those three questions, never generic
|
|
121
|
+
* "dead code"/"unused symbol" language.
|
|
122
|
+
*/
|
|
123
|
+
export declare function renderUsageReport(computed: RenderUsageReportOptions): string;
|
|
124
|
+
//# sourceMappingURL=usage-report.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"usage-report.d.ts","sourceRoot":"","sources":["../../../src/build/usage-report.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAA;AAC3D,OAAO,KAAK,EAAE,4BAA4B,EAAE,MAAM,4BAA4B,CAAA;AAO9E,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,YAAY,CAAA;AAC9C,OAAO,KAAK,EAAE,sBAAsB,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAA;AAElF,uFAAuF;AACvF,MAAM,WAAW,wBAAwB;IACvC,2EAA2E;IAC3E,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAA;IAC7B,6DAA6D;IAC7D,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;IACrB,4CAA4C;IAC5C,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,SAAS,CAAA;IAClC,8DAA8D;IAC9D,QAAQ,CAAC,aAAa,EAAE,MAAM,CAAA;IAC9B;;;;mCAI+B;IAC/B,QAAQ,CAAC,SAAS,EAAE,SAAS,MAAM,EAAE,CAAA;CACtC;AAED,oEAAoE;AACpE,MAAM,WAAW,wBAAwB;IACvC,2EAA2E;IAC3E,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAA;IAC7B,6DAA6D;IAC7D,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;IACrB,4CAA4C;IAC5C,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,SAAS,CAAA;CACnC;AACD,+GAA+G;AAC/G,MAAM,WAAW,yBAAyB;IACxC,2EAA2E;IAC3E,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAA;IAC7B,6DAA6D;IAC7D,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;IACrB,oEAAoE;IACpE,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAA;CACxB;AACD,0EAA0E;AAC1E,MAAM,WAAW,8BAA8B;IAC7C,2EAA2E;IAC3E,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAA;IAC7B,mDAAmD;IACnD,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,SAAS,CAAA;IAClC,gDAAgD;IAChD,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAA;IACpB;;;;;;;;;;;OAWG;IACH,QAAQ,CAAC,uBAAuB,EAAE,SAAS,4BAA4B,EAAE,CAAA;CAC1E;AACD,8GAA8G;AAC9G,MAAM,WAAW,6BAA6B;IAC5C,2EAA2E;IAC3E,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAA;IAC7B,qCAAqC;IACrC,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAA;IACpB,sEAAsE;IACtE,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAA;IACvB,yFAAyF;IACzF,QAAQ,CAAC,kBAAkB,EAAE,SAAS,cAAc,EAAE,CAAA;IACtD,0EAA0E;IAC1E,QAAQ,CAAC,uBAAuB,EAAE,SAAS,4BAA4B,EAAE,CAAA;CAC1E;AACD,6QAA6Q;AAC7Q,MAAM,WAAW,4BAA4B;IAC3C,2EAA2E;IAC3E,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAA;IAC7B,qCAAqC;IACrC,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAA;IACpB,wEAAwE;IACxE,QAAQ,CAAC,aAAa,EAAE,YAAY,GAAG,eAAe,CAAA;IACtD,kFAAkF;IAClF,QAAQ,CAAC,uBAAuB,EAAE,SAAS,sBAAsB,EAAE,CAAA;CACpE;AAED;;;;;;2DAM2D;AAC3D,MAAM,WAAW,wBAAwB;IACvC,qDAAqD;IACrD,QAAQ,CAAC,mBAAmB,EAAE,SAAS,wBAAwB,EAAE,CAAA;IACjE,mEAAmE;IACnE,QAAQ,CAAC,kBAAkB,EAAE,SAAS,wBAAwB,EAAE,CAAA;IAChE;;sCAEkC;IAClC,QAAQ,CAAC,mBAAmB,EAAE,SAAS,yBAAyB,EAAE,CAAA;IAClE,wEAAwE;IACxE,QAAQ,CAAC,wBAAwB,EAAE,SAAS,8BAA8B,EAAE,CAAA;IAC5E,sEAAsE;IACtE,QAAQ,CAAC,aAAa,EAAE,SAAS,6BAA6B,EAAE,CAAA;IAChE,4FAA4F;IAC5F,QAAQ,CAAC,QAAQ,EAAE,SAAS,4BAA4B,EAAE,CAAA;IAC1D;;;;6BAIyB;IACzB,QAAQ,CAAC,aAAa,EAAE,SAAS,YAAY,EAAE,CAAA;IAC/C,4MAA4M;IAC5M,QAAQ,CAAC,eAAe,EAAE,SAAS,cAAc,EAAE,CAAA;CACpD;AAsJD;;;;;GAKG;AACH,wBAAgB,iBAAiB,CAAC,QAAQ,EAAE,wBAAwB,GAAG,MAAM,CAuB5E"}
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
import type { BuildFileSystem } from "../build/types.js";
|
|
2
|
+
/**
|
|
3
|
+
* The Node-backed `BuildFileSystem`: the filesystem capability the build-time generators require.
|
|
4
|
+
* @public
|
|
5
|
+
*/
|
|
6
|
+
export declare const nodeBuildFileSystem: BuildFileSystem;
|
|
7
|
+
//# sourceMappingURL=filesystem.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"filesystem.d.ts","sourceRoot":"","sources":["../../../src/cli/filesystem.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAe,eAAe,EAAc,MAAM,mBAAmB,CAAA;AAiDjF;;;GAGG;AACH,eAAO,MAAM,mBAAmB,EAAE,eAO9B,CAAA"}
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Matching of the plugin's `allow` options against the file a rule is checking. The behavior lives in
|
|
3
|
+
* `../_ipc/glob.ts`, a managed copy of internal-package-contract's `runtime/glob.ts`: a pattern written relative to
|
|
4
|
+
* the working directory (`src/cli/**`) matches the absolute path ESLint passes, on Windows too.
|
|
5
|
+
*/
|
|
6
|
+
export { matchesAllowList } from "../_ipc/glob.js";
|
|
7
|
+
//# sourceMappingURL=glob.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"glob.d.ts","sourceRoot":"","sources":["../../../src/eslint-plugin/glob.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,OAAO,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAA"}
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Lint rules that keep environment reads inside contracts (`@maverickcer/env-cap/eslint-plugin`).
|
|
3
|
+
*
|
|
4
|
+
* `no-raw-process-env` flags direct `process.env` reads outside `env.schema.ts` files. `no-node-fs` flags
|
|
5
|
+
* `node:fs` imports in library code, which should take its file system from the caller. The plugin runs
|
|
6
|
+
* inside the project's own ESLint; CI runs the rules on ESLint 10 only.
|
|
7
|
+
*
|
|
8
|
+
* @packageDocumentation
|
|
9
|
+
*/
|
|
10
|
+
import { noNodeFs } from "./no-node-fs.js";
|
|
11
|
+
import { noRawProcessEnv } from "./no-raw-process-env.js";
|
|
12
|
+
/**
|
|
13
|
+
* The ESLint plugin, as a flat-config plugin object (`{ rules }`). Register it under the `env-cap`
|
|
14
|
+
* prefix:
|
|
15
|
+
*
|
|
16
|
+
* ```js
|
|
17
|
+
* import envCapPlugin from "@maverickcer/env-cap/eslint-plugin"
|
|
18
|
+
* export default [{ plugins: { "env-cap": envCapPlugin }, rules: { "env-cap/no-raw-process-env": "error" } }]
|
|
19
|
+
* ```
|
|
20
|
+
*
|
|
21
|
+
* ADR 0017 explains why the rules ship as their own entry point.
|
|
22
|
+
*/
|
|
23
|
+
declare const plugin: {
|
|
24
|
+
/** Every rule this plugin ships, keyed by its flat-config rule name. */
|
|
25
|
+
rules: {
|
|
26
|
+
/** See {@link noRawProcessEnv}. */
|
|
27
|
+
"no-raw-process-env": import("@typescript-eslint/utils/ts-eslint").RuleModule<"noRawProcessEnv", [import("./no-raw-process-env.js").RuleOptions], unknown, import("@typescript-eslint/utils/ts-eslint").RuleListener> & {
|
|
28
|
+
name: string;
|
|
29
|
+
};
|
|
30
|
+
/** See {@link noNodeFs}. */
|
|
31
|
+
"no-node-fs": import("@typescript-eslint/utils/ts-eslint").RuleModule<"noNodeFs", [import("../_ipc/no-node-fs.js").RuleOptions], unknown, import("@typescript-eslint/utils/ts-eslint").RuleListener> & {
|
|
32
|
+
name: string;
|
|
33
|
+
};
|
|
34
|
+
};
|
|
35
|
+
};
|
|
36
|
+
export default plugin;
|
|
37
|
+
export { noNodeFs, noRawProcessEnv };
|
|
38
|
+
//# sourceMappingURL=index.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/eslint-plugin/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AACH,OAAO,EAAE,QAAQ,EAAE,MAAM,iBAAiB,CAAA;AAC1C,OAAO,EAAE,eAAe,EAAE,MAAM,yBAAyB,CAAA;AAEzD;;;;;;;;;;GAUG;AACH,QAAA,MAAM,MAAM;IACV,wEAAwE;;QAEtE,mCAAmC;;;;QAEnC,4BAA4B;;;;;CAG/B,CAAA;AACD,eAAe,MAAM,CAAA;AACrB,OAAO,EAAE,QAAQ,EAAE,eAAe,EAAE,CAAA"}
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Flags any `import`/`require`/dynamic `import()` of `node:fs` in library code, so a library surface acquires
|
|
3
|
+
* its filesystem capability from the caller instead of reaching for `node:fs` itself.
|
|
4
|
+
*
|
|
5
|
+
* @remarks
|
|
6
|
+
* Nothing is exempt by default. A package's own config allows its CLI folder (for example `src/cli/**`),
|
|
7
|
+
* which builds the `node:fs/promises` adapter, and a consuming project sets the `allow` option for its own CLI
|
|
8
|
+
* or script entry points. The rule itself lives in `../_ipc/no-node-fs.ts`, a managed copy of
|
|
9
|
+
* internal-package-contract's `runtime/no-node-fs.ts`; this supplies env-cap's documentation link and the decision
|
|
10
|
+
* record the message cites.
|
|
11
|
+
*/
|
|
12
|
+
export declare const noNodeFs: import("@typescript-eslint/utils/ts-eslint").RuleModule<"noNodeFs", [import("../_ipc/no-node-fs.js").RuleOptions], unknown, import("@typescript-eslint/utils/ts-eslint").RuleListener> & {
|
|
13
|
+
name: string;
|
|
14
|
+
};
|
|
15
|
+
//# sourceMappingURL=no-node-fs.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"no-node-fs.d.ts","sourceRoot":"","sources":["../../../src/eslint-plugin/no-node-fs.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;GAUG;AACH,eAAO,MAAM,QAAQ;;CAInB,CAAA"}
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
export interface RuleOptions {
|
|
2
|
+
/** Glob-array of files this rule doesn't apply to, beyond the built-in
|
|
3
|
+
* env.schema.ts allowance below. It is for a consuming project's own
|
|
4
|
+
* Node-only, build-time bootstrap code. The README section this rule
|
|
5
|
+
* ships with has the canonical worked example: a live-expiration
|
|
6
|
+
* resolver authenticating to a secrets manager. Empty by default:
|
|
7
|
+
* MUST be populated explicitly by the consuming project; env-cap never
|
|
8
|
+
* guesses at what counts as "trusted bootstrap code." */
|
|
9
|
+
allow?: string[];
|
|
10
|
+
}
|
|
11
|
+
/**
|
|
12
|
+
* Flags any direct `process.env.X`/`process.env["X"]` read in application code, so environment
|
|
13
|
+
* access always goes through a capability's own `createEnv()` contract instead.
|
|
14
|
+
*
|
|
15
|
+
* @remarks
|
|
16
|
+
* `env.schema.ts`/`env.schema.tsx` files are always exempt (that's where `createEnv()` itself
|
|
17
|
+
* reads `process.env`); the rule's `allow` option extends that exemption to a consuming
|
|
18
|
+
* project's own trusted bootstrap code.
|
|
19
|
+
*/
|
|
20
|
+
export declare const noRawProcessEnv: import("@typescript-eslint/utils/ts-eslint").RuleModule<"noRawProcessEnv", [RuleOptions], unknown, import("@typescript-eslint/utils/ts-eslint").RuleListener> & {
|
|
21
|
+
name: string;
|
|
22
|
+
};
|
|
23
|
+
//# sourceMappingURL=no-raw-process-env.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"no-raw-process-env.d.ts","sourceRoot":"","sources":["../../../src/eslint-plugin/no-raw-process-env.ts"],"names":[],"mappings":"AAWA,MAAM,WAAW,WAAW;IAC1B;;;;;;8DAM0D;IAC1D,KAAK,CAAC,EAAE,MAAM,EAAE,CAAA;CACjB;AAaD;;;;;;;;GAQG;AACH,eAAO,MAAM,eAAe;;CA4C1B,CAAA"}
|
|
@@ -0,0 +1,51 @@
|
|
|
1
|
+
import type { EvidenceModel } from "../build/evidence-model.js";
|
|
2
|
+
/**
|
|
3
|
+
* A pure function from the full Evidence Model to one field of a
|
|
4
|
+
* projection's output shape. Must not mutate `evidence` (the membrane
|
|
5
|
+
* `defineEvidenceProjection()` wraps it in enforces that at runtime, see
|
|
6
|
+
* `createTrackingProxy()` below) and must not perform I/O; env-cap can
|
|
7
|
+
* enforce the read-only half of purity but not the "no side effects" half.
|
|
8
|
+
*/
|
|
9
|
+
export type EvidenceProjector<T> = (evidence: EvidenceModel) => T;
|
|
10
|
+
/** One independent, pure projector function per key of the projection's output shape `T`. */
|
|
11
|
+
export type EvidenceProjectionSchema<T extends Record<string, unknown>> = {
|
|
12
|
+
readonly [K in keyof T]: EvidenceProjector<T[K]>;
|
|
13
|
+
};
|
|
14
|
+
/** `project()`'s return shape: the computed output, plus which `EvidenceModel` field paths fed each output key. */
|
|
15
|
+
export interface EvidenceProjectionResult<T extends Record<string, unknown>> {
|
|
16
|
+
readonly value: T;
|
|
17
|
+
readonly sources: Readonly<Record<keyof T, readonly string[]>>;
|
|
18
|
+
}
|
|
19
|
+
/**
|
|
20
|
+
* The function `defineEvidenceProjection()` returns. Callable directly for
|
|
21
|
+
* the common case (`projection(evidence)` -> `T`); `.project()` returns the
|
|
22
|
+
* same value alongside automatic provenance: see ADR 0032.
|
|
23
|
+
*/
|
|
24
|
+
export interface EvidenceProjection<T extends Record<string, unknown>> {
|
|
25
|
+
(evidence: EvidenceModel): T;
|
|
26
|
+
/** Same computation as calling the projection directly, plus which `EvidenceModel` field paths fed each output key: see {@link EvidenceProjectionResult}. */
|
|
27
|
+
project(evidence: EvidenceModel): EvidenceProjectionResult<T>;
|
|
28
|
+
}
|
|
29
|
+
/**
|
|
30
|
+
* Declares a projection: a named, pure transform from the immutable
|
|
31
|
+
* `EvidenceModel` to any consumer-defined output shape, built entirely from
|
|
32
|
+
* `schema`'s independent per-field projector functions; see ADR 0031/0032.
|
|
33
|
+
*
|
|
34
|
+
* The reference projections env-cap ships (`.env.example`, Environment
|
|
35
|
+
* Configuration Reference, Configuration Ownership, etc.) are built through
|
|
36
|
+
* this exact function, with no privileged internal path. A consumer's own
|
|
37
|
+
* projection is a first-class citizen, not a lesser one.
|
|
38
|
+
*/
|
|
39
|
+
export declare function defineEvidenceProjection<T extends Record<string, unknown>>(schema: EvidenceProjectionSchema<T>): EvidenceProjection<T>;
|
|
40
|
+
/**
|
|
41
|
+
* The error every membrane write-trap below throws.
|
|
42
|
+
*
|
|
43
|
+
* @remarks
|
|
44
|
+
* It is a function, not a module-level `const`, because Stryker's `perTest`
|
|
45
|
+
* coverage cannot attribute a module-load string to the test that covers it.
|
|
46
|
+
* It is exported so a test can pin the exact message. A trap's
|
|
47
|
+
* `.toThrow(TypeError)` cannot: a mutated trap body still throws the engine's
|
|
48
|
+
* own Proxy invariant `TypeError`.
|
|
49
|
+
*/
|
|
50
|
+
export declare function readOnlyMembraneError(): TypeError;
|
|
51
|
+
//# sourceMappingURL=define-projection.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"define-projection.d.ts","sourceRoot":"","sources":["../../../src/evidence/define-projection.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAA;AAE/D;;;;;;GAMG;AACH,MAAM,MAAM,iBAAiB,CAAC,CAAC,IAAI,CAAC,QAAQ,EAAE,aAAa,KAAK,CAAC,CAAA;AAEjE,6FAA6F;AAC7F,MAAM,MAAM,wBAAwB,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,IAAI;IACxE,QAAQ,EAAE,CAAC,IAAI,MAAM,CAAC,GAAG,iBAAiB,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;CACjD,CAAA;AAED,mHAAmH;AACnH,MAAM,WAAW,wBAAwB,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;IACzE,QAAQ,CAAC,KAAK,EAAE,CAAC,CAAA;IACjB,QAAQ,CAAC,OAAO,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC,CAAC,CAAA;CAC/D;AAED;;;;GAIG;AACH,MAAM,WAAW,kBAAkB,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;IACnE,CAAC,QAAQ,EAAE,aAAa,GAAG,CAAC,CAAA;IAC5B,6JAA6J;IAC7J,OAAO,CAAC,QAAQ,EAAE,aAAa,GAAG,wBAAwB,CAAC,CAAC,CAAC,CAAA;CAC9D;AAED;;;;;;;;;GASG;AACH,wBAAgB,wBAAwB,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EACxE,MAAM,EAAE,wBAAwB,CAAC,CAAC,CAAC,GAClC,kBAAkB,CAAC,CAAC,CAAC,CAkBvB;AAED;;;;;;;;;GASG;AACH,wBAAgB,qBAAqB,IAAI,SAAS,CAIjD"}
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Build your own views of the evidence file (`@maverickcer/env-cap/evidence`).
|
|
3
|
+
*
|
|
4
|
+
* `defineEvidenceProjection()` declares a pure transform from an `EvidenceModel` to a shape you define:
|
|
5
|
+
* a dashboard row, an inventory table or a CI comment. The projectors read the model
|
|
6
|
+
* through a read-only membrane, and `.project()` also returns which model fields fed each output field
|
|
7
|
+
* (ADR 0032). ADR 0031 explains why this is its own entry point.
|
|
8
|
+
*
|
|
9
|
+
* `generateEvidenceModel()` in `@maverickcer/env-cap/build` assembles the model at build time. This
|
|
10
|
+
* module imports no Node module and no TypeScript compiler, and takes the `EvidenceModel` shape as a
|
|
11
|
+
* type only. So a projection can run over a JSON-parsed evidence file outside Node; CI runs this
|
|
12
|
+
* entry under Bun, Deno and a Web-globals bundle.
|
|
13
|
+
*
|
|
14
|
+
* @packageDocumentation
|
|
15
|
+
*/
|
|
16
|
+
export type { EvidenceModel, EvidenceProvenance } from "../build/evidence-model.js";
|
|
17
|
+
export { defineEvidenceProjection } from "./define-projection.js";
|
|
18
|
+
export type { EvidenceProjection, EvidenceProjectionResult, EvidenceProjectionSchema, EvidenceProjector, } from "./define-projection.js";
|
|
19
|
+
//# sourceMappingURL=index.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/evidence/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AACH,YAAY,EAAE,aAAa,EAAE,kBAAkB,EAAE,MAAM,4BAA4B,CAAA;AACnF,OAAO,EAAE,wBAAwB,EAAE,MAAM,wBAAwB,CAAA;AACjE,YAAY,EACV,kBAAkB,EAClB,wBAAwB,EACxB,wBAAwB,EACxB,iBAAiB,GAClB,MAAM,wBAAwB,CAAA"}
|