@maverickcer/env-cap 0.7.7 → 0.8.0
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 +4 -4
- package/AGENTS.md +2 -3
- package/CHANGELOG.md +27 -0
- package/CODE_REVIEW.md +1 -1
- package/CONTRIBUTING.md +1 -1
- package/GUIDE.md +12 -12
- package/README.md +11 -12
- package/VERSIONING.md +2 -1
- package/dist/.dts/_ipc/resolve-tsconfig-paths.d.ts +3 -4
- package/dist/.dts/_ipc/resolve-tsconfig-paths.d.ts.map +1 -1
- package/dist/.dts/build/assemble-project.d.ts +3 -3
- package/dist/.dts/build/change-model.d.ts +9 -11
- package/dist/.dts/build/change-model.d.ts.map +1 -1
- package/dist/.dts/build/check-artifacts.d.ts +5 -6
- package/dist/.dts/build/check-artifacts.d.ts.map +1 -1
- package/dist/.dts/build/citation-verification.d.ts +6 -7
- package/dist/.dts/build/citation-verification.d.ts.map +1 -1
- package/dist/.dts/build/contract-model.d.ts +7 -8
- package/dist/.dts/build/contract-model.d.ts.map +1 -1
- package/dist/.dts/build/deep-equal.d.ts +3 -3
- package/dist/.dts/build/deep-freeze.d.ts +5 -7
- package/dist/.dts/build/deep-freeze.d.ts.map +1 -1
- package/dist/.dts/build/dependency-model.d.ts +2 -2
- package/dist/.dts/build/dependency-model.d.ts.map +1 -1
- package/dist/.dts/build/discover.d.ts +6 -6
- package/dist/.dts/build/discover.d.ts.map +1 -1
- package/dist/.dts/build/env-example.d.ts +6 -7
- package/dist/.dts/build/env-example.d.ts.map +1 -1
- package/dist/.dts/build/errors.d.ts +4 -4
- package/dist/.dts/build/evidence-cache.d.ts +12 -14
- package/dist/.dts/build/evidence-cache.d.ts.map +1 -1
- package/dist/.dts/build/evidence-model.d.ts +6 -7
- package/dist/.dts/build/evidence-model.d.ts.map +1 -1
- package/dist/.dts/build/evidence-reference.d.ts +6 -6
- package/dist/.dts/build/evidence-reference.d.ts.map +1 -1
- package/dist/.dts/build/exclusive-group.d.ts +3 -3
- package/dist/.dts/build/finding-model.d.ts +12 -13
- package/dist/.dts/build/finding-model.d.ts.map +1 -1
- package/dist/.dts/build/generate-documentation.d.ts +6 -7
- package/dist/.dts/build/generate-documentation.d.ts.map +1 -1
- package/dist/.dts/build/generate-evidence.d.ts +13 -15
- package/dist/.dts/build/generate-evidence.d.ts.map +1 -1
- package/dist/.dts/build/generate-manifest.d.ts +14 -16
- package/dist/.dts/build/generate-manifest.d.ts.map +1 -1
- package/dist/.dts/build/generated-banner.d.ts +3 -3
- package/dist/.dts/build/governance-fields.d.ts +3 -3
- package/dist/.dts/build/humanize-key.d.ts +3 -3
- package/dist/.dts/build/lifecycle-model.d.ts +3 -3
- 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 +9 -9
- package/dist/.dts/build/manifest.d.ts +7 -8
- package/dist/.dts/build/manifest.d.ts.map +1 -1
- package/dist/.dts/build/merge-documentation.d.ts +4 -5
- package/dist/.dts/build/merge-documentation.d.ts.map +1 -1
- package/dist/.dts/build/resolution/resolve-import.d.ts +8 -9
- package/dist/.dts/build/resolution/resolve-import.d.ts.map +1 -1
- package/dist/.dts/build/resolution/resolve-within-root.d.ts +4 -4
- package/dist/.dts/build/sarif.d.ts +9 -11
- package/dist/.dts/build/sarif.d.ts.map +1 -1
- package/dist/.dts/build/source-position.d.ts +14 -17
- package/dist/.dts/build/source-position.d.ts.map +1 -1
- package/dist/.dts/build/usage-report.d.ts +16 -17
- package/dist/.dts/build/usage-report.d.ts.map +1 -1
- package/dist/.dts/cli/filesystem.d.ts.map +1 -1
- package/dist/.dts/eslint-plugin/glob.d.ts +2 -2
- package/dist/.dts/eslint-plugin/index.d.ts +2 -1
- package/dist/.dts/eslint-plugin/index.d.ts.map +1 -1
- package/dist/.dts/eslint-plugin/no-node-fs.d.ts +5 -5
- package/dist/.dts/eslint-plugin/no-raw-process-env.d.ts +4 -4
- package/dist/.dts/evidence/define-projection.d.ts +6 -6
- package/dist/.dts/runtime/create.d.ts +2 -3
- package/dist/.dts/runtime/create.d.ts.map +1 -1
- package/dist/.dts/runtime/errors.d.ts +7 -8
- package/dist/.dts/runtime/errors.d.ts.map +1 -1
- package/dist/.dts/runtime/index.d.ts +2 -2
- package/dist/.dts/runtime/types.d.ts +18 -20
- package/dist/.dts/runtime/types.d.ts.map +1 -1
- package/dist/.dts/runtime/validate.d.ts +2 -2
- package/dist/.dts/runtime/validate.d.ts.map +1 -1
- package/dist/.dts7/_ipc/resolve-tsconfig-paths.d.ts +3 -4
- package/dist/.dts7/_ipc/resolve-tsconfig-paths.d.ts.map +1 -1
- package/dist/.dts7/build/assemble-project.d.ts +3 -3
- package/dist/.dts7/build/change-model.d.ts +9 -11
- package/dist/.dts7/build/change-model.d.ts.map +1 -1
- package/dist/.dts7/build/check-artifacts.d.ts +5 -6
- package/dist/.dts7/build/check-artifacts.d.ts.map +1 -1
- package/dist/.dts7/build/citation-verification.d.ts +6 -7
- package/dist/.dts7/build/citation-verification.d.ts.map +1 -1
- package/dist/.dts7/build/contract-model.d.ts +7 -8
- package/dist/.dts7/build/contract-model.d.ts.map +1 -1
- package/dist/.dts7/build/deep-equal.d.ts +3 -3
- package/dist/.dts7/build/deep-freeze.d.ts +5 -7
- package/dist/.dts7/build/deep-freeze.d.ts.map +1 -1
- package/dist/.dts7/build/dependency-model.d.ts +2 -2
- package/dist/.dts7/build/dependency-model.d.ts.map +1 -1
- package/dist/.dts7/build/discover.d.ts +6 -6
- package/dist/.dts7/build/discover.d.ts.map +1 -1
- package/dist/.dts7/build/env-example.d.ts +6 -7
- package/dist/.dts7/build/env-example.d.ts.map +1 -1
- package/dist/.dts7/build/errors.d.ts +4 -4
- package/dist/.dts7/build/evidence-cache.d.ts +12 -14
- package/dist/.dts7/build/evidence-cache.d.ts.map +1 -1
- package/dist/.dts7/build/evidence-model.d.ts +6 -7
- package/dist/.dts7/build/evidence-model.d.ts.map +1 -1
- package/dist/.dts7/build/evidence-reference.d.ts +6 -6
- package/dist/.dts7/build/evidence-reference.d.ts.map +1 -1
- package/dist/.dts7/build/exclusive-group.d.ts +3 -3
- package/dist/.dts7/build/finding-model.d.ts +12 -13
- package/dist/.dts7/build/finding-model.d.ts.map +1 -1
- package/dist/.dts7/build/generate-documentation.d.ts +6 -7
- package/dist/.dts7/build/generate-documentation.d.ts.map +1 -1
- package/dist/.dts7/build/generate-evidence.d.ts +13 -15
- package/dist/.dts7/build/generate-evidence.d.ts.map +1 -1
- package/dist/.dts7/build/generate-manifest.d.ts +14 -16
- package/dist/.dts7/build/generate-manifest.d.ts.map +1 -1
- package/dist/.dts7/build/generated-banner.d.ts +3 -3
- package/dist/.dts7/build/governance-fields.d.ts +3 -3
- package/dist/.dts7/build/humanize-key.d.ts +3 -3
- package/dist/.dts7/build/lifecycle-model.d.ts +3 -3
- package/dist/.dts7/build/literal-eval.d.ts +2 -2
- package/dist/.dts7/build/literal-eval.d.ts.map +1 -1
- package/dist/.dts7/build/live-expirations.d.ts +9 -9
- package/dist/.dts7/build/manifest.d.ts +7 -8
- package/dist/.dts7/build/manifest.d.ts.map +1 -1
- package/dist/.dts7/build/merge-documentation.d.ts +4 -5
- package/dist/.dts7/build/merge-documentation.d.ts.map +1 -1
- package/dist/.dts7/build/resolution/resolve-import.d.ts +8 -9
- package/dist/.dts7/build/resolution/resolve-import.d.ts.map +1 -1
- package/dist/.dts7/build/resolution/resolve-within-root.d.ts +4 -4
- package/dist/.dts7/build/sarif.d.ts +9 -11
- package/dist/.dts7/build/sarif.d.ts.map +1 -1
- package/dist/.dts7/build/source-position.d.ts +14 -17
- package/dist/.dts7/build/source-position.d.ts.map +1 -1
- package/dist/.dts7/build/usage-report.d.ts +16 -17
- package/dist/.dts7/build/usage-report.d.ts.map +1 -1
- package/dist/.dts7/cli/filesystem.d.ts.map +1 -1
- package/dist/.dts7/eslint-plugin/glob.d.ts +2 -2
- package/dist/.dts7/eslint-plugin/index.d.ts +2 -1
- package/dist/.dts7/eslint-plugin/index.d.ts.map +1 -1
- package/dist/.dts7/eslint-plugin/no-node-fs.d.ts +5 -5
- package/dist/.dts7/eslint-plugin/no-raw-process-env.d.ts +4 -4
- package/dist/.dts7/evidence/define-projection.d.ts +6 -6
- package/dist/.dts7/runtime/create.d.ts +2 -3
- package/dist/.dts7/runtime/create.d.ts.map +1 -1
- package/dist/.dts7/runtime/errors.d.ts +7 -8
- package/dist/.dts7/runtime/errors.d.ts.map +1 -1
- package/dist/.dts7/runtime/index.d.ts +2 -2
- package/dist/.dts7/runtime/types.d.ts +18 -20
- package/dist/.dts7/runtime/types.d.ts.map +1 -1
- package/dist/.dts7/runtime/validate.d.ts +2 -2
- package/dist/.dts7/runtime/validate.d.ts.map +1 -1
- package/dist/{build-33O5SDTC.js → build-Z76NCC65.js} +7 -10
- package/dist/build-Z76NCC65.js.map +1 -0
- package/dist/build.cjs +6 -9
- package/dist/build.cjs.map +1 -1
- package/dist/build.js +6 -9
- package/dist/build.js.map +1 -1
- package/dist/{chunk-4D67AQFY.js → chunk-JRCMG4FQ.js} +2 -2
- package/dist/cli/index.js +3 -3
- 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/evidence.cjs.map +1 -1
- package/dist/evidence.js.map +1 -1
- package/dist/index.cjs.map +1 -1
- package/dist/index.js.map +1 -1
- package/dist/node.cjs.map +1 -1
- package/dist/node.js.map +1 -1
- package/package.json +6 -4
- package/schemas/env-cap-report.schema.json +11 -11
- package/skills/env-cap/SKILL.md +1 -1
- package/skills/env-cap/references/api.md +1 -1
- package/specs/architecture.md +6 -6
- package/specs/migrations/README.md +9 -9
- package/specs/migrations/from-centralized-schema.md +28 -28
- package/specs/migrations/from-dotenv.md +11 -11
- package/specs/migrations/from-envalid.md +16 -16
- package/specs/migrations/from-process-env.md +19 -19
- package/specs/migrations/from-t3-env.md +24 -24
- package/specs/migrations/from-zod.md +21 -21
- package/dist/build-33O5SDTC.js.map +0 -1
- /package/dist/{chunk-4D67AQFY.js.map → chunk-JRCMG4FQ.js.map} +0 -0
package/ADOPTION.md
CHANGED
|
@@ -24,7 +24,7 @@ Validation libraries answer one question: is this value well-formed? They do not
|
|
|
24
24
|
- Node.js `>=22`. CI tests 22 and 24 in blocking jobs.
|
|
25
25
|
- npm. pnpm, Yarn 1 and Yarn Berry are tested only for installing the tarball and importing every entry. `required` waits for that job (`package-managers`), so a failure blocks a merge.
|
|
26
26
|
- TypeScript `moduleResolution` set to `node16`, `nodenext` or `bundler` if you type-check against the subpath exports.
|
|
27
|
-
- Your own TypeScript is optional. The build entry uses it when it is version 5 or 6, and the bundled TypeScript 6 otherwise.
|
|
27
|
+
- Your own TypeScript is optional and must be 5.8 or later. The build entry uses it when it is version 5 or 6, and the bundled TypeScript 6 otherwise.
|
|
28
28
|
- Schemas written as static object literals. A schema built by a function, or a spread at the top of a schema object, produces a parse warning. A spread nested inside a variable's definition or its `documentEnv()` entry is skipped without one. Nothing is guessed.
|
|
29
29
|
|
|
30
30
|
## What it refuses to do
|
|
@@ -60,9 +60,9 @@ Installing `@maverickcer/env-cap` installs 1 package directly, and whatever it d
|
|
|
60
60
|
| Package | Kind | Range | Why |
|
|
61
61
|
| -------------------------- | ------------- | ---------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
62
62
|
| `@typescript/typescript6` | dependency | `^6.0.2` | The TypeScript 6 compiler the build entry parses schemas with when the project's own TypeScript is 7 or missing (ADR 0049). Bundled inside the tarball. No runtime entry can reach it (`compiler-isolation`). |
|
|
63
|
-
| `@typescript-eslint/utils` | optional peer | `^8.0.0` | Only for `@maverickcer/env-cap/eslint-plugin`; projects linting TypeScript already have it through `typescript-eslint`.
|
|
64
|
-
| `eslint` | optional peer | `^8.57.0 \|\| ^9.0.0 \|\| ^10.0.0` | Only for `@maverickcer/env-cap/eslint-plugin`, which runs inside the project's
|
|
65
|
-
| `typescript` | optional peer | `^5.
|
|
63
|
+
| `@typescript-eslint/utils` | optional peer | `^8.0.0` | Only for `@maverickcer/env-cap/eslint-plugin`; projects linting TypeScript already have it through `typescript-eslint`. The `eslint-compat` CI job tests the floor of this range and its newest release. |
|
|
64
|
+
| `eslint` | optional peer | `^8.57.0 \|\| ^9.0.0 \|\| ^10.0.0` | Only for `@maverickcer/env-cap/eslint-plugin`, which runs inside the project's ESLint. The `eslint-compat` CI job tests the lowest and newest release of each major in this range. |
|
|
65
|
+
| `typescript` | optional peer | `^5.8.0 \|\| ^6.0.0 \|\| ^7.0.0` | The project's own compiler, used by the build entry instead of `@typescript/typescript6` when it is version 5 or 6. CI tests the lowest and newest release of each major, from the 5.8 floor. |
|
|
66
66
|
|
|
67
67
|
<!-- ipc:end dependencies -->
|
|
68
68
|
|
package/AGENTS.md
CHANGED
|
@@ -7,9 +7,8 @@ application rules, generated from the package.
|
|
|
7
7
|
|
|
8
8
|
## What this package is
|
|
9
9
|
|
|
10
|
-
In `env-cap`, each feature (a folder or an installable package
|
|
11
|
-
|
|
12
|
-
`createEnv()` and `documentEnv()`. The application validates every contract once at startup. A build
|
|
10
|
+
In `env-cap`, each feature (a folder or an installable package) declares its environment
|
|
11
|
+
variables in a **contract**: a static schema object passed to `createEnv()` and `documentEnv()`. The application validates every contract once at startup. A build
|
|
13
12
|
step reads the contracts as source and writes the manifest, docs, `.env.example` and ownership
|
|
14
13
|
report. Values are always read through the contract that owns them.
|
|
15
14
|
|
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,32 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## 0.8.0
|
|
4
|
+
|
|
5
|
+
### Minor Changes
|
|
6
|
+
|
|
7
|
+
- f234bb8: The optional `typescript` peer range now starts at 5.8: `^5.8.0 || ^6.0.0 || ^7.0.0`. TypeScript 5.0 to 5.7
|
|
8
|
+
cannot read the CommonJS declarations (`dist/*.d.cts`) under `moduleResolution: nodenext`. Each one
|
|
9
|
+
re-exports an ES module, and those releases reject that with TS1479. A project on 5.0 to 5.7 should upgrade
|
|
10
|
+
TypeScript before upgrading env-cap.
|
|
11
|
+
|
|
12
|
+
The `typescript-compat` CI job now derives its releases from the peer range. It installs the lowest and
|
|
13
|
+
newest release of each major: 5.8.2, 5.9.3, 6.0.2, 6.0.3 and 7.0.2 today. Each one type-checks the
|
|
14
|
+
declarations from an ES module file and a CommonJS file, and runs the scanner. The `eslint-compat` job also
|
|
15
|
+
installs `@typescript-eslint/utils` 8.0.0, the floor of its range, beside ESLint 8.57.0. That pair passed,
|
|
16
|
+
so the `@typescript-eslint/utils` range is unchanged.
|
|
17
|
+
|
|
18
|
+
### Patch Changes
|
|
19
|
+
|
|
20
|
+
- f234bb8: CI now tests the ESLint plugin across its whole `eslint` peer range. A new `eslint-compat` job installs the
|
|
21
|
+
packed tarball beside the lowest and newest release of each ESLint major in the range. It runs both rules
|
|
22
|
+
under flat config, under eslintrc where that ESLint still ships it, and through the ESLint CLI. Every
|
|
23
|
+
version passed, so the range is unchanged. The guide, the dependency table and the plugin's TSDoc now name
|
|
24
|
+
this job instead of saying only ESLint 10 is tested.
|
|
25
|
+
- f234bb8: The docs now use one word, "feature", for a folder or installable package that owns a contract. The
|
|
26
|
+
GUIDE heading "Capability-owned contracts" is now "Feature-owned contracts", so its link anchor changes
|
|
27
|
+
to `#feature-owned-contracts`. TSDoc comments in the published declarations are split into sentences of
|
|
28
|
+
25 words or fewer. No code or behaviour changes.
|
|
29
|
+
|
|
3
30
|
## 0.7.7
|
|
4
31
|
|
|
5
32
|
### Patch Changes
|
package/CODE_REVIEW.md
CHANGED
|
@@ -7,7 +7,7 @@ A change is safe to merge when CI is green, no invariant below has moved, and ev
|
|
|
7
7
|
A change is ready to merge when all of these hold:
|
|
8
8
|
|
|
9
9
|
- The `contract`, `lint` and `required` checks are green; the branch ruleset requires all three.
|
|
10
|
-
- `required` waits for every gate job in ci.yml: `verify`, `lint`, `contract`, `cross-runtime` (the Bun and Deno suite), `examples`, `integration-fixtures`, `typescript-5`, `typescript-compat`, `package-managers` and `benchmark-pr`.
|
|
10
|
+
- `required` waits for every gate job in ci.yml: `verify`, `lint`, `contract`, `cross-runtime` (the Bun and Deno suite), `examples`, `integration-fixtures`, `typescript-5`, `typescript-compat`, `eslint-compat`, `package-managers` and `benchmark-pr`.
|
|
11
11
|
- Three jobs are outside `required`. `verify-current` tries the newest Node and is informational. `badges` and `deploy` run only after a push to `main`.
|
|
12
12
|
- A `benchmark-pr` failure also fails `contract` in its first step, so it cannot pass as a skip.
|
|
13
13
|
- Every invariant in §2 that the change touches still holds, checked in the code, not the description.
|
package/CONTRIBUTING.md
CHANGED
|
@@ -60,7 +60,7 @@ npm run examples:update-golden
|
|
|
60
60
|
4. Run `npx changeset` and describe what changes for someone who installs the package. Pick `patch`, `minor` or `major` by [`VERSIONING.md`](VERSIONING.md). If you add none, the release workflow generates one from `feat`, `fix`, `perf` and `revert` commit messages; other types release nothing.
|
|
61
61
|
5. Open a pull request. A merge needs the `contract`, `lint` and `required` checks; `contract` fails when `verify` or `lint` fails.
|
|
62
62
|
|
|
63
|
-
The `required` check also waits for `cross-runtime` (Bun and Deno), `examples`, `integration-fixtures`, `typescript-5`, `typescript-compat` and `package-managers`, so a red one blocks a merge.
|
|
63
|
+
The `required` check also waits for `cross-runtime` (Bun and Deno), `examples`, `integration-fixtures`, `typescript-5`, `typescript-compat`, `eslint-compat` and `package-managers`, so a red one blocks a merge.
|
|
64
64
|
|
|
65
65
|
A `benchmark-pr` failure skips `lint` and `verify`. `contract` and `required` still run and fail on it, so it blocks a merge too.
|
|
66
66
|
|
package/GUIDE.md
CHANGED
|
@@ -19,9 +19,9 @@ For the overview and quick start, read [README.md](README.md). For the reasons b
|
|
|
19
19
|
|
|
20
20
|
**What it solves:** your application fails at startup with every bad variable's name, never its value, instead of crashing later in a request.
|
|
21
21
|
|
|
22
|
-
###
|
|
22
|
+
### Feature-owned contracts
|
|
23
23
|
|
|
24
|
-
A
|
|
24
|
+
A feature is a folder or an installable package in your code. Each one declares the variables it owns, next to the validation it needs. This contract is illustrative. The contract CI runs is [`examples/application/src/env.ts`](https://github.com/MaverickCER/env-cap/blob/main/examples/application/src/env.ts).
|
|
25
25
|
|
|
26
26
|
```ts
|
|
27
27
|
// features/payments/env.schema.ts
|
|
@@ -352,18 +352,18 @@ The exact ranges, generated from `package.json`:
|
|
|
352
352
|
| Node.js | `>=22.0.0` | always |
|
|
353
353
|
| `@typescript-eslint/utils` | `^8.0.0` | optional |
|
|
354
354
|
| `eslint` | `^8.57.0 \|\| ^9.0.0 \|\| ^10.0.0` | optional |
|
|
355
|
-
| `typescript` | `^5.
|
|
355
|
+
| `typescript` | `^5.8.0 \|\| ^6.0.0 \|\| ^7.0.0` | optional |
|
|
356
356
|
|
|
357
357
|
<!-- ipc:end supported-versions -->
|
|
358
358
|
|
|
359
359
|
The `verify` job tests Node.js 22 and 24 and blocks a merge. Node.js 26 runs in `verify-current`, which is informational.
|
|
360
360
|
|
|
361
|
-
| Need | Detail
|
|
362
|
-
| ------------------------- |
|
|
363
|
-
| TypeScript (optional) | The build entry uses yours when it is 5 or 6, and otherwise the bundled TypeScript 6 (`test/build/typescript-bundled.test.ts`)
|
|
364
|
-
| TypeScript versions in CI | The newest
|
|
365
|
-
| `moduleResolution` | `node16`, `nodenext` or `bundler`, checked by the `TypeResolution` check; `node10` cannot resolve subpath exports
|
|
366
|
-
| `./eslint-plugin` | Also needs `eslint` and `@typescript-eslint/utils`; versions in [ADOPTION's dependency table](ADOPTION.md#security--threat-model)
|
|
361
|
+
| Need | Detail |
|
|
362
|
+
| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- |
|
|
363
|
+
| TypeScript (optional) | The build entry uses yours when it is 5 or 6, and otherwise the bundled TypeScript 6 (`test/build/typescript-bundled.test.ts`) |
|
|
364
|
+
| TypeScript versions in CI | The lowest and newest release of each major from the 5.8 floor, in `typescript-compat`, which `required` waits for |
|
|
365
|
+
| `moduleResolution` | `node16`, `nodenext` or `bundler`, checked by the `TypeResolution` check; `node10` cannot resolve subpath exports |
|
|
366
|
+
| `./eslint-plugin` | Also needs `eslint` and `@typescript-eslint/utils`; versions in [ADOPTION's dependency table](ADOPTION.md#security--threat-model) |
|
|
367
367
|
|
|
368
368
|
The bundled TypeScript 6 compiler is the package's one dependency. Only the build entry loads it, and `compiler-isolation` fails the build if a runtime entry can reach it ([ADR 0049](specs/decisions/0049-typescript-7-scanner-uses-a-bundled-typescript-6.md)). It is the price of scanning TypeScript 7 projects, whose compiler has no classic API.
|
|
369
369
|
|
|
@@ -653,7 +653,7 @@ export default [
|
|
|
653
653
|
]
|
|
654
654
|
```
|
|
655
655
|
|
|
656
|
-
The plugin needs `eslint` and `@typescript-eslint/utils`; [ADOPTION's dependency table](ADOPTION.md#security--threat-model) lists the ranges.
|
|
656
|
+
The plugin needs `eslint` and `@typescript-eslint/utils`; [ADOPTION's dependency table](ADOPTION.md#security--threat-model) lists the ranges. The `eslint-compat` CI job runs both rules on the lowest and newest release of each ESLint major in the `eslint` range. It runs them again with the lowest `@typescript-eslint/utils` release beside the lowest ESLint. It also runs the config above through the ESLint CLI. Where the installed ESLint still ships eslintrc, the job runs the rules there too, with the plugin passed through the API's `plugins` option. `required` waits for `eslint-compat`, so a break blocks a merge.
|
|
657
657
|
|
|
658
658
|
### `no-raw-process-env`
|
|
659
659
|
|
|
@@ -692,7 +692,7 @@ The runtime and the build tooling share one contract file and nothing else.
|
|
|
692
692
|
|
|
693
693
|
A run goes through four steps, in order:
|
|
694
694
|
|
|
695
|
-
1. Each
|
|
695
|
+
1. Each feature declares a contract with `createEnv()` and `documentEnv()`.
|
|
696
696
|
2. The build step parses every contract file and writes the manifest, documents and evidence.
|
|
697
697
|
3. The application imports the manifest and calls `validateEnv()` once at startup.
|
|
698
698
|
4. Code reads typed values through the contract that owns them.
|
|
@@ -714,7 +714,7 @@ A project can start with one central contract and split it later; the runtime mo
|
|
|
714
714
|
|
|
715
715
|
³ `bun-version: latest` and Deno `v2.x`, in `cross-runtime`, which `required` waits for.
|
|
716
716
|
|
|
717
|
-
⁴ `./eslint-plugin`: unit tests block
|
|
717
|
+
⁴ `./eslint-plugin`: unit tests block. Its ESM and CJS import from the tarball runs in the `package-managers` and `eslint-compat` jobs, which `required` waits for.
|
|
718
718
|
|
|
719
719
|
ESM and CommonJS builds ship for every entry point, and the `PackedConsumer` check imports each one from the packed tarball except `./eslint-plugin`. A dual-package split fails fast with a `TypeError` instead of validating against the wrong schema ([SECURITY.md](SECURITY.md#dual-package-hazard)).
|
|
720
720
|
|
package/README.md
CHANGED
|
@@ -12,7 +12,7 @@
|
|
|
12
12
|
|
|
13
13
|
**Each feature declares the environment variables it needs and their format. Your app validates them all in one place at startup, fails fast on a bad value, and reports how they should be rotated before they expire.**
|
|
14
14
|
|
|
15
|
-
`env-cap` is a TypeScript library. A feature is a folder or an installable package in your code
|
|
15
|
+
`env-cap` is a TypeScript library. A feature is a folder or an installable package in your code. It declares its variables in a **contract**: how to parse and check each value, who owns it and, for a secret, when it expires.
|
|
16
16
|
|
|
17
17
|
A build step lists every contract in the **manifest**, a generated file your app passes to `validateEnv()` at startup. A bad value throws an error that names the variable, never its value.
|
|
18
18
|
|
|
@@ -136,7 +136,9 @@ This is output from [`examples/application`](https://github.com/MaverickCER/env-
|
|
|
136
136
|
|
|
137
137
|
## Install and verify
|
|
138
138
|
|
|
139
|
-
**Prerequisites:** Node.js `>=22`. Your own TypeScript is optional. The generator uses it when it is version 5 or 6, and otherwise the bundled TypeScript 6 compiler. CI tests the newest
|
|
139
|
+
**Prerequisites:** Node.js `>=22`. Your own TypeScript is optional and must be 5.8 or later. The generator uses it when it is version 5 or 6, and otherwise the bundled TypeScript 6 compiler. CI tests the lowest and newest release of each TypeScript major in that range (`typescript-compat`). The runtime works in plain JavaScript ([requirements](GUIDE.md#requirements)).
|
|
140
|
+
|
|
141
|
+
<!-- quick-start:begin -->
|
|
140
142
|
|
|
141
143
|
```sh
|
|
142
144
|
npm install @maverickcer/env-cap
|
|
@@ -144,9 +146,9 @@ npx env-cap init # writes env.schema.ts and scripts/generate-en
|
|
|
144
146
|
node scripts/generate-env.mjs
|
|
145
147
|
```
|
|
146
148
|
|
|
147
|
-
|
|
149
|
+
<!-- quick-start:end -->
|
|
148
150
|
|
|
149
|
-
Then validate once at startup and read values through the contract. `init` writes `env.schema.ts` into `src/` when that folder exists, otherwise into the project root; adjust the import path to match:
|
|
151
|
+
`init` writes two files and skips any file that already exists. Without a valid `package.json` it exits `1` and writes nothing. `test/cli/init.test.ts` pins these rules and the templates. **Verify it works:** the script prints `Discovered 1 contract(s).` and exits `0`. `test/cli/quick-start.test.ts` runs `init` and the script against the built package and checks that line and each generated file. Report an issue if that line differs. Then validate once at startup and read values through the contract. `init` writes `env.schema.ts` into `src/` when that folder exists, otherwise into the project root; adjust the import path to match:
|
|
150
152
|
|
|
151
153
|
```ts
|
|
152
154
|
import { validateEnv } from "@maverickcer/env-cap"
|
|
@@ -163,16 +165,14 @@ exampleEnv.EXAMPLE_API_URL
|
|
|
163
165
|
|
|
164
166
|
**What you get:**
|
|
165
167
|
|
|
166
|
-
- Per-feature contracts with validators, owners, sensitivity and expiry dates ([contracts](GUIDE.md#
|
|
168
|
+
- Per-feature contracts with validators, owners, sensitivity and expiry dates ([contracts](GUIDE.md#feature-owned-contracts)).
|
|
167
169
|
- A manifest, environment docs, `.env.example` and an ownership report, from static analysis that never imports your schema files.
|
|
168
170
|
- A persisted evidence file, a CLI, a [GitHub Action](GUIDE.md#github-action), scheduled rotation reports and an [ESLint plugin](GUIDE.md#eslint-plugin).
|
|
169
171
|
- One central schema or one contract per feature or package; the manifest stays project-wide either way.
|
|
170
172
|
|
|
171
|
-
**How it works:** the runtime and the build tooling are separate entry points. The runtime has no filesystem access, which lint and a tarball scan enforce. The build pass runs only in development and CI ([Architecture](GUIDE.md#runtime-and-build-time-are-intentionally-separate)).
|
|
172
|
-
|
|
173
|
-
**
|
|
174
|
-
|
|
175
|
-
**Package managers:** npm is supported. pnpm, Yarn 1 and Yarn Berry are tested only for installing the tarball and importing every entry ([details](GUIDE.md#package-managers)).
|
|
173
|
+
- **How it works:** the runtime and the build tooling are separate entry points. The runtime has no filesystem access, which lint and a tarball scan enforce. The build pass runs only in development and CI ([Architecture](GUIDE.md#runtime-and-build-time-are-intentionally-separate)).
|
|
174
|
+
- **Runtimes:** Node.js 22 and 24 are tested. Bun, Deno and a browser-style bundle run in CI for the runtime, helpers and evidence entries. Edge runtimes are not tested ([support matrix](GUIDE.md#runtime-support-matrix)).
|
|
175
|
+
- **Package managers:** npm is supported. pnpm, Yarn 1 and Yarn Berry are tested only for installing the tarball and importing every entry ([details](GUIDE.md#package-managers)).
|
|
176
176
|
|
|
177
177
|
## Limits and when not to use it
|
|
178
178
|
|
|
@@ -216,5 +216,4 @@ Pre-1.0; the npm badge shows the current version. Before 1.0, a minor release ma
|
|
|
216
216
|
- **Evaluate:** read the [Adoption guide](ADOPTION.md), then try env-cap on one real schema.
|
|
217
217
|
- **Integrate:** follow the [Guide](GUIDE.md#core-workflow) and run an [example](https://github.com/MaverickCER/env-cap/tree/main/examples).
|
|
218
218
|
- **Verify:** check the [security model](SECURITY.md#runtime-security-model) against the tests it names.
|
|
219
|
-
|
|
220
|
-
Contributing: [CONTRIBUTING.md](CONTRIBUTING.md) covers setup and changesets; [CODE_REVIEW.md](CODE_REVIEW.md) covers review. License: MIT, see [LICENSE](LICENSE).
|
|
219
|
+
- **Contribute:** [CONTRIBUTING.md](CONTRIBUTING.md) covers setup and changesets; [CODE_REVIEW.md](CODE_REVIEW.md) covers review. License: MIT, see [LICENSE](LICENSE).
|
package/VERSIONING.md
CHANGED
|
@@ -44,7 +44,8 @@ Generated from `package.json#exports` and `docs/surface.json` by `internal-packa
|
|
|
44
44
|
| The files and templates `env-cap init` writes | `test/cli/init.test.ts` pins the exact templates | None found |
|
|
45
45
|
| The GitHub Action's input names and defaults | `SurfaceContract` | Input descriptions are not baselined; the summary's section headings are, through the row above |
|
|
46
46
|
| The supported toolchain: Node.js `>=22` and `moduleResolution` `node16`, `nodenext` or `bundler` | `EngineMatrix` (Node 22 and 24) and `TypeResolution` | Node 26 runs as an informational job |
|
|
47
|
-
| TypeScript 5, 6 and 7 for type-checking every entry point
|
|
47
|
+
| TypeScript 5.8 and later, 6 and 7 for type-checking every entry point but `./eslint-plugin` from ESM and CommonJS, under `nodenext`, `strict` and full library checking | `scripts/typescript-compat.mjs` in CI (`typescript-compat`), which `required` waits for | The lowest and newest release of each major only. Older 5.x releases reject the CommonJS declarations (TS1479), so the range starts at 5.8 |
|
|
48
|
+
| The `eslint` and `@typescript-eslint/utils` peer ranges of `./eslint-plugin` | `scripts/eslint-compat.mjs` in CI (`eslint-compat`), which `required` waits for | ESLint: the lowest and newest of each major, with the newest utils. `@typescript-eslint/utils`: 8.0.0 beside ESLint 8.57.0. Utils releases between the two are not installed |
|
|
48
49
|
|
|
49
50
|
The Action is used through a major tag: `uses: maverickcer/env-cap@v0` while the package is `0.x`, `@v1` from 1.0.0. That tag moves only within a major version.
|
|
50
51
|
|
|
@@ -125,10 +125,9 @@ export declare function loadTsconfigPaths(product: string, root: string, tsconfi
|
|
|
125
125
|
* this mechanism never overlaps with that trust boundary.
|
|
126
126
|
* - **`.ts`/`.tsx` only.** Matches `resolveRelativeImport()`'s own existing candidate set
|
|
127
127
|
* and `resolve-package-schema.ts`'s `SCHEMA_FILE_EXTENSIONS`: this codebase's static-
|
|
128
|
-
* analysis pipeline
|
|
129
|
-
*
|
|
130
|
-
*
|
|
131
|
-
* warn-don't-guess philosophy exists to avoid.
|
|
128
|
+
* analysis pipeline reads only `.ts` and `.tsx` today. Any other resolved file is a risk.
|
|
129
|
+
* `ts.createSourceFile()` would not error on it; it would parse garbage. That is the
|
|
130
|
+
* "guess" the warn-don't-guess rule exists to prevent.
|
|
132
131
|
*/
|
|
133
132
|
export declare function resolveAliasImport(specifier: string, importingFile: string, resolution: TsconfigPathsResolution, cache: AliasResolutionCache): string | undefined;
|
|
134
133
|
//# sourceMappingURL=resolve-tsconfig-paths.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"resolve-tsconfig-paths.d.ts","sourceRoot":"","sources":["../../../src/_ipc/resolve-tsconfig-paths.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,MAAM,YAAY,CAAA;AAEhC,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,eAAe,CAAA;AAEpD;;;;;;;;;;;;;;;;;GAiBG;AAEH;;;;;;;GAOG;AACH,MAAM,WAAW,kBAAkB;IACjC,QAAQ,CAAC,KAAK,CAAC,EAAE,EAAE,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC,CAAA;IACrC,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAA;CAC1B;AAED;;;;GAIG;AACH,wBAAgB,kBAAkB,CAAC,OAAO,EAAE,EAAE,CAAC,eAAe,GAAG,kBAAkB,CAElF;AAED,4IAA4I;AAC5I,MAAM,WAAW,uBAAuB;IACtC,2GAA2G;IAC3G,QAAQ,CAAC,eAAe,EAAE,EAAE,CAAC,eAAe,CAAA;IAC5C,gFAAgF;IAChF,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAA;CAC5B;AAED;;;;;GAKG;AACH,MAAM,WAAW,oBAAoB;IACnC;;;;;;;OAOG;IACH,QAAQ,CAAC,WAAW,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC,CAAA;CACtD;AAED,sGAAsG;AACtG,wBAAgB,0BAA0B,IAAI,oBAAoB,CAEjE;AAYD,iIAAiI;AACjI,MAAM,WAAW,eAAe;IAC9B,4DAA4D;IAC5D,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;IACrB,8DAA8D;IAC9D,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAA;CACzB;AAED,MAAM,WAAW,uBAAuB;IACtC,QAAQ,CAAC,UAAU,EAAE,uBAAuB,GAAG,SAAS,CAAA;IACxD,QAAQ,CAAC,OAAO,EAAE,eAAe,GAAG,SAAS,CAAA;CAC9C;AAED;;;;;;GAMG;AACH,wBAAgB,cAAc,CAAC,IAAI,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,MAAM,CAEtE;AAED;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,wBAAsB,iBAAiB,CACrC,OAAO,EAAE,MAAM,EACf,IAAI,EAAE,MAAM,EACZ,cAAc,EAAE,MAAM,GAAG,KAAK,GAAG,SAAS,EAC1C,EAAE,EAAE,eAAe,GAClB,OAAO,CAAC,uBAAuB,CAAC,CAuElC;AAED
|
|
1
|
+
{"version":3,"file":"resolve-tsconfig-paths.d.ts","sourceRoot":"","sources":["../../../src/_ipc/resolve-tsconfig-paths.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,MAAM,YAAY,CAAA;AAEhC,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,eAAe,CAAA;AAEpD;;;;;;;;;;;;;;;;;GAiBG;AAEH;;;;;;;GAOG;AACH,MAAM,WAAW,kBAAkB;IACjC,QAAQ,CAAC,KAAK,CAAC,EAAE,EAAE,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC,CAAA;IACrC,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAA;CAC1B;AAED;;;;GAIG;AACH,wBAAgB,kBAAkB,CAAC,OAAO,EAAE,EAAE,CAAC,eAAe,GAAG,kBAAkB,CAElF;AAED,4IAA4I;AAC5I,MAAM,WAAW,uBAAuB;IACtC,2GAA2G;IAC3G,QAAQ,CAAC,eAAe,EAAE,EAAE,CAAC,eAAe,CAAA;IAC5C,gFAAgF;IAChF,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAA;CAC5B;AAED;;;;;GAKG;AACH,MAAM,WAAW,oBAAoB;IACnC;;;;;;;OAOG;IACH,QAAQ,CAAC,WAAW,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC,CAAA;CACtD;AAED,sGAAsG;AACtG,wBAAgB,0BAA0B,IAAI,oBAAoB,CAEjE;AAYD,iIAAiI;AACjI,MAAM,WAAW,eAAe;IAC9B,4DAA4D;IAC5D,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;IACrB,8DAA8D;IAC9D,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAA;CACzB;AAED,MAAM,WAAW,uBAAuB;IACtC,QAAQ,CAAC,UAAU,EAAE,uBAAuB,GAAG,SAAS,CAAA;IACxD,QAAQ,CAAC,OAAO,EAAE,eAAe,GAAG,SAAS,CAAA;CAC9C;AAED;;;;;;GAMG;AACH,wBAAgB,cAAc,CAAC,IAAI,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,MAAM,CAEtE;AAED;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,wBAAsB,iBAAiB,CACrC,OAAO,EAAE,MAAM,EACf,IAAI,EAAE,MAAM,EACZ,cAAc,EAAE,MAAM,GAAG,KAAK,GAAG,SAAS,EAC1C,EAAE,EAAE,eAAe,GAClB,OAAO,CAAC,uBAAuB,CAAC,CAuElC;AAED;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,wBAAgB,kBAAkB,CAChC,SAAS,EAAE,MAAM,EACjB,aAAa,EAAE,MAAM,EACrB,UAAU,EAAE,uBAAuB,EACnC,KAAK,EAAE,oBAAoB,GAC1B,MAAM,GAAG,SAAS,CAiBpB"}
|
|
@@ -18,9 +18,9 @@ export interface AssembleProjectOptions {
|
|
|
18
18
|
* discovery+link pass. It holds the linked contract graph and the
|
|
19
19
|
* import-resolution context. Every later resolution call
|
|
20
20
|
* (`computeScanSurface()`, `buildDependencyModel()`, ...) must reuse that
|
|
21
|
-
* context to agree with `linkResult`. It also holds a shared file-read cache
|
|
22
|
-
*
|
|
23
|
-
*
|
|
21
|
+
* context to agree with `linkResult`. It also holds a shared file-read cache.
|
|
22
|
+
* So a file that several later passes match is read from disk once. A schema
|
|
23
|
+
* file that the usage pass' broader `SCAN_INCLUDE` also matches is one case.
|
|
24
24
|
*/
|
|
25
25
|
export interface AssembledProject {
|
|
26
26
|
readonly root: string;
|
|
@@ -9,13 +9,12 @@ import type { ManifestChangeReport } from "./evidence-snapshot.js";
|
|
|
9
9
|
*
|
|
10
10
|
* @remarks
|
|
11
11
|
* Wraps `ManifestChangeReport` (`evidence-snapshot.ts`) rather than
|
|
12
|
-
* replacing it
|
|
13
|
-
* model-namespaced shape Evidence Model can assemble
|
|
14
|
-
*
|
|
15
|
-
* evidence snapshot location
|
|
16
|
-
*
|
|
17
|
-
*
|
|
18
|
-
* added).
|
|
12
|
+
* replacing it. The model gives the change report a versioned,
|
|
13
|
+
* model-namespaced shape, so Evidence Model can assemble it beside the other
|
|
14
|
+
* six. It is empty (no adds, removes or updates) when the run configures no
|
|
15
|
+
* previous evidence snapshot location. Then there is nothing to diff against.
|
|
16
|
+
* That differs from a first run *with* tracking configured, where everything
|
|
17
|
+
* reads as added.
|
|
19
18
|
*/
|
|
20
19
|
/** Bump only when a reader could misinterpret the new shape: same discipline every other canonical model's `schemaVersion` follows. */
|
|
21
20
|
export declare const CHANGE_MODEL_SCHEMA_VERSION = 1;
|
|
@@ -54,10 +53,9 @@ export interface ChangeModel {
|
|
|
54
53
|
* Wraps an already-computed `ManifestChangeReport` (e.g.
|
|
55
54
|
* `generateEnvArtifacts()`'s internal `evidenceChanges.report`) in the Change Model's versioned
|
|
56
55
|
* shape, and correlates renames using the current run's `renamedFrom`
|
|
57
|
-
* declarations. `currentContracts` should be the
|
|
58
|
-
*
|
|
59
|
-
*
|
|
60
|
-
* report family).
|
|
56
|
+
* declarations. `currentContracts` should be the contracts the manifest was
|
|
57
|
+
* generated from: active contracts only, the scope of `renderManifest()`.
|
|
58
|
+
* Every other input to this report family uses that scope too.
|
|
61
59
|
*/
|
|
62
60
|
export declare function buildChangeModel(manifest: ManifestChangeReport, currentContracts: readonly DiscoveredContract[], root: string): ChangeModel;
|
|
63
61
|
//# sourceMappingURL=change-model.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"change-model.d.ts","sourceRoot":"","sources":["../../../src/build/change-model.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,WAAW,CAAA;AACnD,OAAO,KAAK,EAAE,oBAAoB,EAAuB,MAAM,wBAAwB,CAAA;AAEvF
|
|
1
|
+
{"version":3,"file":"change-model.d.ts","sourceRoot":"","sources":["../../../src/build/change-model.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,WAAW,CAAA;AACnD,OAAO,KAAK,EAAE,oBAAoB,EAAuB,MAAM,wBAAwB,CAAA;AAEvF;;;;;;;;;;;;;;;GAeG;AAEH,uIAAuI;AACvI,eAAO,MAAM,2BAA2B,IAAI,CAAA;AAE5C,gKAAgK;AAChK,MAAM,WAAW,eAAe;IAC9B,kGAAkG;IAClG,QAAQ,CAAC,gBAAgB,EAAE,MAAM,CAAA;IACjC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;IACrB,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAA;IAC3B,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAA;IAC7B,yFAAyF;IACzF,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAA;IAC5B,sFAAsF;IACtF,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAA;CAC5B;AAED,kLAAkL;AAClL,MAAM,WAAW,WAAW;IAC1B,QAAQ,CAAC,aAAa,EAAE,OAAO,2BAA2B,CAAA;IAC1D,kQAAkQ;IAClQ,QAAQ,CAAC,QAAQ,EAAE,oBAAoB,CAAA;IACvC;;;;;;;;;;;OAWG;IACH,QAAQ,CAAC,gBAAgB,EAAE,SAAS,eAAe,EAAE,CAAA;CACtD;AAqBD;;;;;;;GAOG;AACH,wBAAgB,gBAAgB,CAC9B,QAAQ,EAAE,oBAAoB,EAC9B,gBAAgB,EAAE,SAAS,kBAAkB,EAAE,EAC/C,IAAI,EAAE,MAAM,GACX,WAAW,CAqCb"}
|
|
@@ -24,12 +24,11 @@ export interface CheckEnvArtifactsResult {
|
|
|
24
24
|
}
|
|
25
25
|
/**
|
|
26
26
|
* Parses `text` as an `EvidenceModel` and re-serializes it with
|
|
27
|
-
* `provenance.generatedAt` normalized out (see `normalizeEvidenceSnapshotForComparison()`)
|
|
28
|
-
*
|
|
29
|
-
* timestamp
|
|
30
|
-
*
|
|
31
|
-
* `
|
|
32
|
-
* crashing `--check` itself.
|
|
27
|
+
* `provenance.generatedAt` normalized out (see `normalizeEvidenceSnapshotForComparison()`).
|
|
28
|
+
* So `--check` never reports drift only because a fresh render has a newer
|
|
29
|
+
* timestamp. A parse failure returns `text` unchanged. A corrupted file on
|
|
30
|
+
* disk then fails to match the normalized `expected` and reports as
|
|
31
|
+
* `"stale"`, instead of crashing `--check`.
|
|
33
32
|
*/
|
|
34
33
|
/** @internal Exported for direct unit coverage: reached through `checkEnvArtifacts()`'s `--evidence` pass in production, but the exact "returns text unchanged, not undefined/thrown" catch behavior isn't independently observable through that public path (any malformed `actual` already reads as "stale" against a well-formed `expected`, regardless of the catch's exact return value). */
|
|
35
34
|
export declare function normalizeEvidenceJsonForComparison(text: string): string;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"check-artifacts.d.ts","sourceRoot":"","sources":["../../../src/build/check-artifacts.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,2BAA2B,EAAE,MAAM,6BAA6B,CAAA;AAU9E;;;;GAIG;AAEH,0EAA0E;AAC1E,MAAM,WAAW,oBAAoB;IACnC,sDAAsD;IACtD,QAAQ,CAAC,QAAQ,EAAE,UAAU,GAAG,MAAM,GAAG,YAAY,GAAG,OAAO,GAAG,UAAU,CAAA;IAC5E,sDAAsD;IACtD,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;IACrB,wHAAwH;IACxH,QAAQ,CAAC,MAAM,EAAE,IAAI,GAAG,OAAO,GAAG,SAAS,CAAA;IAC3C,qEAAqE;IACrE,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAA;CACzB;AAED,+DAA+D;AAC/D,MAAM,WAAW,uBAAuB;IACtC,qDAAqD;IACrD,QAAQ,CAAC,EAAE,EAAE,OAAO,CAAA;IACpB,wCAAwC;IACxC,QAAQ,CAAC,QAAQ,EAAE,SAAS,oBAAoB,EAAE,CAAA;CACnD;AAOD
|
|
1
|
+
{"version":3,"file":"check-artifacts.d.ts","sourceRoot":"","sources":["../../../src/build/check-artifacts.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,2BAA2B,EAAE,MAAM,6BAA6B,CAAA;AAU9E;;;;GAIG;AAEH,0EAA0E;AAC1E,MAAM,WAAW,oBAAoB;IACnC,sDAAsD;IACtD,QAAQ,CAAC,QAAQ,EAAE,UAAU,GAAG,MAAM,GAAG,YAAY,GAAG,OAAO,GAAG,UAAU,CAAA;IAC5E,sDAAsD;IACtD,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;IACrB,wHAAwH;IACxH,QAAQ,CAAC,MAAM,EAAE,IAAI,GAAG,OAAO,GAAG,SAAS,CAAA;IAC3C,qEAAqE;IACrE,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAA;CACzB;AAED,+DAA+D;AAC/D,MAAM,WAAW,uBAAuB;IACtC,qDAAqD;IACrD,QAAQ,CAAC,EAAE,EAAE,OAAO,CAAA;IACpB,wCAAwC;IACxC,QAAQ,CAAC,QAAQ,EAAE,SAAS,oBAAoB,EAAE,CAAA;CACnD;AAOD;;;;;;;GAOG;AACH,kYAAkY;AAClY,wBAAgB,kCAAkC,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAOvE;AAqBD;;;;;;;;;;GAUG;AACH,wBAAsB,iBAAiB,CACrC,OAAO,EAAE,2BAA2B,GACnC,OAAO,CAAC,uBAAuB,CAAC,CAwFlC"}
|
|
@@ -1,13 +1,12 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* Re-verifies developer-declared `dynamicAccess` citations every run: never
|
|
3
|
-
* trusted forever (ADR 0037). Two
|
|
4
|
-
*
|
|
5
|
-
* the second is a pure read over the first's result:
|
|
3
|
+
* trusted forever (ADR 0037). Two functions do it, because they answer two
|
|
4
|
+
* different questions and the second is a pure read over the first's result:
|
|
6
5
|
*
|
|
7
|
-
* - `buildCitationSnapshots` (this run, I/O): for every
|
|
8
|
-
*
|
|
9
|
-
*
|
|
10
|
-
*
|
|
6
|
+
* - `buildCitationSnapshots` (this run, I/O): for every declared citation, it
|
|
7
|
+
* resolves the cited file and computes a whole-file SHA-256. It compares that
|
|
8
|
+
* with the hash in the *previous* evidence snapshot to label the citation
|
|
9
|
+
* `"fresh"` / `"stale"` / `"missing"`. Existence is
|
|
11
10
|
* always re-checked live, never trusted from either snapshot. A citation
|
|
12
11
|
* with no previous baseline (the first time it's ever been seen) is
|
|
13
12
|
* `"fresh"`: there is nothing to contradict it yet. Never throws on a
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"citation-verification.d.ts","sourceRoot":"","sources":["../../../src/build/citation-verification.ts"],"names":[],"mappings":"AAAA
|
|
1
|
+
{"version":3,"file":"citation-verification.d.ts","sourceRoot":"","sources":["../../../src/build/citation-verification.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AAIH,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAA;AAExD,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,WAAW,CAAA;AAEnD,OAAO,KAAK,EAAE,sBAAsB,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAA;AAOlF,2LAA2L;AAC3L,wBAAgB,6BAA6B,CAC3C,IAAI,EAAE,MAAM,EACZ,UAAU,EAAE,MAAM,EAClB,GAAG,EAAE,MAAM,GACV,MAAM,CAER;AAyBD;;;;;;;GAOG;AACH,wBAAsB,sBAAsB,CAC1C,eAAe,EAAE,SAAS,kBAAkB,EAAE,EAC9C,QAAQ,EAAE,aAAa,GAAG,SAAS,EACnC,IAAI,EAAE,MAAM,EACZ,QAAQ,EAAE,CAAC,QAAQ,EAAE,MAAM,KAAK,OAAO,CAAC,MAAM,CAAC,GAC9C,OAAO,CAAC,WAAW,CAAC,MAAM,EAAE,SAAS,sBAAsB,EAAE,CAAC,CAAC,CAmCjE;AAED,2MAA2M;AAC3M,MAAM,WAAW,4BAA4B;IAC3C,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAA;IAC7B,sCAAsC;IACtC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;IACrB,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAA;IAC3B,2DAA2D;IAC3D,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAA;IACpB,qEAAqE;IACrE,QAAQ,CAAC,QAAQ,EAAE,cAAc,CAAA;IACjC,QAAQ,CAAC,cAAc,EAAE,OAAO,GAAG,SAAS,CAAA;CAC7C;AAED;;;;;GAKG;AACH,wBAAgB,4BAA4B,CAC1C,eAAe,EAAE,SAAS,kBAAkB,EAAE,EAC9C,IAAI,EAAE,MAAM,EACZ,eAAe,EAAE,WAAW,CAAC,MAAM,EAAE,SAAS,sBAAsB,EAAE,CAAC,GACtE,SAAS,4BAA4B,EAAE,CA2BzC"}
|
|
@@ -9,14 +9,13 @@ import type { SourcePosition } from "./source-position.js";
|
|
|
9
9
|
* variable's structural and documentation contract. See ADR 0025.
|
|
10
10
|
*
|
|
11
11
|
* @remarks
|
|
12
|
-
*
|
|
13
|
-
* (`evidence-snapshot.ts`)
|
|
14
|
-
*
|
|
15
|
-
*
|
|
16
|
-
*
|
|
17
|
-
*
|
|
18
|
-
*
|
|
19
|
-
* Finding/Evidence Model work.
|
|
12
|
+
* Broader than the `ManifestChangeReport` scope of the persisted evidence
|
|
13
|
+
* snapshot (`evidence-snapshot.ts`). That diff covers *active* contracts and
|
|
14
|
+
* *only* the `documentEnv()`-sourced fields, the scope of `renderManifest()`
|
|
15
|
+
* (ADR 0021). This model includes every discovered contract, active or not.
|
|
16
|
+
* It also includes the AST-derived schema facts (`hasDefault`/`hasProcessor`
|
|
17
|
+
* and so on) that the change report excludes. Finding Model and Evidence
|
|
18
|
+
* Model need both.
|
|
20
19
|
*/
|
|
21
20
|
/** Bump only when a reader could misinterpret the new shape (a field changes
|
|
22
21
|
* type/meaning, or is removed): NOT for every additive field. Same
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"contract-model.d.ts","sourceRoot":"","sources":["../../../src/build/contract-model.ts"],"names":[],"mappings":"AAEA,OAAO,EAAsB,KAAK,mBAAmB,EAAE,MAAM,wBAAwB,CAAA;AACrF,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,WAAW,CAAA;AACnD,OAAO,KAAK,EAAE,0BAA0B,EAAE,MAAM,YAAY,CAAA;AAC5D,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,wCAAwC,CAAA;AAC3E,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAA;AAmB1D
|
|
1
|
+
{"version":3,"file":"contract-model.d.ts","sourceRoot":"","sources":["../../../src/build/contract-model.ts"],"names":[],"mappings":"AAEA,OAAO,EAAsB,KAAK,mBAAmB,EAAE,MAAM,wBAAwB,CAAA;AACrF,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,WAAW,CAAA;AACnD,OAAO,KAAK,EAAE,0BAA0B,EAAE,MAAM,YAAY,CAAA;AAC5D,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,wCAAwC,CAAA;AAC3E,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAA;AAmB1D;;;;;;;;;;;;;GAaG;AAEH;;;kEAGkE;AAClE,eAAO,MAAM,6BAA6B,IAAI,CAAA;AAE9C;;;;;;;;;GASG;AACH,MAAM,WAAW,qBAAsB,SAAQ,mBAAmB;IAChE,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAA;IACpB,QAAQ,CAAC,UAAU,EAAE,OAAO,CAAA;IAC5B,QAAQ,CAAC,YAAY,EACnB;QAAE,QAAQ,CAAC,EAAE,EAAE,IAAI,CAAC;QAAC,QAAQ,CAAC,KAAK,EAAE,OAAO,CAAA;KAAE,GAAG;QAAE,QAAQ,CAAC,EAAE,EAAE,KAAK,CAAA;KAAE,GAAG,SAAS,CAAA;IACrF,QAAQ,CAAC,YAAY,EAAE,OAAO,CAAA;IAC9B,QAAQ,CAAC,eAAe,EAAE,MAAM,GAAG,SAAS,CAAA;IAC5C,QAAQ,CAAC,mBAAmB,EAAE,MAAM,GAAG,SAAS,CAAA;IAChD,QAAQ,CAAC,YAAY,EAAE,OAAO,CAAA;IAC9B,QAAQ,CAAC,eAAe,EAAE,MAAM,GAAG,SAAS,CAAA;IAC5C,QAAQ,CAAC,OAAO,EAAE,MAAM,GAAG,SAAS,CAAA;IACpC,QAAQ,CAAC,WAAW,EAAE,MAAM,GAAG,SAAS,CAAA;IACxC,QAAQ,CAAC,mBAAmB,EAAE,MAAM,GAAG,SAAS,CAAA;IAChD,QAAQ,CAAC,iBAAiB,EAAE,MAAM,GAAG,SAAS,CAAA;IAC9C,QAAQ,CAAC,QAAQ,EAAE,OAAO,GAAG,SAAS,CAAA;IACtC,QAAQ,CAAC,UAAU,EAAE,OAAO,CAAA;IAC5B,iMAAiM;IACjM,QAAQ,CAAC,QAAQ,EAAE,0BAA0B,GAAG,SAAS,CAAA;IACzD,2EAA2E;IAC3E,QAAQ,CAAC,WAAW,EAAE,cAAc,CAAA;CACrC;AAED,yFAAyF;AACzF,MAAM,WAAW,qBAAsB,SAAQ,mBAAmB;IAChE,gFAAgF;IAChF,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;IACrB,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAA;IAC3B,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAA;IAC7B,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAA;IACxB,QAAQ,CAAC,QAAQ,EAAE,MAAM,GAAG,SAAS,CAAA;IACrC,QAAQ,CAAC,cAAc,EAAE,MAAM,GAAG,SAAS,CAAA;IAC3C,QAAQ,CAAC,SAAS,EAAE,SAAS,qBAAqB,EAAE,CAAA;IACpD,QAAQ,CAAC,UAAU,EAAE,OAAO,CAAA;IAC5B,QAAQ,CAAC,aAAa,EAAE,aAAa,GAAG,SAAS,CAAA;IACjD,6FAA6F;IAC7F,QAAQ,CAAC,WAAW,EAAE,cAAc,CAAA;IACpC,8FAA8F;IAC9F,QAAQ,CAAC,aAAa,EAAE,cAAc,GAAG,SAAS,CAAA;CACnD;AAED,qNAAqN;AACrN,MAAM,WAAW,aAAa;IAC5B,QAAQ,CAAC,aAAa,EAAE,OAAO,6BAA6B,CAAA;IAC5D,QAAQ,CAAC,SAAS,EAAE,SAAS,qBAAqB,EAAE,CAAA;CACrD;AAED;;;;;;;;GAQG;AACH,wBAAgB,kBAAkB,CAChC,SAAS,EAAE,SAAS,kBAAkB,EAAE,EACxC,IAAI,EAAE,MAAM,GACX,aAAa,CAmDf"}
|
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* Structural equality for JSON-safe values: `documentEnv()`'s `metadata` can hold an
|
|
3
3
|
* object/array (ADR 0035), so two independently-declared-but-identical values are never `===`.
|
|
4
|
-
* Values compared here are always JSON-safe
|
|
5
|
-
* recursively
|
|
6
|
-
*
|
|
4
|
+
* Values compared here are always JSON-safe: string, number, boolean, null, array or object,
|
|
5
|
+
* recursively (see `literal-eval.ts`). So cycles, `Date`, `Map` and anything else
|
|
6
|
+
* `evaluateLiteral()` never produces need no handling.
|
|
7
7
|
*/
|
|
8
8
|
export declare function deepEqual(a: unknown, b: unknown): boolean;
|
|
9
9
|
//# sourceMappingURL=deep-equal.d.ts.map
|
|
@@ -4,14 +4,12 @@
|
|
|
4
4
|
* structure throws instead of silently succeeding.
|
|
5
5
|
*
|
|
6
6
|
* @remarks
|
|
7
|
-
*
|
|
8
|
-
*
|
|
9
|
-
* utility, so Evidence Model's own immutability guarantee (a later phase)
|
|
10
|
-
* can reuse it instead of duplicating the recursion.
|
|
7
|
+
* Generic, so the live-expiration override (ADR 0012) and Evidence Model's
|
|
8
|
+
* immutability guarantee share one recursion.
|
|
11
9
|
*
|
|
12
|
-
* Only recurses into arrays and plain objects (`{}` or `Object.create(null)`)
|
|
13
|
-
*
|
|
14
|
-
*
|
|
10
|
+
* Only recurses into arrays and plain objects (`{}` or `Object.create(null)`).
|
|
11
|
+
* A `Map`, `Set` or class instance is frozen at its top level but not walked
|
|
12
|
+
* further. This codebase's fact models are plain JSON-serializable
|
|
15
13
|
* data, never class instances, so this is deliberately narrow rather than a
|
|
16
14
|
* general-purpose deep-freeze library. A `WeakSet` guards against infinite
|
|
17
15
|
* recursion if a cyclic reference is ever passed in.
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"deep-freeze.d.ts","sourceRoot":"","sources":["../../../src/build/deep-freeze.ts"],"names":[],"mappings":"AAAA
|
|
1
|
+
{"version":3,"file":"deep-freeze.d.ts","sourceRoot":"","sources":["../../../src/build/deep-freeze.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,UAAU,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,GAAG,CAAC,CAEzC"}
|
|
@@ -69,8 +69,8 @@ export interface DependencyModel {
|
|
|
69
69
|
/**
|
|
70
70
|
* Runs the dependency-ownership engine (`buildDependencyGraph()`, Private)
|
|
71
71
|
* and projects its result into the Dependency Model's versioned,
|
|
72
|
-
* JSON-serializable shape
|
|
73
|
-
* neither `dependency-graph.ts` nor `usage-report.ts` exposes
|
|
72
|
+
* JSON-serializable shape. That shape adds the inverse file-\>contracts index,
|
|
73
|
+
* which neither `dependency-graph.ts` nor `usage-report.ts` exposes.
|
|
74
74
|
*
|
|
75
75
|
* @param scannedSurfaces - See `buildDependencyGraph()`'s own parameter of
|
|
76
76
|
* the same name: passed straight through to the published model.
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"dependency-model.d.ts","sourceRoot":"","sources":["../../../src/build/dependency-model.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAA;AAE1D,OAAO,KAAK,EAAE,cAAc,EAAE,oBAAoB,EAAE,MAAM,uBAAuB,CAAA;AACjF,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,WAAW,CAAA;AACnD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,YAAY,CAAA;AAC9C,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,gCAAgC,CAAA;AAC7E,OAAO,KAAK,EAAE,sBAAsB,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAA;AAElF;;;;;;;;;;;GAWG;AAEH,uIAAuI;AACvI,eAAO,MAAM,+BAA+B,IAAI,CAAA;AAEhD;;;;;GAKG;AACH,MAAM,WAAW,uBAAuB;IACtC,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAA;IACpB,QAAQ,CAAC,MAAM,EAAE,oBAAoB,CAAA;IACrC,0GAA0G;IAC1G,QAAQ,CAAC,SAAS,EAAE,SAAS,cAAc,EAAE,CAAA;IAC7C,iVAAiV;IACjV,QAAQ,CAAC,uBAAuB,EAAE,SAAS,sBAAsB,EAAE,CAAA;CACpE;AAED,2NAA2N;AAC3N,MAAM,WAAW,uBAAuB;IACtC,4EAA4E;IAC5E,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;IACrB,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAA;IAC3B,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAA;IAC7B,QAAQ,CAAC,QAAQ,EAAE,OAAO,CAAA;IAC1B,QAAQ,CAAC,gBAAgB,EAAE,OAAO,CAAA;IAClC,QAAQ,CAAC,SAAS,EAAE,SAAS,uBAAuB,EAAE,CAAA;IACtD,2HAA2H;IAC3H,QAAQ,CAAC,cAAc,EAAE,SAAS,MAAM,EAAE,CAAA;IAC1C,sJAAsJ;IACtJ,QAAQ,CAAC,oBAAoB,EAAE,SAAS,MAAM,EAAE,CAAA;IAChD,sGAAsG;IACtG,QAAQ,CAAC,kBAAkB,EAAE,SAAS,cAAc,EAAE,CAAA;CACvD;AAED,2IAA2I;AAC3I,MAAM,MAAM,0BAA0B,GAAG,WAAW,CAAA;AAEpD,qHAAqH;AACrH,MAAM,WAAW,uBAAuB;IACtC,sCAAsC;IACtC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;IACrB,QAAQ,CAAC,SAAS,EAAE,SAAS,0BAA0B,EAAE,CAAA;CAC1D;AAED,6HAA6H;AAC7H,MAAM,WAAW,eAAe;IAC9B,QAAQ,CAAC,aAAa,EAAE,OAAO,+BAA+B,CAAA;IAC9D,QAAQ,CAAC,SAAS,EAAE,SAAS,uBAAuB,EAAE,CAAA;IACtD,yIAAyI;IACzI,QAAQ,CAAC,SAAS,EAAE,SAAS,uBAAuB,EAAE,CAAA;IACtD,QAAQ,CAAC,QAAQ,EAAE,SAAS,YAAY,EAAE,CAAA;IAC1C,oHAAoH;IACpH,QAAQ,CAAC,eAAe,EAAE,SAAS,cAAc,EAAE,CAAA;CACpD;AAMD;;;;;;;;;;GAUG;AACH,wBAAsB,oBAAoB,CACxC,SAAS,EAAE,SAAS,kBAAkB,EAAE,EACxC,SAAS,EAAE,SAAS,MAAM,EAAE,EAC5B,QAAQ,EAAE,CAAC,QAAQ,EAAE,MAAM,KAAK,OAAO,CAAC,MAAM,CAAC,EAC/C,OAAO,EAAE,uBAAuB,EAChC,IAAI,EAAE,MAAM,EACZ,eAAe,CAAC,EAAE,SAAS,cAAc,EAAE,EAC3C,4BAA4B,CAAC,EAAE,WAAW,CAAC,MAAM,EAAE,SAAS,sBAAsB,EAAE,CAAC,GACpF,OAAO,CAAC,eAAe,CAAC,
|
|
1
|
+
{"version":3,"file":"dependency-model.d.ts","sourceRoot":"","sources":["../../../src/build/dependency-model.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAA;AAE1D,OAAO,KAAK,EAAE,cAAc,EAAE,oBAAoB,EAAE,MAAM,uBAAuB,CAAA;AACjF,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,WAAW,CAAA;AACnD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,YAAY,CAAA;AAC9C,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,gCAAgC,CAAA;AAC7E,OAAO,KAAK,EAAE,sBAAsB,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAA;AAElF;;;;;;;;;;;GAWG;AAEH,uIAAuI;AACvI,eAAO,MAAM,+BAA+B,IAAI,CAAA;AAEhD;;;;;GAKG;AACH,MAAM,WAAW,uBAAuB;IACtC,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAA;IACpB,QAAQ,CAAC,MAAM,EAAE,oBAAoB,CAAA;IACrC,0GAA0G;IAC1G,QAAQ,CAAC,SAAS,EAAE,SAAS,cAAc,EAAE,CAAA;IAC7C,iVAAiV;IACjV,QAAQ,CAAC,uBAAuB,EAAE,SAAS,sBAAsB,EAAE,CAAA;CACpE;AAED,2NAA2N;AAC3N,MAAM,WAAW,uBAAuB;IACtC,4EAA4E;IAC5E,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;IACrB,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAA;IAC3B,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAA;IAC7B,QAAQ,CAAC,QAAQ,EAAE,OAAO,CAAA;IAC1B,QAAQ,CAAC,gBAAgB,EAAE,OAAO,CAAA;IAClC,QAAQ,CAAC,SAAS,EAAE,SAAS,uBAAuB,EAAE,CAAA;IACtD,2HAA2H;IAC3H,QAAQ,CAAC,cAAc,EAAE,SAAS,MAAM,EAAE,CAAA;IAC1C,sJAAsJ;IACtJ,QAAQ,CAAC,oBAAoB,EAAE,SAAS,MAAM,EAAE,CAAA;IAChD,sGAAsG;IACtG,QAAQ,CAAC,kBAAkB,EAAE,SAAS,cAAc,EAAE,CAAA;CACvD;AAED,2IAA2I;AAC3I,MAAM,MAAM,0BAA0B,GAAG,WAAW,CAAA;AAEpD,qHAAqH;AACrH,MAAM,WAAW,uBAAuB;IACtC,sCAAsC;IACtC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;IACrB,QAAQ,CAAC,SAAS,EAAE,SAAS,0BAA0B,EAAE,CAAA;CAC1D;AAED,6HAA6H;AAC7H,MAAM,WAAW,eAAe;IAC9B,QAAQ,CAAC,aAAa,EAAE,OAAO,+BAA+B,CAAA;IAC9D,QAAQ,CAAC,SAAS,EAAE,SAAS,uBAAuB,EAAE,CAAA;IACtD,yIAAyI;IACzI,QAAQ,CAAC,SAAS,EAAE,SAAS,uBAAuB,EAAE,CAAA;IACtD,QAAQ,CAAC,QAAQ,EAAE,SAAS,YAAY,EAAE,CAAA;IAC1C,oHAAoH;IACpH,QAAQ,CAAC,eAAe,EAAE,SAAS,cAAc,EAAE,CAAA;CACpD;AAMD;;;;;;;;;;GAUG;AACH,wBAAsB,oBAAoB,CACxC,SAAS,EAAE,SAAS,kBAAkB,EAAE,EACxC,SAAS,EAAE,SAAS,MAAM,EAAE,EAC5B,QAAQ,EAAE,CAAC,QAAQ,EAAE,MAAM,KAAK,OAAO,CAAC,MAAM,CAAC,EAC/C,OAAO,EAAE,uBAAuB,EAChC,IAAI,EAAE,MAAM,EACZ,eAAe,CAAC,EAAE,SAAS,cAAc,EAAE,EAC3C,4BAA4B,CAAC,EAAE,WAAW,CAAC,MAAM,EAAE,SAAS,sBAAsB,EAAE,CAAC,GACpF,OAAO,CAAC,eAAe,CAAC,CAmE1B"}
|
|
@@ -13,9 +13,9 @@ export interface DiscoverOptions {
|
|
|
13
13
|
/**
|
|
14
14
|
* Finds every file matching `include`/`exclude` under `root`, returned as
|
|
15
15
|
* absolute paths in deterministic (alphabetically sorted) order. No count
|
|
16
|
-
* limit: the usage scan walks every TypeScript source file,
|
|
17
|
-
* project
|
|
18
|
-
*
|
|
16
|
+
* limit: the usage scan walks every TypeScript source file, and a large
|
|
17
|
+
* project has thousands. The schema-specific sanity limit lives in
|
|
18
|
+
* {@link discoverSchemaFiles}.
|
|
19
19
|
*
|
|
20
20
|
* @remarks
|
|
21
21
|
* No external glob dependency. Directories are pruned *during* the walk
|
|
@@ -26,9 +26,9 @@ export interface DiscoverOptions {
|
|
|
26
26
|
*/
|
|
27
27
|
export declare function discoverFiles(options: DiscoverOptions): Promise<string[]>;
|
|
28
28
|
/**
|
|
29
|
-
* Finds every schema file matching `include`/`exclude` under `root`,
|
|
30
|
-
*
|
|
31
|
-
*
|
|
29
|
+
* Finds every schema file matching `include`/`exclude` under `root`, as
|
|
30
|
+
* absolute paths in alphabetical order. It is the walk of `discoverFiles`,
|
|
31
|
+
* plus a sanity limit on the count.
|
|
32
32
|
*
|
|
33
33
|
* @remarks
|
|
34
34
|
* No external glob dependency. Directories are pruned *during* the walk
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"discover.d.ts","sourceRoot":"","sources":["../../../src/build/discover.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,YAAY,CAAA;AAEjD,+CAA+C;AAC/C,MAAM,WAAW,eAAe;IAC9B,+EAA+E;IAC/E,QAAQ,CAAC,EAAE,EAAE,eAAe,CAAA;IAC5B,qCAAqC;IACrC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;IACrB,2FAA2F;IAC3F,QAAQ,CAAC,OAAO,EAAE,SAAS,MAAM,EAAE,CAAA;IACnC,iGAAiG;IACjG,QAAQ,CAAC,OAAO,EAAE,SAAS,MAAM,EAAE,CAAA;CACpC;
|
|
1
|
+
{"version":3,"file":"discover.d.ts","sourceRoot":"","sources":["../../../src/build/discover.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,YAAY,CAAA;AAEjD,+CAA+C;AAC/C,MAAM,WAAW,eAAe;IAC9B,+EAA+E;IAC/E,QAAQ,CAAC,EAAE,EAAE,eAAe,CAAA;IAC5B,qCAAqC;IACrC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;IACrB,2FAA2F;IAC3F,QAAQ,CAAC,OAAO,EAAE,SAAS,MAAM,EAAE,CAAA;IACnC,iGAAiG;IACjG,QAAQ,CAAC,OAAO,EAAE,SAAS,MAAM,EAAE,CAAA;CACpC;AAeD;;;;;;;;;;;;;GAaG;AACH,wBAAsB,aAAa,CAAC,OAAO,EAAE,eAAe,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC,CAa/E;AAED;;;;;;;;;;;GAWG;AACH,wBAAsB,mBAAmB,CAAC,OAAO,EAAE,eAAe,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC,CAiBrF"}
|
|
@@ -18,8 +18,8 @@ export interface EnvExampleResult {
|
|
|
18
18
|
readonly writtenPath: string | undefined;
|
|
19
19
|
/**
|
|
20
20
|
* Set when a file already existed at the requested location and was left
|
|
21
|
-
* untouched
|
|
22
|
-
* timestamped sibling instead
|
|
21
|
+
* untouched. With the default `"keep-sibling"`, `writtenPath` is a fresh
|
|
22
|
+
* timestamped sibling instead. With `"skip"`, this is the only outcome and
|
|
23
23
|
* `writtenPath` is `undefined`. Always `undefined` with `"overwrite"`.
|
|
24
24
|
*/
|
|
25
25
|
readonly skippedExistingPath: string | undefined;
|
|
@@ -64,11 +64,10 @@ export declare function computeReconciliation(contracts: readonly DiscoveredCont
|
|
|
64
64
|
* Writes a rendered `.env.example` to `location`. Behavior when a file
|
|
65
65
|
* already exists there is governed by `options.onExisting` (default
|
|
66
66
|
* `"keep-sibling"`, see `EnvExampleOnExisting`):
|
|
67
|
-
* - `"keep-sibling"`: the existing file is left alone
|
|
68
|
-
*
|
|
69
|
-
*
|
|
70
|
-
*
|
|
71
|
-
* to report).
|
|
67
|
+
* - `"keep-sibling"`: the existing file is left alone. Fresh content goes
|
|
68
|
+
* to a timestamped sibling (`<location>.<epoch-ms>`) instead. A
|
|
69
|
+
* reconciliation header compares it with the existing file, unless there
|
|
70
|
+
* is nothing to report.
|
|
72
71
|
* - `"overwrite"`: the existing file is replaced directly with freshly
|
|
73
72
|
* rendered content; no reconciliation header (the changes it would
|
|
74
73
|
* describe are already applied).
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"env-example.d.ts","sourceRoot":"","sources":["../../../src/build/env-example.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,kBAAkB,EAAsB,MAAM,WAAW,CAAA;AACvE,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,YAAY,CAAA;AAGjD;;;;;;GAMG;AACH,MAAM,MAAM,oBAAoB,GAAG,cAAc,GAAG,WAAW,GAAG,MAAM,CAAA;AAExE,8DAA8D;AAC9D,MAAM,WAAW,gBAAgB;IAC/B;;;;OAIG;IACH,QAAQ,CAAC,WAAW,EAAE,MAAM,GAAG,SAAS,CAAA;IACxC;;;;;OAKG;IACH,QAAQ,CAAC,mBAAmB,EAAE,MAAM,GAAG,SAAS,CAAA;IAChD,+HAA+H;IAC/H,QAAQ,CAAC,cAAc,EAAE,SAAS,MAAM,EAAE,CAAA;IAC1C,uJAAuJ;IACvJ,QAAQ,CAAC,kBAAkB,EAAE,SAAS,MAAM,EAAE,CAAA;IAC9C,sHAAsH;IACtH,QAAQ,CAAC,cAAc,EAAE,SAAS,MAAM,EAAE,CAAA;CAC3C;AAED,wHAAwH;AACxH,MAAM,WAAW,cAAc;IAC7B,+HAA+H;IAC/H,QAAQ,CAAC,cAAc,EAAE,SAAS,MAAM,EAAE,CAAA;IAC1C,uJAAuJ;IACvJ,QAAQ,CAAC,kBAAkB,EAAE,SAAS,MAAM,EAAE,CAAA;IAC9C,sHAAsH;IACtH,QAAQ,CAAC,cAAc,EAAE,SAAS,MAAM,EAAE,CAAA;CAC3C;AAuED;;;;;;;;;GASG;AACH,wBAAgB,gBAAgB,CAC9B,SAAS,EAAE,SAAS,kBAAkB,EAAE,EACxC,oBAAoB,GAAE,SAAS,MAAM,EAAO,GAC3C,MAAM,CAiDR;AAED,wGAAwG;AACxG,wBAAgB,wBAAwB,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,EAAE,CAQjE;AAED,4HAA4H;AAC5H,wBAAgB,yBAAyB,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,EAAE,CAQlE;AAED;;;;GAIG;AACH,wBAAgB,qBAAqB,CACnC,SAAS,EAAE,SAAS,kBAAkB,EAAE,EACxC,eAAe,EAAE,MAAM,GACtB,cAAc,CAkBhB;AAmBD
|
|
1
|
+
{"version":3,"file":"env-example.d.ts","sourceRoot":"","sources":["../../../src/build/env-example.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,kBAAkB,EAAsB,MAAM,WAAW,CAAA;AACvE,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,YAAY,CAAA;AAGjD;;;;;;GAMG;AACH,MAAM,MAAM,oBAAoB,GAAG,cAAc,GAAG,WAAW,GAAG,MAAM,CAAA;AAExE,8DAA8D;AAC9D,MAAM,WAAW,gBAAgB;IAC/B;;;;OAIG;IACH,QAAQ,CAAC,WAAW,EAAE,MAAM,GAAG,SAAS,CAAA;IACxC;;;;;OAKG;IACH,QAAQ,CAAC,mBAAmB,EAAE,MAAM,GAAG,SAAS,CAAA;IAChD,+HAA+H;IAC/H,QAAQ,CAAC,cAAc,EAAE,SAAS,MAAM,EAAE,CAAA;IAC1C,uJAAuJ;IACvJ,QAAQ,CAAC,kBAAkB,EAAE,SAAS,MAAM,EAAE,CAAA;IAC9C,sHAAsH;IACtH,QAAQ,CAAC,cAAc,EAAE,SAAS,MAAM,EAAE,CAAA;CAC3C;AAED,wHAAwH;AACxH,MAAM,WAAW,cAAc;IAC7B,+HAA+H;IAC/H,QAAQ,CAAC,cAAc,EAAE,SAAS,MAAM,EAAE,CAAA;IAC1C,uJAAuJ;IACvJ,QAAQ,CAAC,kBAAkB,EAAE,SAAS,MAAM,EAAE,CAAA;IAC9C,sHAAsH;IACtH,QAAQ,CAAC,cAAc,EAAE,SAAS,MAAM,EAAE,CAAA;CAC3C;AAuED;;;;;;;;;GASG;AACH,wBAAgB,gBAAgB,CAC9B,SAAS,EAAE,SAAS,kBAAkB,EAAE,EACxC,oBAAoB,GAAE,SAAS,MAAM,EAAO,GAC3C,MAAM,CAiDR;AAED,wGAAwG;AACxG,wBAAgB,wBAAwB,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,EAAE,CAQjE;AAED,4HAA4H;AAC5H,wBAAgB,yBAAyB,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,EAAE,CAQlE;AAED;;;;GAIG;AACH,wBAAgB,qBAAqB,CACnC,SAAS,EAAE,SAAS,kBAAkB,EAAE,EACxC,eAAe,EAAE,MAAM,GACtB,cAAc,CAkBhB;AAmBD;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAsB,eAAe,CACnC,SAAS,EAAE,SAAS,kBAAkB,EAAE,EACxC,QAAQ,EAAE,MAAM,EAChB,EAAE,EAAE,eAAe,EACnB,OAAO,GAAE;IAAE,UAAU,CAAC,EAAE,oBAAoB,CAAA;CAAO,GAClD,OAAO,CAAC,gBAAgB,CAAC,CA6D3B"}
|
|
@@ -60,10 +60,10 @@ export declare class EnvUsageAnalysisError extends Error {
|
|
|
60
60
|
*
|
|
61
61
|
* @remarks
|
|
62
62
|
* Nothing from any pass is written when this throws: see
|
|
63
|
-
* `generate-env-artifacts.ts`'s compute-atomic guarantee (ADR 0011).
|
|
64
|
-
*
|
|
65
|
-
*
|
|
66
|
-
*
|
|
63
|
+
* `generate-env-artifacts.ts`'s compute-atomic guarantee (ADR 0011). A write-phase
|
|
64
|
+
* failure, an I/O error after every compute passed, is not wrapped in this type.
|
|
65
|
+
* It propagates as whatever `fs.writeFile` throws, because some artifacts may
|
|
66
|
+
* already be on disk by then.
|
|
67
67
|
*
|
|
68
68
|
* `code` is a stable, Stable-tier discriminant for programmatic handling:
|
|
69
69
|
* prefer it over `.name`/`instanceof` when a message-independent switch is needed.
|