@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
|
@@ -11,7 +11,7 @@ import { type AliasResolutionCache, type TsconfigPathsResolution } from "./resol
|
|
|
11
11
|
* Deliberately narrow: only handles a direct relative specifier resolving to
|
|
12
12
|
* a real `.ts`/`.tsx` file on disk. Bare/package specifiers, namespace
|
|
13
13
|
* imports, and anything requiring real module resolution (re-export chains,
|
|
14
|
-
* `exports` map lookups, etc.) return `undefined
|
|
14
|
+
* `exports` map lookups, etc.) return `undefined`: the caller treats that
|
|
15
15
|
* as "couldn't statically link" and warns rather than guesses, the same
|
|
16
16
|
* philosophy `evaluateLiteral` already uses for non-literal expressions.
|
|
17
17
|
*
|
|
@@ -25,17 +25,17 @@ export declare function resolveRelativeImport(importingFile: string, specifier:
|
|
|
25
25
|
export declare function fileExists(filePath: string, fs: BuildFileSystem): Promise<boolean>;
|
|
26
26
|
/** Shared inputs threaded through every call to {@link resolveImportSpecifier} for one discovery/link run. */
|
|
27
27
|
export interface ImportResolutionContext {
|
|
28
|
-
/** The filesystem capability
|
|
28
|
+
/** The filesystem capability: `./build` never imports `node:fs` (ADR 0040). */
|
|
29
29
|
readonly fs: BuildFileSystem;
|
|
30
30
|
/** Absolute path of the project root, used to resolve package specifiers. */
|
|
31
31
|
readonly root: string;
|
|
32
|
-
/** Explicit allowlist
|
|
32
|
+
/** Explicit allowlist: see ADR 0014. Empty/omitted means package resolution never fires, identical to today's behavior. */
|
|
33
33
|
readonly packages: readonly string[];
|
|
34
|
-
/** Memoizes package resolution per specifier across the whole run
|
|
34
|
+
/** Memoizes package resolution per specifier across the whole run: see `resolvePackageImport`'s own doc comment for why. */
|
|
35
35
|
readonly cache: Map<string, Promise<PackageSchemaResolutionResult>>;
|
|
36
|
-
/** Parsed `tsconfig.json` `paths`/`baseUrl`, or `undefined` when alias resolution found nothing to do or was disabled
|
|
36
|
+
/** Parsed `tsconfig.json` `paths`/`baseUrl`, or `undefined` when alias resolution found nothing to do or was disabled: see ADR 0023. */
|
|
37
37
|
readonly tsconfigPaths: TsconfigPathsResolution | undefined;
|
|
38
|
-
/** Memoizes alias resolution across the whole run
|
|
38
|
+
/** Memoizes alias resolution across the whole run: see `resolveAliasImport`'s own doc comment for why. Always allocated, even when `tsconfigPaths` is `undefined`, mirroring `cache` above. */
|
|
39
39
|
readonly aliasCache: AliasResolutionCache;
|
|
40
40
|
}
|
|
41
41
|
/**
|
|
@@ -45,14 +45,18 @@ export interface ImportResolutionContext {
|
|
|
45
45
|
* chain at every call site.
|
|
46
46
|
*
|
|
47
47
|
* @remarks
|
|
48
|
-
* Purely a composition point
|
|
49
|
-
*
|
|
50
|
-
*
|
|
51
|
-
*
|
|
52
|
-
* (ADR
|
|
53
|
-
*
|
|
54
|
-
*
|
|
55
|
-
*
|
|
48
|
+
* Purely a composition point: no new resolution logic lives here. It tries, in order:
|
|
49
|
+
*
|
|
50
|
+
* 1. The relative resolver (cheap, no `fs.stat` beyond the local filesystem check it
|
|
51
|
+
* already does).
|
|
52
|
+
* 2. tsconfig path-alias resolution (ADR 0023, on by default), for a bare specifier
|
|
53
|
+
* matching the project's own `tsconfig.json` `paths`/`baseUrl`.
|
|
54
|
+
* 3. Package resolution (ADR 0014), for a bare specifier matching an allow-listed
|
|
55
|
+
* package name.
|
|
56
|
+
*
|
|
57
|
+
* Alias resolution runs before package resolution because it resolves the consuming
|
|
58
|
+
* project's own local source (already-trusted, no versioning boundary). Relative
|
|
59
|
+
* resolution has the same precedence over package resolution.
|
|
56
60
|
*/
|
|
57
61
|
export declare function resolveImportSpecifier(importingFile: string, specifier: string, context: ImportResolutionContext): Promise<string | undefined>;
|
|
58
62
|
//# sourceMappingURL=resolve-import.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"resolve-import.d.ts","sourceRoot":"","sources":["../../../../src/build/resolution/resolve-import.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,aAAa,CAAA;AAClD,OAAO,EAEL,KAAK,6BAA6B,EACnC,MAAM,6BAA6B,CAAA;AACpC,OAAO,EAEL,KAAK,oBAAoB,EACzB,KAAK,uBAAuB,EAC7B,MAAM,6BAA6B,CAAA;AAEpC;;;;;;;;;;;;;;;GAeG;AACH,wBAAsB,qBAAqB,CACzC,aAAa,EAAE,MAAM,EACrB,SAAS,EAAE,MAAM,EACjB,EAAE,EAAE,eAAe,GAClB,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC,CAe7B;AAED;;;GAGG;AACH,wBAAgB,UAAU,CAAC,QAAQ,EAAE,MAAM,EAAE,EAAE,EAAE,eAAe,GAAG,OAAO,CAAC,OAAO,CAAC,CAKlF;AAED,8GAA8G;AAC9G,MAAM,WAAW,uBAAuB;IACtC
|
|
1
|
+
{"version":3,"file":"resolve-import.d.ts","sourceRoot":"","sources":["../../../../src/build/resolution/resolve-import.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,aAAa,CAAA;AAClD,OAAO,EAEL,KAAK,6BAA6B,EACnC,MAAM,6BAA6B,CAAA;AACpC,OAAO,EAEL,KAAK,oBAAoB,EACzB,KAAK,uBAAuB,EAC7B,MAAM,6BAA6B,CAAA;AAEpC;;;;;;;;;;;;;;;GAeG;AACH,wBAAsB,qBAAqB,CACzC,aAAa,EAAE,MAAM,EACrB,SAAS,EAAE,MAAM,EACjB,EAAE,EAAE,eAAe,GAClB,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC,CAe7B;AAED;;;GAGG;AACH,wBAAgB,UAAU,CAAC,QAAQ,EAAE,MAAM,EAAE,EAAE,EAAE,eAAe,GAAG,OAAO,CAAC,OAAO,CAAC,CAKlF;AAED,8GAA8G;AAC9G,MAAM,WAAW,uBAAuB;IACtC,+EAA+E;IAC/E,QAAQ,CAAC,EAAE,EAAE,eAAe,CAAA;IAC5B,6EAA6E;IAC7E,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;IACrB,2HAA2H;IAC3H,QAAQ,CAAC,QAAQ,EAAE,SAAS,MAAM,EAAE,CAAA;IACpC,4HAA4H;IAC5H,QAAQ,CAAC,KAAK,EAAE,GAAG,CAAC,MAAM,EAAE,OAAO,CAAC,6BAA6B,CAAC,CAAC,CAAA;IACnE,wIAAwI;IACxI,QAAQ,CAAC,aAAa,EAAE,uBAAuB,GAAG,SAAS,CAAA;IAC3D,+LAA+L;IAC/L,QAAQ,CAAC,UAAU,EAAE,oBAAoB,CAAA;CAC1C;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,wBAAsB,sBAAsB,CAC1C,aAAa,EAAE,MAAM,EACrB,SAAS,EAAE,MAAM,EACjB,OAAO,EAAE,uBAAuB,GAC/B,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC,CAe7B"}
|
|
@@ -1,12 +1,12 @@
|
|
|
1
1
|
import type { ParseWarning } from "../parse.js";
|
|
2
2
|
import type { BuildFileSystem } from "../types.js";
|
|
3
|
-
/** 1 MiB.
|
|
4
|
-
*
|
|
5
|
-
*
|
|
6
|
-
*
|
|
3
|
+
/** 1 MiB. Hardening specific to this trust tier. A package crosses a real
|
|
4
|
+
* versioning/trust boundary that locally-discovered source doesn't. So this
|
|
5
|
+
* caps the cost of an oversized or adversarial file before any of its
|
|
6
|
+
* content is read into memory. See ADR 0014. */
|
|
7
7
|
export declare const MAX_PACKAGE_SCHEMA_FILE_BYTES = 1048576;
|
|
8
8
|
type PackageResolutionFailureCode = "PACKAGE_NOT_FOUND" | "MALFORMED_PACKAGE_JSON" | "FIELD_MISSING" | "INVALID_EXTENSION" | "OUTSIDE_PACKAGE" | "FILE_TOO_LARGE";
|
|
9
|
-
/** Both the authored and resolved forms are kept
|
|
9
|
+
/** Both the authored and resolved forms are kept: diagnostics benefit from
|
|
10
10
|
* showing exactly what a package author wrote versus what it resolved to. */
|
|
11
11
|
export interface PackageOrigin {
|
|
12
12
|
/** The allow-listed package name that declared this schema. */
|
|
@@ -28,12 +28,12 @@ export type PackageSchemaResolutionResult = {
|
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
30
|
* Resolves one allow-listed package name. Memoized in a caller-owned
|
|
31
|
-
* `cache
|
|
32
|
-
* graph resolution
|
|
33
|
-
* scanned files bare-
|
|
34
|
-
* `packages`
|
|
35
|
-
*
|
|
36
|
-
*
|
|
31
|
+
* `cache`: one per `generate*()` invocation, shared with linking/dependency-
|
|
32
|
+
* graph resolution. So a name referenced from multiple places is resolved
|
|
33
|
+
* only once (e.g. several scanned files bare-import the same package, or
|
|
34
|
+
* `packages` has a duplicate entry). The cache holds the in-flight promise
|
|
35
|
+
* before it settles. So concurrent callers await the same resolution rather
|
|
36
|
+
* than racing duplicate work.
|
|
37
37
|
*/
|
|
38
38
|
export declare function resolvePackageSchemaFile(packageName: string, root: string, cache: Map<string, Promise<PackageSchemaResolutionResult>>, fs: BuildFileSystem): Promise<PackageSchemaResolutionResult>;
|
|
39
39
|
interface ResolvedPackageFile {
|
|
@@ -47,24 +47,25 @@ export interface ResolvePackagesResult {
|
|
|
47
47
|
readonly warnings: readonly ParseWarning[];
|
|
48
48
|
}
|
|
49
49
|
/**
|
|
50
|
-
* Resolves every allow-listed package name. Input is deduplicated first
|
|
51
|
-
* a duplicate entry in `packages` (accidental or defensive) produces
|
|
52
|
-
*
|
|
50
|
+
* Resolves every allow-listed package name. Input is deduplicated first. So
|
|
51
|
+
* a duplicate entry in `packages` (accidental or defensive) produces one
|
|
52
|
+
* resolution attempt and, on failure, one warning: never two.
|
|
53
53
|
* Never throws: every failure becomes one `ParseWarning`, consistent with
|
|
54
54
|
* every other static-analysis boundary in this codebase.
|
|
55
55
|
*/
|
|
56
56
|
export declare function resolveAllowlistedPackages(packages: readonly string[] | undefined, root: string, cache: Map<string, Promise<PackageSchemaResolutionResult>>, fs: BuildFileSystem): Promise<ResolvePackagesResult>;
|
|
57
57
|
/**
|
|
58
58
|
* Combines local schema-discovery hits with package-resolved files into one
|
|
59
|
-
* deduplicated list, keyed by realpath rather than lexical absolute path
|
|
60
|
-
*
|
|
61
|
-
* `resolveUncached` above)
|
|
59
|
+
* deduplicated list, keyed by realpath rather than lexical absolute path.
|
|
60
|
+
* Package-resolved files are already realpath-canonicalized (see
|
|
61
|
+
* `resolveUncached` above). Local `discoverSchemaFiles()` hits are plain
|
|
62
62
|
* `readdir`-derived absolute paths that may themselves traverse a symlink (a
|
|
63
|
-
* symlinked `root`, or an included path reached through one).
|
|
64
|
-
*
|
|
65
|
-
*
|
|
66
|
-
*
|
|
67
|
-
*
|
|
63
|
+
* symlinked `root`, or an included path reached through one).
|
|
64
|
+
*
|
|
65
|
+
* Deduplicating on the lexical path alone would miss one physical file
|
|
66
|
+
* reached by two symlinked routes: local glob discovery and package
|
|
67
|
+
* resolution. That file would be silently
|
|
68
|
+
* double-counted into two identical contracts. A common case: a package
|
|
68
69
|
* that's both locally glob-reachable (e.g. during a monorepo migration) and
|
|
69
70
|
* explicitly allow-listed. On a collision, the local path string identity
|
|
70
71
|
* wins (the package-resolved duplicate is dropped).
|
|
@@ -72,11 +73,10 @@ export declare function resolveAllowlistedPackages(packages: readonly string[] |
|
|
|
72
73
|
export declare function mergeLocalAndPackageFiles(localFiles: readonly string[], packageFiles: readonly string[], fs: BuildFileSystem): Promise<string[]>;
|
|
73
74
|
/**
|
|
74
75
|
* Bare-specifier-to-allowlist matching, used by `resolve-import.ts`'s
|
|
75
|
-
* `resolveImportSpecifier()` as its package-resolution fallback.
|
|
76
|
+
* `resolveImportSpecifier()` as its package-resolution fallback. It only
|
|
76
77
|
* attempts resolution for a specifier that is (or is a subpath of) an
|
|
77
|
-
* allow-listed package name
|
|
78
|
-
*
|
|
79
|
-
* `resolveRelativeImport()`'s existing bare-specifier no-op.
|
|
78
|
+
* allow-listed package name. Any other bare specifier returns `undefined`
|
|
79
|
+
* immediately, like `resolveRelativeImport()`'s bare-specifier no-op.
|
|
80
80
|
*/
|
|
81
81
|
export declare function resolvePackageImport(specifier: string, allowedPackages: readonly string[], root: string, cache: Map<string, Promise<PackageSchemaResolutionResult>>, fs: BuildFileSystem): Promise<string | undefined>;
|
|
82
82
|
export {};
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"resolve-package-schema.d.ts","sourceRoot":"","sources":["../../../../src/build/resolution/resolve-package-schema.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,aAAa,CAAA;AAC/C,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,aAAa,CAAA;
|
|
1
|
+
{"version":3,"file":"resolve-package-schema.d.ts","sourceRoot":"","sources":["../../../../src/build/resolution/resolve-package-schema.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,aAAa,CAAA;AAC/C,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,aAAa,CAAA;AAsBlD;;;iDAGiD;AACjD,eAAO,MAAM,6BAA6B,UAAY,CAAA;AAItD,KAAK,4BAA4B,GAC7B,mBAAmB,GACnB,wBAAwB,GACxB,eAAe,GACf,mBAAmB,GACnB,iBAAiB,GACjB,gBAAgB,CAAA;AAEpB;8EAC8E;AAC9E,MAAM,WAAW,aAAa;IAC5B,+DAA+D;IAC/D,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAA;IAC5B,0EAA0E;IAC1E,QAAQ,CAAC,aAAa,EAAE,MAAM,CAAA;IAC9B,yEAAyE;IACzE,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAA;IAC7B,4EAA4E;IAC5E,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAA;CAC5B;AAED,MAAM,MAAM,6BAA6B,GACrC;IAAE,QAAQ,CAAC,EAAE,EAAE,IAAI,CAAC;IAAC,QAAQ,CAAC,MAAM,EAAE,aAAa,CAAA;CAAE,GACrD;IAAE,QAAQ,CAAC,EAAE,EAAE,KAAK,CAAC;IAAC,QAAQ,CAAC,IAAI,EAAE,4BAA4B,CAAC;IAAC,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAA;CAAE,CAAA;AAwNhG;;;;;;;;GAQG;AACH,wBAAgB,wBAAwB,CACtC,WAAW,EAAE,MAAM,EACnB,IAAI,EAAE,MAAM,EACZ,KAAK,EAAE,GAAG,CAAC,MAAM,EAAE,OAAO,CAAC,6BAA6B,CAAC,CAAC,EAC1D,EAAE,EAAE,eAAe,GAClB,OAAO,CAAC,6BAA6B,CAAC,CAYxC;AAED,UAAU,mBAAmB;IAC3B,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAA;IAC5B,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;CACtB;AAED,MAAM,WAAW,qBAAqB;IACpC,QAAQ,CAAC,KAAK,EAAE,SAAS,mBAAmB,EAAE,CAAA;IAC9C,8FAA8F;IAC9F,QAAQ,CAAC,OAAO,EAAE,WAAW,CAAC,MAAM,EAAE,aAAa,CAAC,CAAA;IACpD,QAAQ,CAAC,QAAQ,EAAE,SAAS,YAAY,EAAE,CAAA;CAC3C;AAED;;;;;;GAMG;AACH,wBAAsB,0BAA0B,CAC9C,QAAQ,EAAE,SAAS,MAAM,EAAE,GAAG,SAAS,EACvC,IAAI,EAAE,MAAM,EACZ,KAAK,EAAE,GAAG,CAAC,MAAM,EAAE,OAAO,CAAC,6BAA6B,CAAC,CAAC,EAC1D,EAAE,EAAE,eAAe,GAClB,OAAO,CAAC,qBAAqB,CAAC,CA2BhC;AAED;;;;;;;;;;;;;;;GAeG;AAKH,wBAAsB,yBAAyB,CAC7C,UAAU,EAAE,SAAS,MAAM,EAAE,EAC7B,YAAY,EAAE,SAAS,MAAM,EAAE,EAC/B,EAAE,EAAE,eAAe,GAClB,OAAO,CAAC,MAAM,EAAE,CAAC,CAuBnB;AAED;;;;;;GAMG;AACH,wBAAsB,oBAAoB,CACxC,SAAS,EAAE,MAAM,EACjB,eAAe,EAAE,SAAS,MAAM,EAAE,EAClC,IAAI,EAAE,MAAM,EACZ,KAAK,EAAE,GAAG,CAAC,MAAM,EAAE,OAAO,CAAC,6BAA6B,CAAC,CAAC,EAC1D,EAAE,EAAE,eAAe,GAClB,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC,CAe7B"}
|
|
@@ -7,12 +7,12 @@ export type ResolveWithinRootResult = {
|
|
|
7
7
|
readonly issue: CompatibilityIssue;
|
|
8
8
|
};
|
|
9
9
|
/**
|
|
10
|
-
* Plain lexical bounds-check: is `targetPath` inside `baseDir`?
|
|
11
|
-
* `resolveWithinRoot()` below
|
|
12
|
-
* usually don't exist on disk yet
|
|
13
|
-
*
|
|
14
|
-
*
|
|
15
|
-
*
|
|
10
|
+
* Plain lexical bounds-check: is `targetPath` inside `baseDir`? Two callers
|
|
11
|
+
* share it. `resolveWithinRoot()` below checks output paths lexically, since
|
|
12
|
+
* they usually don't exist on disk yet. `resolve-package-schema.ts` also
|
|
13
|
+
* re-checks against `fs.realpath`-resolved paths, since a package-declared
|
|
14
|
+
* schema path both exists on disk and crosses a real trust boundary (see
|
|
15
|
+
* ADR 0014). Boundary-agnostic on purpose: neither caller's
|
|
16
16
|
* notion of "root" is baked in here.
|
|
17
17
|
*/
|
|
18
18
|
export declare function isWithinDirectory(baseDir: string, targetPath: string): boolean;
|
|
@@ -20,14 +20,14 @@ export declare function isWithinDirectory(baseDir: string, targetPath: string):
|
|
|
20
20
|
* Resolves `location` against `root` and checks the result doesn't escape it
|
|
21
21
|
* (e.g. `location: "../../malicious.ts"`, or an absolute path on another
|
|
22
22
|
* branch of the filesystem entirely). Discovery (`include`/`exclude`) is
|
|
23
|
-
* already safe by construction
|
|
23
|
+
* already safe by construction: it only ever walks *down* from `root` via
|
|
24
24
|
* `readdir`, so a pattern can't make it read outside `root`. Output
|
|
25
25
|
* locations have no such structural guarantee, since `path.resolve` happily
|
|
26
26
|
* walks back out via `..` segments, so this is a plain lexical bounds-check
|
|
27
|
-
* (not a symlink-aware `realpath` check
|
|
27
|
+
* (not a symlink-aware `realpath` check: these are *output* paths that
|
|
28
28
|
* usually don't exist yet).
|
|
29
29
|
*
|
|
30
|
-
* Never throws itself
|
|
30
|
+
* Never throws itself: returns a `CompatibilityIssue`-shaped finding on
|
|
31
31
|
* escape so each generator function (`generateEnvManifest`, `generateDocumentation`,
|
|
32
32
|
* `generateUsageReport`, `generateEnvArtifacts`) can wrap it in its own error type.
|
|
33
33
|
*/
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
/**
|
|
2
|
-
* SARIF export
|
|
2
|
+
* SARIF export: an adapter over Finding Model, not a new fact source.
|
|
3
3
|
* Produces a minimal, spec-conformant SARIF 2.1.0 log
|
|
4
4
|
* (https://docs.oasis-open.org/sarif/sarif/v2.1.0/) so env-cap's findings can
|
|
5
5
|
* be consumed by any SARIF-aware tool (GitHub code scanning, most CI security
|
|
@@ -7,11 +7,11 @@
|
|
|
7
7
|
*
|
|
8
8
|
* Pure and synchronous: every input is already computed by the time this
|
|
9
9
|
* runs, so this never re-derives a finding, never reads the filesystem, and
|
|
10
|
-
* never decides what is or isn't a problem
|
|
10
|
+
* never decides what is or isn't a problem; it only re-shapes what
|
|
11
11
|
* `buildFindingModel()` already concluded.
|
|
12
12
|
*/
|
|
13
13
|
import type { FindingModel } from "./finding-model.js";
|
|
14
|
-
/** SARIF's `level` enum
|
|
14
|
+
/** SARIF's `level` enum: see the SARIF 2.1.0 spec, section 3.27.10. */
|
|
15
15
|
type SarifLevel = "none" | "note" | "warning" | "error";
|
|
16
16
|
interface SarifLocation {
|
|
17
17
|
readonly physicalLocation: {
|
|
@@ -32,7 +32,7 @@ interface SarifResult {
|
|
|
32
32
|
};
|
|
33
33
|
readonly locations?: readonly SarifLocation[];
|
|
34
34
|
}
|
|
35
|
-
/** A minimal SARIF 2.1.0 log
|
|
35
|
+
/** A minimal SARIF 2.1.0 log: only the properties this adapter actually populates, not the full spec surface. */
|
|
36
36
|
export interface SarifLog {
|
|
37
37
|
readonly $schema: string;
|
|
38
38
|
readonly version: "2.1.0";
|
|
@@ -55,7 +55,7 @@ export interface SarifLog {
|
|
|
55
55
|
*
|
|
56
56
|
* @remarks
|
|
57
57
|
* `rules` lists every distinct `FindingCode` actually present in this run,
|
|
58
|
-
* sorted
|
|
58
|
+
* sorted: not the full `FindingCode` union. A SARIF consumer treats the
|
|
59
59
|
* rules array as "what this tool reported", and advertising rules that
|
|
60
60
|
* produced no result makes a clean run look like it has unexplained silent
|
|
61
61
|
* rules. `results` preserves Finding Model's own order, which a caller wanting
|
|
@@ -1 +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,
|
|
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"}
|
|
@@ -2,20 +2,20 @@ import type TS from "typescript";
|
|
|
2
2
|
import type { ImportBinding } from "./parse.js";
|
|
3
3
|
/**
|
|
4
4
|
* Why a tracked binding's value flowed somewhere this single-file, syntactic
|
|
5
|
-
* walk cannot follow
|
|
6
|
-
*
|
|
7
|
-
*
|
|
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
8
|
*/
|
|
9
9
|
export type EscapeReason =
|
|
10
|
-
/** `const { ...rest } = contract
|
|
10
|
+
/** `const { ...rest } = contract`: a rest element captures every remaining key at once. */
|
|
11
11
|
"rest"
|
|
12
|
-
/** `const { X: { Y } } = contract
|
|
12
|
+
/** `const { X: { Y } } = contract`: the bound value itself gets destructured again, one level too deep for this pass. */
|
|
13
13
|
| "nested-pattern"
|
|
14
|
-
/** `const { [expr]: v } = contract` where `expr` isn't a string literal
|
|
14
|
+
/** `const { [expr]: v } = contract` where `expr` isn't a string literal: the bound key can't be read without evaluating `expr`. */
|
|
15
15
|
| "computed-key"
|
|
16
|
-
/** `const e = contract` where `e` isn't file-unique/never-assigned (see `resolveAliasTargets`)
|
|
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
17
|
| "reassignment";
|
|
18
|
-
/** One observed use of a tracked contract binding in a consumer file
|
|
18
|
+
/** One observed use of a tracked contract binding in a consumer file: see ADR 0039. Consumed by `dependency-graph.ts`. */
|
|
19
19
|
export type AccessSite = {
|
|
20
20
|
readonly kind: "member";
|
|
21
21
|
readonly member: string;
|
|
@@ -39,12 +39,12 @@ export interface FileScanResult {
|
|
|
39
39
|
readonly file: string;
|
|
40
40
|
readonly imports: ReadonlyMap<string, ImportBinding>;
|
|
41
41
|
readonly accessesByLocalName: ReadonlyMap<string, readonly AccessSite[]>;
|
|
42
|
-
/** True if this file contains a bare `export * from "..."
|
|
42
|
+
/** True if this file contains a bare `export * from "..."`. Used only to
|
|
43
43
|
* flag ambiguous barrel forwarding elsewhere as "unresolved", never to
|
|
44
44
|
* follow it (see ADR 0010's scope boundary). */
|
|
45
45
|
readonly hasWildcardReExport: boolean;
|
|
46
46
|
}
|
|
47
|
-
/** One `const <name> = <identifier>` declaration
|
|
47
|
+
/** One `const <name> = <identifier>` declaration: a candidate one-level alias of `<identifier>`, before file-uniqueness/never-assigned checks (see `resolveAliasTargets`). */
|
|
48
48
|
interface AliasCandidate {
|
|
49
49
|
readonly aliasName: string;
|
|
50
50
|
readonly baseName: string;
|
|
@@ -52,12 +52,13 @@ interface AliasCandidate {
|
|
|
52
52
|
}
|
|
53
53
|
/**
|
|
54
54
|
* One whole-file pass collecting the three facts `resolveAliasTargets` needs:
|
|
55
|
-
*
|
|
56
|
-
* name
|
|
57
|
-
*
|
|
58
|
-
*
|
|
59
|
-
*
|
|
60
|
-
*
|
|
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.
|
|
61
62
|
*/
|
|
62
63
|
/** @internal Exported for direct unit coverage. */
|
|
63
64
|
export declare function collectDeclarationFacts(sourceFile: TS.SourceFile): {
|
|
@@ -1 +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,
|
|
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"}
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* The canonical ordering every fact model's contract list is sorted by: `file`
|
|
3
3
|
* (root-relative, POSIX) then `exportName`. One definition so `JSON.stringify`
|
|
4
4
|
* output is stable and diffs cleanly across Contract / Ownership / Lifecycle /
|
|
5
|
-
* Dependency Models. Internal
|
|
5
|
+
* Dependency Models. Internal: not re-exported from the public `.` barrel.
|
|
6
6
|
*/
|
|
7
7
|
export declare function byContractIdentity(a: {
|
|
8
8
|
readonly file: string;
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import type ts from "typescript";
|
|
2
2
|
/**
|
|
3
|
-
* A precise pointer into a source file
|
|
4
|
-
*
|
|
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
5
|
* has to reconcile three ad hoc `{ file; line; column }` shapes that happen to mean the same
|
|
6
6
|
* thing. See ADR 0036.
|
|
7
7
|
*/
|
|
@@ -14,7 +14,7 @@ export interface SourcePosition {
|
|
|
14
14
|
readonly column: number;
|
|
15
15
|
}
|
|
16
16
|
/**
|
|
17
|
-
* `node`'s starting line/column within `sourceFile`, both 1-indexed
|
|
17
|
+
* `node`'s starting line/column within `sourceFile`, both 1-indexed: TypeScript's own
|
|
18
18
|
* `getLineAndCharacterOfPosition()` returns 0-indexed values for both. Callers combine this with
|
|
19
19
|
* the file path they already have in scope to build a full {@link SourcePosition}; this returns
|
|
20
20
|
* only the two numbers so it's usable identically whether the caller's `file` is already
|
|
@@ -28,16 +28,16 @@ export declare function positionOf(sourceFile: ts.SourceFile, node: ts.Node): {
|
|
|
28
28
|
* Parses a developer-supplied `"<relative-path>:<line>:<column>"` citation
|
|
29
29
|
* (a {@link runtime.VariableEvidenceDocs.dynamicAccess} entry) into a
|
|
30
30
|
* {@link SourcePosition}. Splits on the *last* two colons so a path
|
|
31
|
-
* containing colons of its own (rare, but not impossible) still parses
|
|
31
|
+
* containing colons of its own (rare, but not impossible) still parses:
|
|
32
32
|
* only the trailing `:<line>:<column>` is treated as position syntax.
|
|
33
33
|
* Returns `undefined` for anything that isn't exactly that shape (missing
|
|
34
|
-
* segments, a non-positive-integer line/column, an empty path)
|
|
34
|
+
* segments, a non-positive-integer line/column, an empty path): callers
|
|
35
35
|
* treat that as a malformed citation, never a thrown error. See ADR 0037.
|
|
36
36
|
*/
|
|
37
37
|
export declare function parsePositionCitation(citation: string): SourcePosition | undefined;
|
|
38
38
|
/**
|
|
39
39
|
* One developer-declared {@link runtime.VariableEvidenceDocs.dynamicAccess} citation's
|
|
40
|
-
* current acknowledgment state
|
|
40
|
+
* current acknowledgment state: a claim, never an observation. Kept fully
|
|
41
41
|
* separate from `VariableAccessStatus` (which stays exactly 3-valued and
|
|
42
42
|
* purely AST-derived) so a developer's assertion can never make env-cap
|
|
43
43
|
* claim it observed something it didn't. See
|
|
@@ -46,21 +46,21 @@ export declare function parsePositionCitation(citation: string): SourcePosition
|
|
|
46
46
|
*/
|
|
47
47
|
export interface DynamicAccessAssertion extends SourcePosition {
|
|
48
48
|
/**
|
|
49
|
-
* `"fresh"
|
|
49
|
+
* `"fresh"`: the cited file currently exists and either matches the
|
|
50
50
|
* committed baseline hash or has no baseline yet (a brand-new citation,
|
|
51
|
-
* nothing to contradict it yet). `"stale"
|
|
52
|
-
* content has changed since the committed baseline. `"missing"
|
|
51
|
+
* nothing to contradict it yet). `"stale"`: the cited file exists but its
|
|
52
|
+
* content has changed since the committed baseline. `"missing"`: the
|
|
53
53
|
* cited file no longer exists at all. Re-derived from scratch every run;
|
|
54
54
|
* never cached across runs.
|
|
55
55
|
*/
|
|
56
56
|
readonly acknowledgment: "fresh" | "stale" | "missing";
|
|
57
57
|
/**
|
|
58
|
-
* SHA-256 hex digest of the cited file's content *as observed this run
|
|
58
|
+
* SHA-256 hex digest of the cited file's content *as observed this run*:
|
|
59
59
|
* `undefined` iff `acknowledgment === "missing"` (nothing to hash). This is
|
|
60
60
|
* the one field that makes freshness checking possible without a
|
|
61
|
-
* snapshot-only shadow type
|
|
62
|
-
* gets back
|
|
63
|
-
*
|
|
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
64
|
* next run's comparison target directly. See `evidence-snapshot.ts` and
|
|
65
65
|
* ADR 0037.
|
|
66
66
|
*/
|
|
@@ -13,7 +13,7 @@ export interface OwnershipDependencyEntry {
|
|
|
13
13
|
/** Number of variables declared in this contract's schema. */
|
|
14
14
|
readonly variableCount: number;
|
|
15
15
|
/** Files coupled to this contract (imported it, referenced it, or read a
|
|
16
|
-
* member from it)
|
|
16
|
+
* member from it): contract-level "who depends on this," NOT proof any
|
|
17
17
|
* specific variable was read. Blast radius if this contract changes is
|
|
18
18
|
* `consumers.length`, computed by callers/renderers on demand rather than
|
|
19
19
|
* stored redundantly here. */
|
|
@@ -28,7 +28,7 @@ export interface AbandonedContractFinding {
|
|
|
28
28
|
/** Contract-level default owner, if set. */
|
|
29
29
|
readonly owner: string | undefined;
|
|
30
30
|
}
|
|
31
|
-
/** A contract reachable only through an unresolved barrel re-export
|
|
31
|
+
/** A contract reachable only through an unresolved barrel re-export: can't be proven abandoned or consumed. */
|
|
32
32
|
export interface UnresolvedConsumerFinding {
|
|
33
33
|
/** Resolved display name (see {@link DiscoveredContract.contractName}). */
|
|
34
34
|
readonly contractName: string;
|
|
@@ -47,19 +47,19 @@ export interface UnconsumedOwnedVariableFinding {
|
|
|
47
47
|
readonly key: string;
|
|
48
48
|
/**
|
|
49
49
|
* Every `dynamicAccess` citation for this variable that's currently
|
|
50
|
-
* `"stale"` or `"missing"` (empty when none exist
|
|
51
|
-
* Empty is the *strongest* "looks
|
|
52
|
-
*
|
|
53
|
-
*
|
|
54
|
-
*
|
|
55
|
-
*
|
|
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
56
|
* `high`/`low` label, matching this codebase's "show the receipt" pattern
|
|
57
|
-
* (ADR 0036/0037)
|
|
58
|
-
*
|
|
57
|
+
* (ADR 0036/0037). A reader can judge confidence from the actual evidence
|
|
58
|
+
* rather than trusting a derived summary. See ADR 0038.
|
|
59
59
|
*/
|
|
60
60
|
readonly staleOrMissingCitations: readonly DynamicAccessCitationProblem[];
|
|
61
61
|
}
|
|
62
|
-
/** A variable accessed only via dynamic (computed) property access
|
|
62
|
+
/** A variable accessed only via dynamic (computed) property access: usage cannot be determined statically. */
|
|
63
63
|
export interface IndeterminateOwnershipFinding {
|
|
64
64
|
/** Resolved display name (see {@link DiscoveredContract.contractName}). */
|
|
65
65
|
readonly contractName: string;
|
|
@@ -67,12 +67,12 @@ export interface IndeterminateOwnershipFinding {
|
|
|
67
67
|
readonly key: string;
|
|
68
68
|
/** Human-readable explanation of why usage couldn't be determined. */
|
|
69
69
|
readonly reason: string;
|
|
70
|
-
/** Every AST-observed dynamic-access site backing `reason`, structured
|
|
70
|
+
/** Every AST-observed dynamic-access site backing `reason`, structured: see ADR 0036. */
|
|
71
71
|
readonly dynamicAccessSites: readonly SourcePosition[];
|
|
72
72
|
/** See {@link UnconsumedOwnedVariableFinding.staleOrMissingCitations}. */
|
|
73
73
|
readonly staleOrMissingCitations: readonly DynamicAccessCitationProblem[];
|
|
74
74
|
}
|
|
75
|
-
/** A variable that would otherwise be reported `unconsumedOwnedVariables`/`indeterminate`, but has at least one `"fresh"` developer-declared `dynamicAccess` citation
|
|
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
76
|
export interface AssertedDynamicAccessFinding {
|
|
77
77
|
/** Resolved display name (see {@link DiscoveredContract.contractName}). */
|
|
78
78
|
readonly contractName: string;
|
|
@@ -84,7 +84,7 @@ export interface AssertedDynamicAccessFinding {
|
|
|
84
84
|
readonly dynamicAccessAssertions: readonly DynamicAccessAssertion[];
|
|
85
85
|
}
|
|
86
86
|
/** Everything {@link renderUsageReport} needs to render the Dependency &
|
|
87
|
-
* Ownership Report
|
|
87
|
+
* Ownership Report: deliberately independent of (not derived from)
|
|
88
88
|
* `GenerateUsageReportResult` in `generate-usage.js`, the same way
|
|
89
89
|
* `RenderDocsOptions` in `docs.ts` doesn't derive from
|
|
90
90
|
* `GenerateDocumentationResult`. `generate-usage.ts` composes its own
|
|
@@ -95,7 +95,7 @@ export interface RenderUsageReportOptions {
|
|
|
95
95
|
readonly dependencyOwnership: readonly OwnershipDependencyEntry[];
|
|
96
96
|
/** Contracts never imported anywhere in the scanned repository. */
|
|
97
97
|
readonly abandonedContracts: readonly AbandonedContractFinding[];
|
|
98
|
-
/** Advisory only, never gates `onOwnershipIssue
|
|
98
|
+
/** Advisory only, never gates `onOwnershipIssue`: a contract only
|
|
99
99
|
* reaches here when an ambiguous barrel re-export makes "abandoned" or
|
|
100
100
|
* "consumed" both unprovable. */
|
|
101
101
|
readonly unresolvedConsumers: readonly UnresolvedConsumerFinding[];
|
|
@@ -103,21 +103,21 @@ export interface RenderUsageReportOptions {
|
|
|
103
103
|
readonly unconsumedOwnedVariables: readonly UnconsumedOwnedVariableFinding[];
|
|
104
104
|
/** Variables accessed only via dynamic (computed) property access. */
|
|
105
105
|
readonly indeterminate: readonly IndeterminateOwnershipFinding[];
|
|
106
|
-
/** Variables a developer has re-acknowledged via `dynamicAccess`, freshly
|
|
106
|
+
/** Variables a developer has re-acknowledged via `dynamicAccess`, freshly: see ADR 0037. */
|
|
107
107
|
readonly asserted: readonly AssertedDynamicAccessFinding[];
|
|
108
108
|
/** Schema-discovery parse warnings plus, since ADR 0014, any `packages`
|
|
109
|
-
* resolution failures
|
|
109
|
+
* resolution failures: surfaced here too (not just from
|
|
110
110
|
* `generateEnvManifest`/`generateDocumentation`) so a team relying only
|
|
111
111
|
* on `--ownership` output still learns when a cross-package contract
|
|
112
112
|
* failed to resolve. */
|
|
113
113
|
readonly parseWarnings: readonly ParseWarning[];
|
|
114
|
-
/** Every surface actually scanned for usage
|
|
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
115
|
readonly scannedSurfaces: readonly ScannedSurface[];
|
|
116
116
|
}
|
|
117
117
|
/**
|
|
118
118
|
* Renders the Dependency & Ownership Report: who owns each variable, which
|
|
119
119
|
* features consume each contract, and what the blast radius is if it
|
|
120
|
-
* changes
|
|
120
|
+
* changes; structured around exactly those three questions, never generic
|
|
121
121
|
* "dead code"/"unused symbol" language.
|
|
122
122
|
*/
|
|
123
123
|
export declare function renderUsageReport(computed: RenderUsageReportOptions): string;
|
|
@@ -1 +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
|
|
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"}
|
|
@@ -1,13 +1,24 @@
|
|
|
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
|
+
*/
|
|
1
10
|
import { noNodeFs } from "./no-node-fs.js";
|
|
2
11
|
import { noRawProcessEnv } from "./no-raw-process-env.js";
|
|
3
12
|
/**
|
|
4
|
-
*
|
|
5
|
-
*
|
|
13
|
+
* The ESLint plugin, as a flat-config plugin object (`{ rules }`). Register it under the `env-cap`
|
|
14
|
+
* prefix:
|
|
6
15
|
*
|
|
7
|
-
*
|
|
8
|
-
*
|
|
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
|
+
* ```
|
|
9
20
|
*
|
|
10
|
-
*
|
|
21
|
+
* ADR 0017 explains why the rules ship as their own entry point.
|
|
11
22
|
*/
|
|
12
23
|
declare const plugin: {
|
|
13
24
|
/** Every rule this plugin ships, keyed by its flat-config rule name. */
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/eslint-plugin/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,iBAAiB,CAAA;AAC1C,OAAO,EAAE,eAAe,EAAE,MAAM,yBAAyB,CAAA;AAEzD
|
|
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"}
|
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
export interface RuleOptions {
|
|
2
2
|
/** Glob-array of files this rule doesn't apply to, beyond the built-in
|
|
3
|
-
* env.schema.ts allowance below
|
|
4
|
-
* Node-only, build-time bootstrap code
|
|
5
|
-
*
|
|
6
|
-
* resolver authenticating to a secrets manager
|
|
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
7
|
* MUST be populated explicitly by the consuming project; env-cap never
|
|
8
8
|
* guesses at what counts as "trusted bootstrap code." */
|
|
9
9
|
allow?: string[];
|