@maverickcer/env-cap 0.7.3 → 0.7.5
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 +14 -13
- package/CHANGELOG.md +23 -0
- package/CODE_REVIEW.md +69 -173
- package/CONTRIBUTING.md +57 -74
- package/GUIDE.md +393 -872
- package/README.md +82 -77
- package/RELEASING.md +17 -15
- package/SECURITY.md +76 -227
- package/SUPPORT.md +21 -45
- package/VERSIONING.md +68 -105
- package/benchmarks/READING-BENCHMARKS.md +13 -7
- package/benchmarks/WRITING-BENCHMARKS.md +1 -1
- package/dist/.dts/_ipc/build-fs.d.ts +9 -14
- 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.map +1 -1
- package/dist/.dts/_ipc/generated-banner.d.ts +8 -8
- package/dist/.dts/_ipc/glob.d.ts +6 -6
- package/dist/.dts/_ipc/no-node-fs.d.ts +0 -14
- package/dist/.dts/_ipc/no-node-fs.d.ts.map +1 -1
- package/dist/.dts/build/lifecycle-model.d.ts +8 -3
- package/dist/.dts/build/lifecycle-model.d.ts.map +1 -1
- package/dist/.dts/build/sarif.d.ts.map +1 -1
- package/dist/.dts/helpers/index.d.ts +1 -1
- package/dist/.dts/runtime/create.d.ts +3 -0
- package/dist/.dts/runtime/create.d.ts.map +1 -1
- package/dist/.dts/runtime/document.d.ts +7 -4
- package/dist/.dts/runtime/document.d.ts.map +1 -1
- package/dist/.dts/runtime/index.d.ts +11 -10
- package/dist/.dts/runtime/index.d.ts.map +1 -1
- package/dist/.dts/runtime/types.d.ts +16 -0
- package/dist/.dts/runtime/types.d.ts.map +1 -1
- package/dist/.dts/runtime/validate.d.ts +14 -1
- 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 +22 -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 +47 -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 +62 -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 +170 -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 +176 -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 +148 -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 +101 -0
- package/dist/.dts7/build/generate-manifest.d.ts.map +1 -0
- package/dist/.dts7/build/generate-usage.d.ts +95 -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 +105 -0
- package/dist/.dts7/build/index.d.ts.map +1 -0
- package/dist/.dts7/build/lifecycle-model.d.ts +179 -0
- package/dist/.dts7/build/lifecycle-model.d.ts.map +1 -0
- package/dist/.dts7/build/link.d.ts +223 -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 +47 -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 +35 -0
- package/dist/.dts7/build/merge-documentation.d.ts.map +1 -0
- package/dist/.dts7/build/ownership-model.d.ts +59 -0
- package/dist/.dts7/build/ownership-model.d.ts.map +1 -0
- package/dist/.dts7/build/parse.d.ts +207 -0
- package/dist/.dts7/build/parse.d.ts.map +1 -0
- package/dist/.dts7/build/reference-projections.d.ts +170 -0
- package/dist/.dts7/build/reference-projections.d.ts.map +1 -0
- package/dist/.dts7/build/resolution/resolve-import.d.ts +58 -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 +70 -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 +27 -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 +52 -0
- package/dist/.dts7/evidence/define-projection.d.ts.map +1 -0
- package/dist/.dts7/evidence/index.d.ts +23 -0
- package/dist/.dts7/evidence/index.d.ts.map +1 -0
- package/dist/.dts7/helpers/index.d.ts +135 -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 +2 -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 +223 -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 +191 -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-LFHPVDQL.js → build-DNAYWD2B.js} +8 -5
- package/dist/build-DNAYWD2B.js.map +1 -0
- package/dist/build.cjs +7 -4
- package/dist/build.cjs.map +1 -1
- package/dist/build.js +7 -4
- 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-ZW3BLAPD.js → chunk-HAGMVMN5.js} +2 -2
- package/dist/cli/index.js +3 -3
- package/dist/eslint-plugin/index.cjs +8 -5
- package/dist/eslint-plugin/index.cjs.map +1 -1
- package/dist/eslint-plugin/index.js +8 -5
- 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.ts7.d.cts +1 -0
- package/dist/evidence.ts7.d.ts +1 -0
- 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 +37 -6
- package/schemas/env-cap-report.schema.json +1 -1
- package/skills/env-cap/SKILL.md +1 -1
- package/skills/env-cap/references/api.md +1 -1
- package/specs/architecture.md +2 -2
- 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 +14 -2
- package/dist/build-LFHPVDQL.js.map +0 -1
- /package/dist/{chunk-ZW3BLAPD.js.map → chunk-HAGMVMN5.js.map} +0 -0
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@maverickcer/env-cap",
|
|
3
|
-
"version": "0.7.
|
|
3
|
+
"version": "0.7.5",
|
|
4
4
|
"description": "Secure, type-safe, framework-agnostic environment contracts. Contracts own the environment variables they consume; the package provides runtime validation and build-time contract discovery.",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"environment",
|
|
@@ -32,60 +32,72 @@
|
|
|
32
32
|
"exports": {
|
|
33
33
|
".": {
|
|
34
34
|
"import": {
|
|
35
|
+
"types@>=7": "./dist/index.ts7.d.ts",
|
|
35
36
|
"types": "./dist/index.d.ts",
|
|
36
37
|
"default": "./dist/index.js"
|
|
37
38
|
},
|
|
38
39
|
"require": {
|
|
40
|
+
"types@>=7": "./dist/index.ts7.d.cts",
|
|
39
41
|
"types": "./dist/index.d.cts",
|
|
40
42
|
"default": "./dist/index.cjs"
|
|
41
43
|
}
|
|
42
44
|
},
|
|
43
45
|
"./build": {
|
|
44
46
|
"import": {
|
|
47
|
+
"types@>=7": "./dist/build.ts7.d.ts",
|
|
45
48
|
"types": "./dist/build.d.ts",
|
|
46
49
|
"default": "./dist/build.js"
|
|
47
50
|
},
|
|
48
51
|
"require": {
|
|
52
|
+
"types@>=7": "./dist/build.ts7.d.cts",
|
|
49
53
|
"types": "./dist/build.d.cts",
|
|
50
54
|
"default": "./dist/build.cjs"
|
|
51
55
|
}
|
|
52
56
|
},
|
|
53
57
|
"./helpers": {
|
|
54
58
|
"import": {
|
|
59
|
+
"types@>=7": "./dist/helpers.ts7.d.ts",
|
|
55
60
|
"types": "./dist/helpers.d.ts",
|
|
56
61
|
"default": "./dist/helpers.js"
|
|
57
62
|
},
|
|
58
63
|
"require": {
|
|
64
|
+
"types@>=7": "./dist/helpers.ts7.d.cts",
|
|
59
65
|
"types": "./dist/helpers.d.cts",
|
|
60
66
|
"default": "./dist/helpers.cjs"
|
|
61
67
|
}
|
|
62
68
|
},
|
|
63
69
|
"./node": {
|
|
64
70
|
"import": {
|
|
71
|
+
"types@>=7": "./dist/node.ts7.d.ts",
|
|
65
72
|
"types": "./dist/node.d.ts",
|
|
66
73
|
"default": "./dist/node.js"
|
|
67
74
|
},
|
|
68
75
|
"require": {
|
|
76
|
+
"types@>=7": "./dist/node.ts7.d.cts",
|
|
69
77
|
"types": "./dist/node.d.cts",
|
|
70
78
|
"default": "./dist/node.cjs"
|
|
71
79
|
}
|
|
72
80
|
},
|
|
73
81
|
"./evidence": {
|
|
74
82
|
"import": {
|
|
83
|
+
"types@>=7": "./dist/evidence.ts7.d.ts",
|
|
75
84
|
"types": "./dist/evidence.d.ts",
|
|
76
85
|
"default": "./dist/evidence.js"
|
|
77
86
|
},
|
|
78
87
|
"require": {
|
|
88
|
+
"types@>=7": "./dist/evidence.ts7.d.cts",
|
|
79
89
|
"types": "./dist/evidence.d.cts",
|
|
80
90
|
"default": "./dist/evidence.cjs"
|
|
81
91
|
}
|
|
82
92
|
},
|
|
83
93
|
"./eslint-plugin": {
|
|
84
94
|
"import": {
|
|
95
|
+
"types@>=7": "./dist/eslint-plugin/index.ts7.d.ts",
|
|
85
96
|
"types": "./dist/eslint-plugin/index.d.ts",
|
|
86
97
|
"default": "./dist/eslint-plugin/index.js"
|
|
87
98
|
},
|
|
88
99
|
"require": {
|
|
100
|
+
"types@>=7": "./dist/eslint-plugin/index.ts7.d.cts",
|
|
89
101
|
"types": "./dist/eslint-plugin/index.d.cts",
|
|
90
102
|
"default": "./dist/eslint-plugin/index.cjs"
|
|
91
103
|
}
|
|
@@ -125,7 +137,7 @@
|
|
|
125
137
|
"lint": "eslint .",
|
|
126
138
|
"format": "prettier --write .",
|
|
127
139
|
"format:check": "prettier --check .",
|
|
128
|
-
"setup": "npm install && npm run build && npm run schema",
|
|
140
|
+
"setup": "npm install && npm run build && npm run schema && internal-package-contract install-hooks",
|
|
129
141
|
"size": "internal-package-contract tool size",
|
|
130
142
|
"schema": "node scripts/generate-json-schema.mjs",
|
|
131
143
|
"examples:update-golden": "node scripts/update-example-goldens.mjs",
|
|
@@ -143,7 +155,8 @@
|
|
|
143
155
|
"prepublishOnly": "npm run verify",
|
|
144
156
|
"version": "changeset version && npm run build && npm run examples:update-golden && internal-package-contract skill && internal-package-contract site",
|
|
145
157
|
"release": "changeset publish",
|
|
146
|
-
"benchmark:check": "node scripts/run-benchmarks.mjs --check"
|
|
158
|
+
"benchmark:check": "node scripts/run-benchmarks.mjs --check",
|
|
159
|
+
"package-managers": "node scripts/package-managers-smoke.mjs"
|
|
147
160
|
},
|
|
148
161
|
"dependencies": {
|
|
149
162
|
"@typescript/typescript6": "^6.0.2"
|
|
@@ -175,16 +188,19 @@
|
|
|
175
188
|
"@typescript-eslint/utils": "^8.65.0",
|
|
176
189
|
"@vitest/coverage-v8": "^5.0.3",
|
|
177
190
|
"ajv": "^8.20.0",
|
|
191
|
+
"ajv-draft-04": "^1.0.0",
|
|
192
|
+
"ajv-formats": "^3.0.1",
|
|
178
193
|
"esbuild": "^0.28.1",
|
|
179
194
|
"eslint": "^10.9.0",
|
|
180
195
|
"eslint-config-prettier": "10.1.8",
|
|
196
|
+
"fast-check": "^4.10.2",
|
|
181
197
|
"globals": "^17.9.0",
|
|
182
|
-
"internal-package-contract": "github:MaverickCER/internal-package-contract#v0.
|
|
198
|
+
"internal-package-contract": "github:MaverickCER/internal-package-contract#v0.18.0",
|
|
183
199
|
"prettier": "3.9.10",
|
|
184
200
|
"ts-json-schema-generator": "^2.9.0",
|
|
185
201
|
"tsup": "^9.0.0",
|
|
186
202
|
"typedoc": "^0.28.20",
|
|
187
|
-
"typedoc-plugin-markdown": "4.14.
|
|
203
|
+
"typedoc-plugin-markdown": "4.14.1",
|
|
188
204
|
"typescript": "^6.0.3",
|
|
189
205
|
"typescript-eslint": "^8.65.0",
|
|
190
206
|
"vitest": "^5.0.3"
|
|
@@ -199,7 +215,14 @@
|
|
|
199
215
|
},
|
|
200
216
|
"adm-zip": "0.6.1",
|
|
201
217
|
"katex": "^0.18.2",
|
|
202
|
-
"qs": "6.
|
|
218
|
+
"qs": "^6.17.1",
|
|
219
|
+
"glob": "^14.0.3",
|
|
220
|
+
"minimatch": "^11.0.4",
|
|
221
|
+
"re2js": "^2.9.1",
|
|
222
|
+
"zod": "^4.6.7",
|
|
223
|
+
"typedoc": {
|
|
224
|
+
"minimatch": "^10.2.5"
|
|
225
|
+
}
|
|
203
226
|
},
|
|
204
227
|
"publishConfig": {
|
|
205
228
|
"access": "public"
|
|
@@ -215,6 +238,8 @@
|
|
|
215
238
|
"copies": [
|
|
216
239
|
"benchmark-budgets",
|
|
217
240
|
"build-fs",
|
|
241
|
+
"ci-jobs",
|
|
242
|
+
"ci-jobs-test",
|
|
218
243
|
"code-of-conduct",
|
|
219
244
|
"compiler-api",
|
|
220
245
|
"display-path",
|
|
@@ -225,6 +250,8 @@
|
|
|
225
250
|
"reading-benchmarks",
|
|
226
251
|
"releasing",
|
|
227
252
|
"resolve-tsconfig-paths",
|
|
253
|
+
"schema-sarif-2.1.0",
|
|
254
|
+
"standards-readme",
|
|
228
255
|
"support",
|
|
229
256
|
"typedoc-markdown",
|
|
230
257
|
"typescript",
|
|
@@ -240,6 +267,10 @@
|
|
|
240
267
|
"bin",
|
|
241
268
|
"./eslint-plugin",
|
|
242
269
|
"./node"
|
|
270
|
+
],
|
|
271
|
+
"env": [
|
|
272
|
+
"bin",
|
|
273
|
+
"./eslint-plugin"
|
|
243
274
|
]
|
|
244
275
|
}
|
|
245
276
|
}
|
|
@@ -1886,7 +1886,7 @@
|
|
|
1886
1886
|
"expired",
|
|
1887
1887
|
"undeclared"
|
|
1888
1888
|
],
|
|
1889
|
-
"description": "One variable's computed NIST SP 800-53 IA-5 rotation
|
|
1889
|
+
"description": "One variable's computed NIST SP 800-53 IA-5 rotation status (a policy-window judgement) -- see `computeRotationStatus()` for exactly how it's derived. Always present on a `LifecycleModelVariable` (never `undefined`) since a variable with literally nothing lifecycle-relevant set never reaches this model at all (`hasLifecycleData()` below) -- `\"undeclared\"` is itself the honest value for \"reached this model for some other lifecycle reason (e.g. `deprecated`) but declares none of the four rotation-specific fields.\"\n\nThis is a policy-window judgement from the declared metadata (\"within the declared rotation period\"), never a statement that any control is met or that a rotation happened; env-cap never checks a declaration against reality. The 1.0 release renames the value `\"compliant\"` to `\"withinPolicy\"` for that reason."
|
|
1890
1890
|
},
|
|
1891
1891
|
"FindingModel": {
|
|
1892
1892
|
"type": "object",
|
package/skills/env-cap/SKILL.md
CHANGED
|
@@ -88,4 +88,4 @@ Report any check you could not run, and any assumption you made.
|
|
|
88
88
|
|
|
89
89
|
## Authority
|
|
90
90
|
|
|
91
|
-
Target `@maverickcer/env-cap@0.7.
|
|
91
|
+
Target `@maverickcer/env-cap@0.7.5`. The installed package's exports and type declarations are the API: do not invent exports, options or return values. Behaviour is established by its tests and examples. If this skill and the code disagree, say so rather than guessing.
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# @maverickcer/env-cap public API
|
|
2
2
|
|
|
3
|
-
Every export a consumer can import, by entry point, for version 0.7.
|
|
3
|
+
Every export a consumer can import, by entry point, for version 0.7.5. Generated from the package's committed API baselines; the type declarations in the installed package are the authority.
|
|
4
4
|
|
|
5
5
|
## `@maverickcer/env-cap`
|
|
6
6
|
|
package/specs/architecture.md
CHANGED
|
@@ -609,7 +609,7 @@ dependency rules between them.
|
|
|
609
609
|
| Shared discovery, compute-atomic but not write-atomic `generateEnvArtifacts()` | [0011](decisions/0011-shared-discovery-compute-atomic-write-non-atomic.md) |
|
|
610
610
|
| Live expiration overrides via callback, not AST | [0012](decisions/0012-live-expiration-overrides-not-ast-functions.md) |
|
|
611
611
|
| `--json` CLI output is a versioned mirror | [0013](decisions/0013-json-output-is-a-versioned-mirror.md) |
|
|
612
|
-
| Cross-package schema discovery via explicit allowlist (
|
|
612
|
+
| Cross-package schema discovery via explicit allowlist (Stable since ADR 0045) | [0014](decisions/0014-cross-package-schema-discovery.md) |
|
|
613
613
|
| Post-1.0 security-fix backport window (one major back, ≥6 months, never shortened once stated) | [0015](decisions/0015-security-backport-window.md) |
|
|
614
614
|
| `--check` computes fully before comparing, and never partially writes | [0016](decisions/0016-check-mode-compute-before-compare-never-partial-write.md) |
|
|
615
615
|
| A 4th public entry point (`./eslint-plugin`) for a capability-owned-access lint rule | [0017](decisions/0017-eslint-plugin-entry-point.md) |
|
|
@@ -618,7 +618,7 @@ dependency rules between them.
|
|
|
618
618
|
| Declaration maps emitted by a separate `tsc` pass, not tsup's own `dts` pipeline | [0020](decisions/0020-declaration-maps-via-separate-tsc-pass.md) |
|
|
619
619
|
| The manifest change report is a persisted, committed JSON sidecar snapshot | [0021](decisions/0021-manifest-change-report-persisted-snapshot.md) |
|
|
620
620
|
| Generic, declarative validation contexts (`context`/`activeContexts`) | [0022](decisions/0022-validation-contexts.md) |
|
|
621
|
-
| TypeScript path-alias resolution, on by default (
|
|
621
|
+
| TypeScript path-alias resolution, on by default (Stable since ADR 0045) | [0023](decisions/0023-tsconfig-path-alias-resolution.md) |
|
|
622
622
|
| Seven canonical fact models (Contract/Dependency/Ownership/Lifecycle/Finding/Change/Evidence), not thirty-five reports | [0024](decisions/0024-fact-model-architecture.md) |
|
|
623
623
|
| Contract Model is a new, versioned JSON projection, published alongside the manifest | [0025](decisions/0025-contract-model-json-projection.md) |
|
|
624
624
|
| Finding Model unifies four independently-shaped finding families | [0026](decisions/0026-finding-model-unifies-four-families.md) |
|
|
@@ -157,7 +157,7 @@ analysis. Before a 1.0 release, several areas should continue to be evaluated:
|
|
|
157
157
|
Keeping runtime and documentation separate improves boundaries, but requiring
|
|
158
158
|
two declarations may create friction. Future versions may explore syntax
|
|
159
159
|
improvements without merging the responsibilities back together. See the
|
|
160
|
-
README's ["
|
|
160
|
+
README's ["Maturity, versioning and support"](../../README.md#maturity-versioning-and-support) section for this package's
|
|
161
161
|
general pre-1.0 stability posture.
|
|
162
162
|
|
|
163
163
|
- **Whether documentation completeness should remain opt-in.**
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
## Status
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
Accepted. Stable since [ADR 0045](0045-promote-experimental-surfaces-to-stable.md) (see [`VERSIONING.md`](../../VERSIONING.md)).
|
|
6
6
|
Implemented in:
|
|
7
7
|
|
|
8
8
|
- `src/build/resolve-package-schema.ts`
|
|
@@ -11,6 +11,9 @@ Implemented in:
|
|
|
11
11
|
- `src/build/dependency-graph.ts`
|
|
12
12
|
- `src/build/manifest.ts`
|
|
13
13
|
|
|
14
|
+
The tier statements in the body below describe the decision as it was taken; ADR 0045 has since
|
|
15
|
+
promoted these surfaces to Stable, and `VERSIONING.md` is the current policy.
|
|
16
|
+
|
|
14
17
|
The `packages` option, the `PackageOrigin` type it attaches to discovered
|
|
15
18
|
contracts, and the `"envCap": { "schema": "<path>" }` package.json convention
|
|
16
19
|
are all Experimental: they may still change shape in a minor release without
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
## Status
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
Accepted. Stable since [ADR 0045](0045-promote-experimental-surfaces-to-stable.md) (see [`VERSIONING.md`](../../VERSIONING.md)). Implemented in:
|
|
6
6
|
|
|
7
7
|
- `src/build/resolve-tsconfig-paths.ts`
|
|
8
8
|
- `src/build/resolve-import.ts` (`resolveImportSpecifier`, `ImportResolutionContext`)
|
|
@@ -10,6 +10,9 @@ Proposed / **Experimental** (see [`VERSIONING.md`](../../VERSIONING.md)). Implem
|
|
|
10
10
|
`generate-env-artifacts.ts` (the `tsconfig` option)
|
|
11
11
|
- `src/cli/index.ts` (`--tsconfig`/`--no-tsconfig`)
|
|
12
12
|
|
|
13
|
+
The tier statements in the body below describe the decision as it was taken; ADR 0045 has since
|
|
14
|
+
promoted these surfaces to Stable, and `VERSIONING.md` is the current policy.
|
|
15
|
+
|
|
13
16
|
The `tsconfig` option and the resolution behavior it controls are Experimental: they may
|
|
14
17
|
still change shape in a minor release without that being a semver violation, following the
|
|
15
18
|
same policy `packages` (ADR 0014) shipped under.
|
|
@@ -48,7 +48,7 @@ TypeScript 6 (`typescript@^6`, installed under the alias `@typescript/old`) as a
|
|
|
48
48
|
|
|
49
49
|
- A developer on TypeScript 7 installs env-cap and runs `./build` with no extra configuration; `tsc`
|
|
50
50
|
stays TypeScript 7.
|
|
51
|
-
- Every install of this package now carries ~
|
|
51
|
+
- Every install of this package now carries ~24 MB unpacked (~5 MB packed) for the bundled compiler. It
|
|
52
52
|
is nested, so a TypeScript 6 consumer does not save it by deduplication. The runtime, helpers, evidence
|
|
53
53
|
and node entry points never load it, and the isolation check keeps it that way.
|
|
54
54
|
- Bundling is what keeps the consumer's `tsc` theirs. As an ordinary dependency, `@typescript/old`'s `tsc`
|
|
@@ -62,13 +62,18 @@ TypeScript 6 (`typescript@^6`, installed under the alias `@typescript/old`) as a
|
|
|
62
62
|
pinned by `^6.0.2`, is only reachable from the build entry, and exists to be removed once TypeScript 7.1's
|
|
63
63
|
API replaces it. A new TypeScript 6 patch needs a release of this package to reach consumers.
|
|
64
64
|
- On TypeScript 7, the scanner parses with TypeScript 6. TypeScript 7.0 is designed to match 6.0's
|
|
65
|
-
behavior, and
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
consumers who pass their own nodes into these Stable primitives, because two copies
|
|
71
|
-
`SyntaxKind` are distinct enums.
|
|
65
|
+
behavior, and `scripts/typescript-compat.mjs` (CI job `typescript-compat`) parses every committed
|
|
66
|
+
`env.schema.ts` fixture (the examples and the integration fixtures) under a 5, a 6 and a 7 root and
|
|
67
|
+
requires the three outputs to be byte-identical.
|
|
68
|
+
- The `./build` and `./evidence` declarations name TypeScript AST types from `typescript`, and
|
|
69
|
+
TypeScript 7's package exports none. Typing them from the bundled package for everyone would break
|
|
70
|
+
TypeScript 5/6 consumers who pass their own nodes into these Stable primitives, because two copies
|
|
71
|
+
of `SyntaxKind` are distinct enums. So the build emits a second declaration tree, `dist/.dts7`,
|
|
72
|
+
identical except that its compiler-API types come from the bundled `@typescript/typescript6`, and
|
|
73
|
+
`package.json` serves it only to TypeScript 7 through `types@>=7` export conditions (amended
|
|
74
|
+
2026-11-09; before this, a 7 consumer needed `skipLibCheck` for those two entry points). Under 7
|
|
75
|
+
there is no second `SyntaxKind` to clash with, and every entry point but `./eslint-plugin` (typed
|
|
76
|
+
through its `@typescript-eslint/utils` peer) type-checks with full library checking; `scripts/typescript-compat.mjs` asserts which condition answered under each root.
|
|
72
77
|
|
|
73
78
|
## Alternatives considered
|
|
74
79
|
|
|
@@ -76,6 +76,19 @@ rendering function may never blend them or imply one is another:
|
|
|
76
76
|
| **Drift check** (`--check`) | `checkArtifacts` | Recomputes every requested artifact and diffs it against disk — writes nothing, exits non-zero if anything is stale or missing. Its exit code reflects staleness only, independent of `--strict*` finding severity. |
|
|
77
77
|
| **SARIF log** | `buildSarifLog` (library export) | A SARIF 2.1.0 adapter over the Finding Model, for a security-tooling pipeline that already ingests SARIF. Not CLI-wired — an ordinary consumer of the public Finding Model type, called directly by whichever project needs it (the same boundary Phase 4/5's own generator scripts sit behind). |
|
|
78
78
|
|
|
79
|
+
## Standard-format documents
|
|
80
|
+
|
|
81
|
+
Generated from `docs/surface.json` by `internal-package-contract generate`; each row names the test that
|
|
82
|
+
checks the format, and generation fails if that test is gone.
|
|
83
|
+
|
|
84
|
+
<!-- ipc:begin standards -->
|
|
85
|
+
|
|
86
|
+
| Document | Standard | Produced by | Checked against | Test | Limits |
|
|
87
|
+
| -------- | ----------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | -------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
88
|
+
| Findings | OASIS SARIF 2.1.0 | `buildSarifLog` (`@maverickcer/env-cap/build`), over the Finding Model | The official OASIS schema (`test/fixtures/standards/`, a managed copy) | `test/build/sarif.test.ts` | A library export, not wired to the CLI. A finding carries a region only when it has a real position. A finding with a position points at the cited file (percent-encoded path); the rest carry a file but no line. |
|
|
89
|
+
|
|
90
|
+
<!-- ipc:end standards -->
|
|
91
|
+
|
|
79
92
|
## Canonical fact models (ADR 0024)
|
|
80
93
|
|
|
81
94
|
Seven canonical, versioned, JSON-serializable models — the machine-readable
|
|
@@ -98,7 +111,6 @@ A first wave of reference projections ships alongside the models themselves
|
|
|
98
111
|
(all built through `defineEvidenceProjection()`), plus `buildSarifLog` (a
|
|
99
112
|
SARIF 2.1.0 adapter over Finding Model). Every one of these is an ordinary
|
|
100
113
|
consumer of the public model types above — none has a privileged internal
|
|
101
|
-
path a downstream tool couldn't also use.
|
|
102
|
-
alignment-evidence generator (see `specs/decisions/`, once written) is
|
|
114
|
+
path a downstream tool couldn't also use. A future open-standard projection would be
|
|
103
115
|
architecturally no different: another `defineEvidenceProjection()` consumer,
|
|
104
116
|
not a bespoke script bypassing this model.
|