@codedrifters/configulator 0.0.273 → 0.0.275
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/lib/index.d.mts +796 -1
- package/lib/index.d.ts +797 -2
- package/lib/index.js +1001 -42
- package/lib/index.js.map +1 -1
- package/lib/index.mjs +986 -44
- package/lib/index.mjs.map +1 -1
- package/package.json +1 -1
package/lib/index.d.mts
CHANGED
|
@@ -3,6 +3,7 @@ import { Project, Component as Component$1, Task } from 'projen/lib';
|
|
|
3
3
|
import { NodeProject } from 'projen/lib/javascript';
|
|
4
4
|
import { AwsCdkTypeScriptApp } from 'projen/lib/awscdk';
|
|
5
5
|
import { AwsStageType, DeploymentTargetRoleType, AwsEnvironmentType, AWS_STAGE_TYPE } from '@codedrifters/utils';
|
|
6
|
+
import * as ts from 'typescript';
|
|
6
7
|
import * as spec from '@jsii/spec';
|
|
7
8
|
import { TypeScriptProject as TypeScriptProject$1, TypeScriptAppProject, TypeScriptProjectOptions as TypeScriptProjectOptions$1 } from 'projen/lib/typescript';
|
|
8
9
|
import { ValueOf } from 'type-fest';
|
|
@@ -3469,6 +3470,37 @@ declare function renderCheckLinksProcedure(): string;
|
|
|
3469
3470
|
* findings.
|
|
3470
3471
|
*/
|
|
3471
3472
|
declare const checkLinksProcedure: AgentProcedure;
|
|
3473
|
+
/**
|
|
3474
|
+
* Render the shell body of the
|
|
3475
|
+
* `.claude/procedures/check-doc-samples.sh` helper. Exported so the
|
|
3476
|
+
* docs-sync bundle can register it as an `AgentProcedure` and the
|
|
3477
|
+
* bundles test suite can assert on the script's contents.
|
|
3478
|
+
*
|
|
3479
|
+
* The helper wraps the `compileFencedSamples` API exported from
|
|
3480
|
+
* `@codedrifters/configulator` (under `src/docs-sync/sample-compilation/`)
|
|
3481
|
+
* and emits a single JSON-array stream of failure records on stdout.
|
|
3482
|
+
* Detection is **data**, not failure: the helper exits `0` when the
|
|
3483
|
+
* compilation phase ran successfully, regardless of how many samples
|
|
3484
|
+
* failed to compile. Non-zero exits are reserved for tool-level
|
|
3485
|
+
* failures (missing binary, IO error, internal exception).
|
|
3486
|
+
*
|
|
3487
|
+
* Exit codes: `0` success, `1` usage error or unreadable docs root,
|
|
3488
|
+
* `2` a required binary is missing (`node` / `pnpm`), `3` the
|
|
3489
|
+
* compilation phase threw an unhandled exception.
|
|
3490
|
+
*/
|
|
3491
|
+
declare function renderCheckDocSamplesProcedure(): string;
|
|
3492
|
+
/**
|
|
3493
|
+
* `AgentProcedure` definition for
|
|
3494
|
+
* `.claude/procedures/check-doc-samples.sh`. Registered on the
|
|
3495
|
+
* docs-sync bundle so it ships when the bundle is force-included —
|
|
3496
|
+
* matches the packaging of `extractApiProcedure` and
|
|
3497
|
+
* `checkLinksProcedure` above. Provides the fenced-sample
|
|
3498
|
+
* compilation input the docs-sync scan phase (#520) consumes
|
|
3499
|
+
* alongside link integrity, API-extractor, TSDoc-coverage, and
|
|
3500
|
+
* doc-reference findings. Per the parent epic, fenced TS samples
|
|
3501
|
+
* that fail to compile are one of the two hard-block cases.
|
|
3502
|
+
*/
|
|
3503
|
+
declare const checkDocSamplesProcedure: AgentProcedure;
|
|
3472
3504
|
/**
|
|
3473
3505
|
* Docs-sync bundle — scaffolding release.
|
|
3474
3506
|
*
|
|
@@ -6456,6 +6488,769 @@ interface ExtractDocReferencesOptions {
|
|
|
6456
6488
|
*/
|
|
6457
6489
|
declare function extractDocReferences(options?: ExtractDocReferencesOptions): Array<DocReferenceRecord>;
|
|
6458
6490
|
|
|
6491
|
+
/**
|
|
6492
|
+
* One row in the fenced-sample extraction report — describes a single
|
|
6493
|
+
* fenced TypeScript code block found in a markdown page.
|
|
6494
|
+
*/
|
|
6495
|
+
interface FencedSampleRecord {
|
|
6496
|
+
/**
|
|
6497
|
+
* Path to the markdown file the sample was extracted from. Resolved
|
|
6498
|
+
* relative to the configured `docsRoot` so reports are stable
|
|
6499
|
+
* across machines (no absolute prefixes leak through).
|
|
6500
|
+
*/
|
|
6501
|
+
readonly docPath: string;
|
|
6502
|
+
/**
|
|
6503
|
+
* 1-indexed line number of the opening fence (the line that begins
|
|
6504
|
+
* with the three backticks), as reported by the markdown parser.
|
|
6505
|
+
*/
|
|
6506
|
+
readonly line: number;
|
|
6507
|
+
/**
|
|
6508
|
+
* 0-indexed position of this fenced block among all fenced TS-shaped
|
|
6509
|
+
* blocks in the same markdown file. Useful when a single page has
|
|
6510
|
+
* multiple samples and the consumer needs to disambiguate findings.
|
|
6511
|
+
*/
|
|
6512
|
+
readonly fenceIndex: number;
|
|
6513
|
+
/**
|
|
6514
|
+
* Language tag as written on the opening fence (e.g. `ts`,
|
|
6515
|
+
* `typescript`, `tsx`, `typescriptreact`). Always lower-cased.
|
|
6516
|
+
*/
|
|
6517
|
+
readonly lang: SampleLang;
|
|
6518
|
+
/**
|
|
6519
|
+
* Raw source of the code block, exactly as written between the
|
|
6520
|
+
* fences. Trailing newlines are preserved so the compiler sees the
|
|
6521
|
+
* same input the human author intended.
|
|
6522
|
+
*/
|
|
6523
|
+
readonly code: string;
|
|
6524
|
+
/**
|
|
6525
|
+
* `true` when the sample was tagged as opt-out (via fence meta or
|
|
6526
|
+
* an in-source pragma) and the compilation phase should skip it.
|
|
6527
|
+
* Skipped samples are still surfaced in the extraction report so
|
|
6528
|
+
* downstream consumers can audit them; the {@link compileFencedSamples}
|
|
6529
|
+
* helper filters them out before invoking `tsc`.
|
|
6530
|
+
*/
|
|
6531
|
+
readonly skipped: boolean;
|
|
6532
|
+
/**
|
|
6533
|
+
* Short description of why a sample was skipped. Empty string when
|
|
6534
|
+
* `skipped` is `false`.
|
|
6535
|
+
*/
|
|
6536
|
+
readonly skipReason: string;
|
|
6537
|
+
}
|
|
6538
|
+
/**
|
|
6539
|
+
* Recognized fenced-block language tags that the extractor treats as
|
|
6540
|
+
* compilable TypeScript samples.
|
|
6541
|
+
*/
|
|
6542
|
+
declare const SampleLang: {
|
|
6543
|
+
readonly Ts: "ts";
|
|
6544
|
+
readonly Typescript: "typescript";
|
|
6545
|
+
readonly Tsx: "tsx";
|
|
6546
|
+
readonly Typescriptreact: "typescriptreact";
|
|
6547
|
+
};
|
|
6548
|
+
/**
|
|
6549
|
+
* String-literal type matching the values of {@link SampleLang}.
|
|
6550
|
+
*/
|
|
6551
|
+
type SampleLang = (typeof SampleLang)[keyof typeof SampleLang];
|
|
6552
|
+
/**
|
|
6553
|
+
* Options accepted by {@link extractFencedSamples}.
|
|
6554
|
+
*/
|
|
6555
|
+
interface ExtractFencedSamplesOptions {
|
|
6556
|
+
/**
|
|
6557
|
+
* Absolute or repo-relative path to the docs root that should be
|
|
6558
|
+
* walked for `*.md` files. Defaults to `docs/src/content/docs/`
|
|
6559
|
+
* relative to the current working directory when omitted.
|
|
6560
|
+
*
|
|
6561
|
+
* @default "docs/src/content/docs"
|
|
6562
|
+
*/
|
|
6563
|
+
readonly docsRoot?: string;
|
|
6564
|
+
/**
|
|
6565
|
+
* When `true`, fenced blocks tagged `tsx` or `typescriptreact` are
|
|
6566
|
+
* included in the report. Defaults to `true` because the docs-sync
|
|
6567
|
+
* scan phase is JSX-aware; flip to `false` to scope a run to plain
|
|
6568
|
+
* TypeScript only.
|
|
6569
|
+
*
|
|
6570
|
+
* @default true
|
|
6571
|
+
*/
|
|
6572
|
+
readonly includeTsx?: boolean;
|
|
6573
|
+
}
|
|
6574
|
+
/**
|
|
6575
|
+
* Walks every `*.md` file under the configured docs root and returns
|
|
6576
|
+
* one record per fenced TypeScript code block.
|
|
6577
|
+
*
|
|
6578
|
+
* The walker is AST-based — markdown is parsed with
|
|
6579
|
+
* `mdast-util-from-markdown` and only `code` (fenced + indented)
|
|
6580
|
+
* nodes are inspected. The `lang` attribute on the AST node is
|
|
6581
|
+
* matched against {@link SampleLang}; fences tagged `ts`,
|
|
6582
|
+
* `typescript`, `tsx`, or `typescriptreact` produce records.
|
|
6583
|
+
* Anything else (`bash`, `json`, untagged, etc.) is skipped.
|
|
6584
|
+
*
|
|
6585
|
+
* Skip detection. A sample is recorded with `skipped: true` when
|
|
6586
|
+
* either of these conditions holds:
|
|
6587
|
+
*
|
|
6588
|
+
* - The fence's `meta` string contains the word `skip` or `no-check`
|
|
6589
|
+
* (case-insensitive) — i.e. either token follows the language tag
|
|
6590
|
+
* on the opening fence line.
|
|
6591
|
+
* - The sample's first non-blank line is the comment `// @no-check`
|
|
6592
|
+
* (case-insensitive on the directive name; the leading `//` is
|
|
6593
|
+
* required).
|
|
6594
|
+
*
|
|
6595
|
+
* @param options - Extraction options. All fields are optional; pass
|
|
6596
|
+
* an empty object to use defaults.
|
|
6597
|
+
*/
|
|
6598
|
+
declare function extractFencedSamples(options?: ExtractFencedSamplesOptions): Array<FencedSampleRecord>;
|
|
6599
|
+
|
|
6600
|
+
/**
|
|
6601
|
+
* One row in the sample-compilation report — describes a single
|
|
6602
|
+
* compilation failure. Compiles that succeeded are intentionally
|
|
6603
|
+
* absent: the docs-sync scan phase consumes failures only and treats
|
|
6604
|
+
* an empty array as "every sample compiled cleanly".
|
|
6605
|
+
*/
|
|
6606
|
+
interface SampleCompilationFailure {
|
|
6607
|
+
/**
|
|
6608
|
+
* Path to the markdown file the sample was extracted from. Resolved
|
|
6609
|
+
* relative to the configured `docsRoot` so reports are stable
|
|
6610
|
+
* across machines.
|
|
6611
|
+
*/
|
|
6612
|
+
readonly docPath: string;
|
|
6613
|
+
/**
|
|
6614
|
+
* 1-indexed line number of the opening fence in the source markdown
|
|
6615
|
+
* file (the line that begins with the three backticks).
|
|
6616
|
+
*/
|
|
6617
|
+
readonly line: number;
|
|
6618
|
+
/**
|
|
6619
|
+
* 0-indexed position of this fenced block among all fenced TS-shaped
|
|
6620
|
+
* blocks in the same markdown file.
|
|
6621
|
+
*/
|
|
6622
|
+
readonly fenceIndex: number;
|
|
6623
|
+
/**
|
|
6624
|
+
* Language tag the sample carried — one of `ts`, `typescript`,
|
|
6625
|
+
* `tsx`, or `typescriptreact`.
|
|
6626
|
+
*/
|
|
6627
|
+
readonly lang: SampleLang;
|
|
6628
|
+
/**
|
|
6629
|
+
* Flat array of compiler diagnostics, one entry per `tsc` finding.
|
|
6630
|
+
* Each entry is the message text plus any code prefix the compiler
|
|
6631
|
+
* surfaced — formatted to be self-contained so the consuming scan
|
|
6632
|
+
* report can render the failure without re-running the compiler.
|
|
6633
|
+
*/
|
|
6634
|
+
readonly diagnostics: Array<string>;
|
|
6635
|
+
}
|
|
6636
|
+
/**
|
|
6637
|
+
* Options accepted by {@link compileFencedSamples}.
|
|
6638
|
+
*/
|
|
6639
|
+
interface CompileFencedSamplesOptions extends ExtractFencedSamplesOptions {
|
|
6640
|
+
/**
|
|
6641
|
+
* Override the {@link ts.CompilerOptions} the helper uses when
|
|
6642
|
+
* compiling each sample. Merged on top of the helper's defaults
|
|
6643
|
+
* (see {@link DEFAULT_SAMPLE_COMPILER_OPTIONS}). Override sparingly:
|
|
6644
|
+
* the defaults are tuned to be permissive on prose samples (no
|
|
6645
|
+
* unused-locals/unused-parameters errors, JSX preserved for tsx,
|
|
6646
|
+
* lib targets DOM/ES2022). Setting an option to `undefined` here
|
|
6647
|
+
* removes the helper's default for that key.
|
|
6648
|
+
*/
|
|
6649
|
+
readonly compilerOptions?: ts.CompilerOptions;
|
|
6650
|
+
/**
|
|
6651
|
+
* When `true`, diagnostics carrying TS error code `2307`
|
|
6652
|
+
* ("Cannot find module …") are demoted from failures to silent
|
|
6653
|
+
* skips for repo-relative module specifiers (paths starting with
|
|
6654
|
+
* `./`, `../`, or `/`). Bare specifiers like `react` or
|
|
6655
|
+
* `@scope/pkg` are still treated as failures because they
|
|
6656
|
+
* indicate genuinely missing imports rather than docs-relative
|
|
6657
|
+
* sample drift.
|
|
6658
|
+
*
|
|
6659
|
+
* @default true
|
|
6660
|
+
*/
|
|
6661
|
+
readonly tolerateRepoRelativeMissingModule?: boolean;
|
|
6662
|
+
}
|
|
6663
|
+
/**
|
|
6664
|
+
* Default compiler options applied to every fenced sample. Tuned to
|
|
6665
|
+
* be permissive on prose samples while still surfacing real
|
|
6666
|
+
* compilation errors:
|
|
6667
|
+
*
|
|
6668
|
+
* - `target` / `module` mirror modern Node + ES module conventions.
|
|
6669
|
+
* - `lib` carries `DOM` so samples that mention `console`,
|
|
6670
|
+
* `document`, or `window` compile cleanly.
|
|
6671
|
+
* - `strict` stays on so the helper still catches type errors.
|
|
6672
|
+
* - `noUnusedLocals` / `noUnusedParameters` stay **off** because
|
|
6673
|
+
* prose samples often declare a name purely to demonstrate a
|
|
6674
|
+
* shape; flagging that as a failure would block useful docs.
|
|
6675
|
+
* - `skipLibCheck` is on so a missing `.d.ts` in a transitive
|
|
6676
|
+
* dependency does not poison the suite.
|
|
6677
|
+
* - `jsx` preserves the JSX so `tsx` fenced blocks compile.
|
|
6678
|
+
* - `noEmit` is the whole point — we only need diagnostics.
|
|
6679
|
+
*/
|
|
6680
|
+
declare const DEFAULT_SAMPLE_COMPILER_OPTIONS: ts.CompilerOptions;
|
|
6681
|
+
/**
|
|
6682
|
+
* Walks every `*.md` file under the configured docs root, extracts
|
|
6683
|
+
* fenced TypeScript samples, and runs the TypeScript compiler against
|
|
6684
|
+
* each non-skipped sample. Returns one record per failing sample —
|
|
6685
|
+
* passing samples are intentionally absent from the result.
|
|
6686
|
+
*
|
|
6687
|
+
* Each sample is compiled in its own in-memory program so unrelated
|
|
6688
|
+
* blocks never share scope. Skipped samples (fence meta `skip` /
|
|
6689
|
+
* `no-check`, or first line `// @no-check`) are passed through
|
|
6690
|
+
* unchecked.
|
|
6691
|
+
*
|
|
6692
|
+
* The helper does not invoke `tsc` as a subprocess — it uses the TS
|
|
6693
|
+
* compiler API directly with the host's `typescript` peer dependency.
|
|
6694
|
+
* That means a single test or scan run produces a single TypeScript
|
|
6695
|
+
* Program per sample, which is fast enough for the scan-phase budget
|
|
6696
|
+
* but does mean callers must not pass it the full repo's `docs/`
|
|
6697
|
+
* tree at unit-test time. Tests stay on small inline tmpdir fixtures.
|
|
6698
|
+
*
|
|
6699
|
+
* @param options - Compilation options. All fields are optional;
|
|
6700
|
+
* pass an empty object to use defaults.
|
|
6701
|
+
*/
|
|
6702
|
+
declare function compileFencedSamples(options?: CompileFencedSamplesOptions): Array<SampleCompilationFailure>;
|
|
6703
|
+
|
|
6704
|
+
/**
|
|
6705
|
+
* Schema definitions for the docs-sync scan-phase audit report.
|
|
6706
|
+
*
|
|
6707
|
+
* The report is the durable output of Phase 1 (Scan) of the docs-sync
|
|
6708
|
+
* pipeline (parent epic #448). Phase 1 walks the repo, runs every
|
|
6709
|
+
* registered drift check, and persists a single combined report to
|
|
6710
|
+
* `.claude/state/docs-sync/<N>-audit.json` (where `<N>` is the
|
|
6711
|
+
* tracking-issue number). Phase 2 (Fix) reads the persisted report
|
|
6712
|
+
* and applies mechanical fixes — the two phases never share an
|
|
6713
|
+
* in-memory handle, so the JSON shape on disk is the contract
|
|
6714
|
+
* between them.
|
|
6715
|
+
*
|
|
6716
|
+
* #518 ships the **schema and the orchestrator skeleton only**. The
|
|
6717
|
+
* actual drift checks (API/TSDoc/reference, link, fenced-sample) are
|
|
6718
|
+
* wired in by children #519 and #520 by passing additional
|
|
6719
|
+
* `AuditCheckRunner` instances to {@link runScan}. An empty
|
|
6720
|
+
* runner list is the supported scaffold-time configuration and
|
|
6721
|
+
* produces a schema-compliant report with empty findings in every
|
|
6722
|
+
* category.
|
|
6723
|
+
*
|
|
6724
|
+
* The schema is intentionally **keyed by drift-check category** at
|
|
6725
|
+
* the top level (`apiDiff`, `tsdocCoverage`, `referenceMismatches`,
|
|
6726
|
+
* `linkFailures`, `sampleFailures`) so consumers can render or
|
|
6727
|
+
* filter by category without re-grouping a flat list. Each
|
|
6728
|
+
* category-keyed array carries category-specific finding shapes,
|
|
6729
|
+
* and a flat `findings` array re-aggregates the same records with
|
|
6730
|
+
* `category` and `severity` fields attached so the report doubles
|
|
6731
|
+
* as a backlog source for downstream tooling.
|
|
6732
|
+
*/
|
|
6733
|
+
/**
|
|
6734
|
+
* Drift-check categories the docs-sync scan phase can produce
|
|
6735
|
+
* findings in. Exhaustive — adding a new category here is a schema
|
|
6736
|
+
* change that requires bumping {@link DOCS_SYNC_AUDIT_SCHEMA_VERSION}
|
|
6737
|
+
* and updating every consumer that switches on the literal.
|
|
6738
|
+
*/
|
|
6739
|
+
declare const AuditCategory: {
|
|
6740
|
+
/**
|
|
6741
|
+
* Findings produced by the public-API diff check that surfaces
|
|
6742
|
+
* added, renamed, or removed exports between the current branch
|
|
6743
|
+
* and the recorded baseline. Wired in by child issue #519.
|
|
6744
|
+
*/
|
|
6745
|
+
readonly ApiDiff: "apiDiff";
|
|
6746
|
+
/**
|
|
6747
|
+
* Findings produced by the TSDoc-coverage check that flags public
|
|
6748
|
+
* exports without a one-sentence summary. Wired in by child issue
|
|
6749
|
+
* #519.
|
|
6750
|
+
*/
|
|
6751
|
+
readonly TsdocCoverage: "tsdocCoverage";
|
|
6752
|
+
/**
|
|
6753
|
+
* Findings produced by the doc-reference cross-index check that
|
|
6754
|
+
* flags inline-code symbol mentions whose target is missing or
|
|
6755
|
+
* has changed. Wired in by child issue #519.
|
|
6756
|
+
*/
|
|
6757
|
+
readonly ReferenceMismatches: "referenceMismatches";
|
|
6758
|
+
/**
|
|
6759
|
+
* Findings produced by the link-integrity check (internal via
|
|
6760
|
+
* `astro check`, external via `lychee`). Wired in by child issue
|
|
6761
|
+
* #520.
|
|
6762
|
+
*/
|
|
6763
|
+
readonly LinkFailures: "linkFailures";
|
|
6764
|
+
/**
|
|
6765
|
+
* Findings produced by the fenced-sample compilation check that
|
|
6766
|
+
* flags ` ```ts ` / ` ```typescript ` / ` ```tsx ` blocks in the
|
|
6767
|
+
* docs that fail `tsc`. Wired in by child issue #520.
|
|
6768
|
+
*/
|
|
6769
|
+
readonly SampleFailures: "sampleFailures";
|
|
6770
|
+
};
|
|
6771
|
+
/**
|
|
6772
|
+
* String-literal type matching the values of {@link AuditCategory}.
|
|
6773
|
+
*/
|
|
6774
|
+
type AuditCategory = (typeof AuditCategory)[keyof typeof AuditCategory];
|
|
6775
|
+
/**
|
|
6776
|
+
* Severity ladder applied to every finding before persistence. The
|
|
6777
|
+
* ladder mirrors the parent epic's behavior-on-drift contract —
|
|
6778
|
+
* mechanical fixes auto-apply, advisory findings post a non-blocking
|
|
6779
|
+
* note, blocking findings hand off to `pr-reviewer` via
|
|
6780
|
+
* `review:human-required`.
|
|
6781
|
+
*/
|
|
6782
|
+
declare const AuditSeverity: {
|
|
6783
|
+
/**
|
|
6784
|
+
* The finding has a deterministic mechanical fix that the Phase 2
|
|
6785
|
+
* (Fix) agent will auto-apply (TSDoc stubs, dead-link updates,
|
|
6786
|
+
* registry sync, etc.).
|
|
6787
|
+
*/
|
|
6788
|
+
readonly Mechanical: "mechanical";
|
|
6789
|
+
/**
|
|
6790
|
+
* The finding deserves human attention but does not block the PR.
|
|
6791
|
+
* Surfaced as a non-blocking note on the sticky `## Docs sync`
|
|
6792
|
+
* comment.
|
|
6793
|
+
*/
|
|
6794
|
+
readonly Advisory: "advisory";
|
|
6795
|
+
/**
|
|
6796
|
+
* The finding blocks the PR. Per the parent epic this is reserved
|
|
6797
|
+
* for the two narrow cases of confirmed broken external links and
|
|
6798
|
+
* fenced TS samples that fail to compile.
|
|
6799
|
+
*/
|
|
6800
|
+
readonly Blocking: "blocking";
|
|
6801
|
+
};
|
|
6802
|
+
/**
|
|
6803
|
+
* String-literal type matching the values of {@link AuditSeverity}.
|
|
6804
|
+
*/
|
|
6805
|
+
type AuditSeverity = (typeof AuditSeverity)[keyof typeof AuditSeverity];
|
|
6806
|
+
/**
|
|
6807
|
+
* Invocation mode of the scan phase. Determines how downstream
|
|
6808
|
+
* tooling treats the report — `pr` reports run against a single
|
|
6809
|
+
* branch and feed `pr-reviewer`; `audit` reports walk the whole
|
|
6810
|
+
* repo and feed the prioritized `docs:write` backlog.
|
|
6811
|
+
*/
|
|
6812
|
+
declare const AuditMode: {
|
|
6813
|
+
readonly Pr: "pr";
|
|
6814
|
+
readonly Audit: "audit";
|
|
6815
|
+
};
|
|
6816
|
+
/**
|
|
6817
|
+
* String-literal type matching the values of {@link AuditMode}.
|
|
6818
|
+
*/
|
|
6819
|
+
type AuditMode = (typeof AuditMode)[keyof typeof AuditMode];
|
|
6820
|
+
/**
|
|
6821
|
+
* File-and-line location attached to most finding shapes. The
|
|
6822
|
+
* `file` field is always a path relative to the repo root so reports
|
|
6823
|
+
* are portable across machines; absolute paths must be normalized
|
|
6824
|
+
* before they reach the report.
|
|
6825
|
+
*/
|
|
6826
|
+
interface AuditLocation {
|
|
6827
|
+
/**
|
|
6828
|
+
* Path relative to {@link AuditReport.repoRoot}. Empty string is
|
|
6829
|
+
* permitted for findings that have no associated file (e.g. an
|
|
6830
|
+
* `apiDiff` removed-export finding that lost its source location).
|
|
6831
|
+
*/
|
|
6832
|
+
readonly file: string;
|
|
6833
|
+
/**
|
|
6834
|
+
* 1-indexed line number when known. `0` means "line is not known"
|
|
6835
|
+
* — downstream consumers must treat `0` as missing rather than as
|
|
6836
|
+
* the literal first line.
|
|
6837
|
+
*/
|
|
6838
|
+
readonly line: number;
|
|
6839
|
+
}
|
|
6840
|
+
/**
|
|
6841
|
+
* Common fields every finding shape carries. The category-specific
|
|
6842
|
+
* record types below extend this interface with additional fields.
|
|
6843
|
+
*/
|
|
6844
|
+
interface AuditFindingBase {
|
|
6845
|
+
/**
|
|
6846
|
+
* Drift-check category that produced the finding. Mirrors the key
|
|
6847
|
+
* on the {@link AuditReport} that the finding is filed under.
|
|
6848
|
+
*/
|
|
6849
|
+
readonly category: AuditCategory;
|
|
6850
|
+
/**
|
|
6851
|
+
* Severity classification per the {@link AuditSeverity} ladder.
|
|
6852
|
+
*/
|
|
6853
|
+
readonly severity: AuditSeverity;
|
|
6854
|
+
/**
|
|
6855
|
+
* Source location the finding is anchored at. Empty location is
|
|
6856
|
+
* tolerated for findings with no concrete anchor.
|
|
6857
|
+
*/
|
|
6858
|
+
readonly location: AuditLocation;
|
|
6859
|
+
/**
|
|
6860
|
+
* Stable subject identifier. For symbol findings this is the
|
|
6861
|
+
* exported symbol name; for link findings the URL; for sample
|
|
6862
|
+
* findings the docPath plus fence index. Used by Phase 2 to
|
|
6863
|
+
* deduplicate findings across runs.
|
|
6864
|
+
*/
|
|
6865
|
+
readonly subject: string;
|
|
6866
|
+
/**
|
|
6867
|
+
* One-sentence human-readable description of the finding.
|
|
6868
|
+
* Phase 2 surfaces this directly in the sticky PR comment, so
|
|
6869
|
+
* keep it short and self-contained — no markdown links to
|
|
6870
|
+
* external context, and never includes generated prose over the
|
|
6871
|
+
* 100-word stub budget.
|
|
6872
|
+
*/
|
|
6873
|
+
readonly details: string;
|
|
6874
|
+
/**
|
|
6875
|
+
* Optional hint for the Phase 2 fix agent. When present and the
|
|
6876
|
+
* severity is `mechanical`, Phase 2 may use this string to
|
|
6877
|
+
* compute the auto-applied edit. Free-form; downstream consumers
|
|
6878
|
+
* should treat unknown hints as no-op.
|
|
6879
|
+
*/
|
|
6880
|
+
readonly fixHint?: string;
|
|
6881
|
+
}
|
|
6882
|
+
/**
|
|
6883
|
+
* Finding produced by the public-API diff check. Wired in by #519.
|
|
6884
|
+
*/
|
|
6885
|
+
interface ApiDiffFinding extends AuditFindingBase {
|
|
6886
|
+
readonly category: typeof AuditCategory.ApiDiff;
|
|
6887
|
+
/**
|
|
6888
|
+
* Kind of API change observed. The literal `added` covers a new
|
|
6889
|
+
* export; `removed` covers a deletion; `changed` covers a
|
|
6890
|
+
* signature change that does not rename or remove the symbol.
|
|
6891
|
+
*/
|
|
6892
|
+
readonly change: "added" | "removed" | "changed";
|
|
6893
|
+
/**
|
|
6894
|
+
* Public name of the symbol whose surface changed.
|
|
6895
|
+
*/
|
|
6896
|
+
readonly symbol: string;
|
|
6897
|
+
}
|
|
6898
|
+
/**
|
|
6899
|
+
* Finding produced by the TSDoc-coverage check. Wired in by #519.
|
|
6900
|
+
*/
|
|
6901
|
+
interface TsdocCoverageFinding extends AuditFindingBase {
|
|
6902
|
+
readonly category: typeof AuditCategory.TsdocCoverage;
|
|
6903
|
+
/**
|
|
6904
|
+
* Public name of the symbol that is missing or has thin TSDoc.
|
|
6905
|
+
*/
|
|
6906
|
+
readonly symbol: string;
|
|
6907
|
+
/**
|
|
6908
|
+
* Coverage shortfall the finding reports. `missing-summary`
|
|
6909
|
+
* means no TSDoc at all; `thin-summary` means the summary exists
|
|
6910
|
+
* but is shorter than the configured threshold; `missing-params`
|
|
6911
|
+
* / `missing-returns` mean the signature has parameters or a
|
|
6912
|
+
* return value with no matching block tag.
|
|
6913
|
+
*/
|
|
6914
|
+
readonly shortfall: "missing-summary" | "thin-summary" | "missing-params" | "missing-returns";
|
|
6915
|
+
}
|
|
6916
|
+
/**
|
|
6917
|
+
* Finding produced by the doc-reference cross-index check. Wired in
|
|
6918
|
+
* by #519.
|
|
6919
|
+
*/
|
|
6920
|
+
interface ReferenceMismatchFinding extends AuditFindingBase {
|
|
6921
|
+
readonly category: typeof AuditCategory.ReferenceMismatches;
|
|
6922
|
+
/**
|
|
6923
|
+
* Inline-code symbol referenced in the markdown source.
|
|
6924
|
+
*/
|
|
6925
|
+
readonly symbol: string;
|
|
6926
|
+
/**
|
|
6927
|
+
* Why the reference is flagged. `unknown-symbol` means the
|
|
6928
|
+
* symbol does not appear in the supplied known-symbols set;
|
|
6929
|
+
* `signature-changed` means the symbol still resolves but its
|
|
6930
|
+
* type signature differs from the cached snapshot.
|
|
6931
|
+
*/
|
|
6932
|
+
readonly mismatch: "unknown-symbol" | "signature-changed";
|
|
6933
|
+
}
|
|
6934
|
+
/**
|
|
6935
|
+
* Finding produced by the link-integrity check. Wired in by #520.
|
|
6936
|
+
*/
|
|
6937
|
+
interface LinkFailureFinding extends AuditFindingBase {
|
|
6938
|
+
readonly category: typeof AuditCategory.LinkFailures;
|
|
6939
|
+
/**
|
|
6940
|
+
* URL or relative path that failed integrity checks.
|
|
6941
|
+
*/
|
|
6942
|
+
readonly url: string;
|
|
6943
|
+
/**
|
|
6944
|
+
* Whether the link is internal (resolved by `astro check`) or
|
|
6945
|
+
* external (resolved by `lychee`).
|
|
6946
|
+
*/
|
|
6947
|
+
readonly kind: "internal" | "external";
|
|
6948
|
+
/**
|
|
6949
|
+
* Short tool-supplied diagnostic explaining the failure.
|
|
6950
|
+
*/
|
|
6951
|
+
readonly reason: string;
|
|
6952
|
+
}
|
|
6953
|
+
/**
|
|
6954
|
+
* Finding produced by the fenced-sample compilation check. Wired in
|
|
6955
|
+
* by #520.
|
|
6956
|
+
*/
|
|
6957
|
+
interface SampleFailureFinding extends AuditFindingBase {
|
|
6958
|
+
readonly category: typeof AuditCategory.SampleFailures;
|
|
6959
|
+
/**
|
|
6960
|
+
* 0-indexed position of the fenced block within the markdown file.
|
|
6961
|
+
*/
|
|
6962
|
+
readonly fenceIndex: number;
|
|
6963
|
+
/**
|
|
6964
|
+
* Language tag the sample carried (e.g. `ts`, `typescript`,
|
|
6965
|
+
* `tsx`, `typescriptreact`).
|
|
6966
|
+
*/
|
|
6967
|
+
readonly lang: string;
|
|
6968
|
+
/**
|
|
6969
|
+
* Compiler diagnostics produced by `tsc` against the sample.
|
|
6970
|
+
*/
|
|
6971
|
+
readonly diagnostics: ReadonlyArray<string>;
|
|
6972
|
+
}
|
|
6973
|
+
/**
|
|
6974
|
+
* Discriminated union of every category-specific finding shape.
|
|
6975
|
+
*/
|
|
6976
|
+
type AuditFinding = ApiDiffFinding | TsdocCoverageFinding | ReferenceMismatchFinding | LinkFailureFinding | SampleFailureFinding;
|
|
6977
|
+
/**
|
|
6978
|
+
* Schema version embedded on every persisted audit report. Bump on
|
|
6979
|
+
* any breaking change to the report shape so downstream consumers
|
|
6980
|
+
* can refuse incompatible files rather than mis-parsing them.
|
|
6981
|
+
*
|
|
6982
|
+
* Versioning is **integer-monotonic**: the producer of a v2 report
|
|
6983
|
+
* is responsible for keeping the v1 fields parseable when
|
|
6984
|
+
* possible, but a v1 reader must reject a v2 report it does not
|
|
6985
|
+
* understand.
|
|
6986
|
+
*/
|
|
6987
|
+
declare const DOCS_SYNC_AUDIT_SCHEMA_VERSION = 1;
|
|
6988
|
+
/**
|
|
6989
|
+
* Top-level audit-report shape persisted to
|
|
6990
|
+
* `.claude/state/docs-sync/<N>-audit.json`. The category-keyed
|
|
6991
|
+
* arrays are the durable surface; the flat `findings` array is a
|
|
6992
|
+
* convenience aggregation of the same records.
|
|
6993
|
+
*/
|
|
6994
|
+
interface AuditReport {
|
|
6995
|
+
/**
|
|
6996
|
+
* Schema version embedded on every persisted report. Always
|
|
6997
|
+
* equal to {@link DOCS_SYNC_AUDIT_SCHEMA_VERSION} at write time.
|
|
6998
|
+
*/
|
|
6999
|
+
readonly schemaVersion: number;
|
|
7000
|
+
/**
|
|
7001
|
+
* Tracking-issue number the scan ran for. Determines the
|
|
7002
|
+
* filename when persisted (`<issueNumber>-audit.json`).
|
|
7003
|
+
*/
|
|
7004
|
+
readonly issueNumber: number;
|
|
7005
|
+
/**
|
|
7006
|
+
* Invocation mode — `pr` for diff-scoped runs invoked through
|
|
7007
|
+
* `/docs-sync-pr`, `audit` for full-repo runs invoked through
|
|
7008
|
+
* `/docs-sync-audit`.
|
|
7009
|
+
*/
|
|
7010
|
+
readonly mode: AuditMode;
|
|
7011
|
+
/**
|
|
7012
|
+
* ISO 8601 UTC timestamp the scan completed at. Always written
|
|
7013
|
+
* with `Z` suffix; consumers parse with `Date(...)`.
|
|
7014
|
+
*/
|
|
7015
|
+
readonly generatedAt: string;
|
|
7016
|
+
/**
|
|
7017
|
+
* Absolute path to the repository root the scan ran against.
|
|
7018
|
+
* Persisted so a downstream consumer reading the report on a
|
|
7019
|
+
* different checkout can rewrite paths relative to its own
|
|
7020
|
+
* root.
|
|
7021
|
+
*/
|
|
7022
|
+
readonly repoRoot: string;
|
|
7023
|
+
/**
|
|
7024
|
+
* Optional free-form scope label attached at the issue level
|
|
7025
|
+
* (e.g. `pr:feat/518-foo`, `audit:packages/configulator`).
|
|
7026
|
+
* Empty string when no scope was supplied.
|
|
7027
|
+
*/
|
|
7028
|
+
readonly scope: string;
|
|
7029
|
+
/**
|
|
7030
|
+
* Findings grouped by drift-check category. Every category key
|
|
7031
|
+
* is always present and always an array — empty arrays are
|
|
7032
|
+
* persisted explicitly so consumers never have to test for
|
|
7033
|
+
* presence.
|
|
7034
|
+
*/
|
|
7035
|
+
readonly categories: {
|
|
7036
|
+
readonly apiDiff: ReadonlyArray<ApiDiffFinding>;
|
|
7037
|
+
readonly tsdocCoverage: ReadonlyArray<TsdocCoverageFinding>;
|
|
7038
|
+
readonly referenceMismatches: ReadonlyArray<ReferenceMismatchFinding>;
|
|
7039
|
+
readonly linkFailures: ReadonlyArray<LinkFailureFinding>;
|
|
7040
|
+
readonly sampleFailures: ReadonlyArray<SampleFailureFinding>;
|
|
7041
|
+
};
|
|
7042
|
+
/**
|
|
7043
|
+
* Flat re-aggregation of every category-keyed finding into a
|
|
7044
|
+
* single deterministically-ordered array. Sorted by `severity`
|
|
7045
|
+
* (`blocking` first, then `advisory`, then `mechanical`), then
|
|
7046
|
+
* `category` (alphabetical), then `location.file`,
|
|
7047
|
+
* `location.line`, `subject`. Provided so consumers that don't
|
|
7048
|
+
* need the category grouping can iterate one array and see the
|
|
7049
|
+
* merge-blocking findings at the top.
|
|
7050
|
+
*/
|
|
7051
|
+
readonly findings: ReadonlyArray<AuditFinding>;
|
|
7052
|
+
}
|
|
7053
|
+
/**
|
|
7054
|
+
* JSON-Schema-shaped descriptor for {@link AuditReport}. Returned by
|
|
7055
|
+
* {@link auditReportJsonSchema} so downstream tooling (e.g. ajv)
|
|
7056
|
+
* can validate persisted reports without re-importing the TS
|
|
7057
|
+
* types. The shape is hand-authored and deliberately permissive on
|
|
7058
|
+
* forward-compatible additions (extra category keys are forbidden;
|
|
7059
|
+
* extra finding fields are permitted).
|
|
7060
|
+
*
|
|
7061
|
+
* Returned as a plain JSON-shaped record — callers that want to
|
|
7062
|
+
* feed it into ajv or another validator pass it through directly.
|
|
7063
|
+
*/
|
|
7064
|
+
declare function auditReportJsonSchema(): Record<string, unknown>;
|
|
7065
|
+
|
|
7066
|
+
/**
|
|
7067
|
+
* Default subdirectory beneath the repo root where audit reports are
|
|
7068
|
+
* persisted. Mirrors the path declared on issue #518's acceptance
|
|
7069
|
+
* criteria: `.claude/state/docs-sync/<N>-audit.json`.
|
|
7070
|
+
*/
|
|
7071
|
+
declare const DEFAULT_AUDIT_REPORT_DIR = ".claude/state/docs-sync";
|
|
7072
|
+
/**
|
|
7073
|
+
* Stable iteration order for category keys. Matches the order they
|
|
7074
|
+
* appear in the persisted report and the order they ran during the
|
|
7075
|
+
* scan (API surface diff first, then TSDoc, then references, then
|
|
7076
|
+
* the docs-only checks). The order is part of the contract — a
|
|
7077
|
+
* consumer that walks `Object.keys(report.categories)` sees this
|
|
7078
|
+
* order on every read.
|
|
7079
|
+
*/
|
|
7080
|
+
declare const AUDIT_CATEGORY_ORDER: ReadonlyArray<AuditCategory>;
|
|
7081
|
+
/**
|
|
7082
|
+
* One drift-check runner. The scan orchestrator invokes each
|
|
7083
|
+
* runner in registration order, collects the findings, and merges
|
|
7084
|
+
* them into the persisted report. Runners are intentionally
|
|
7085
|
+
* synchronous to keep the scaffold simple — children #519 and
|
|
7086
|
+
* #520 may introduce async runners by adding a parallel
|
|
7087
|
+
* `AsyncAuditCheckRunner` shape if needed.
|
|
7088
|
+
*
|
|
7089
|
+
* Runners are pure functions: given the same context they should
|
|
7090
|
+
* produce the same finding list. The scan orchestrator does not
|
|
7091
|
+
* sandbox them — a runner that mutates the filesystem or shells
|
|
7092
|
+
* out is on its own honor.
|
|
7093
|
+
*/
|
|
7094
|
+
interface AuditCheckRunner {
|
|
7095
|
+
/**
|
|
7096
|
+
* Stable name used in diagnostics and logs. Conventionally
|
|
7097
|
+
* matches the category the runner produces findings in (e.g.
|
|
7098
|
+
* `apiDiff`, `tsdocCoverage`).
|
|
7099
|
+
*/
|
|
7100
|
+
readonly name: string;
|
|
7101
|
+
/**
|
|
7102
|
+
* Compute the findings for this check. Runners must return
|
|
7103
|
+
* already-validated finding records — the orchestrator does not
|
|
7104
|
+
* post-process category, severity, or location.
|
|
7105
|
+
*/
|
|
7106
|
+
run(context: AuditCheckRunnerContext): ReadonlyArray<AuditFinding>;
|
|
7107
|
+
}
|
|
7108
|
+
/**
|
|
7109
|
+
* Context passed to every check runner. Carries the same fields
|
|
7110
|
+
* the orchestrator needs to populate the report header so runners
|
|
7111
|
+
* can consult them when computing their findings (e.g. resolve
|
|
7112
|
+
* relative paths against `repoRoot`).
|
|
7113
|
+
*/
|
|
7114
|
+
interface AuditCheckRunnerContext {
|
|
7115
|
+
readonly repoRoot: string;
|
|
7116
|
+
readonly mode: AuditMode;
|
|
7117
|
+
readonly scope: string;
|
|
7118
|
+
readonly issueNumber: number;
|
|
7119
|
+
}
|
|
7120
|
+
/**
|
|
7121
|
+
* Options accepted by {@link runScan}.
|
|
7122
|
+
*/
|
|
7123
|
+
interface RunScanOptions {
|
|
7124
|
+
/**
|
|
7125
|
+
* Absolute path to the repository root the scan runs against.
|
|
7126
|
+
* The audit report's `repoRoot` field is set to this value
|
|
7127
|
+
* verbatim — pass an absolute path so consumers reading the
|
|
7128
|
+
* report on a different checkout can rewrite paths reliably.
|
|
7129
|
+
*/
|
|
7130
|
+
readonly repoRoot: string;
|
|
7131
|
+
/**
|
|
7132
|
+
* Tracking-issue number the scan ran for. Determines the
|
|
7133
|
+
* persisted filename (`<issueNumber>-audit.json`).
|
|
7134
|
+
*/
|
|
7135
|
+
readonly issueNumber: number;
|
|
7136
|
+
/**
|
|
7137
|
+
* Invocation mode — `pr` for diff-scoped runs, `audit` for
|
|
7138
|
+
* full-repo runs.
|
|
7139
|
+
*/
|
|
7140
|
+
readonly mode: AuditMode;
|
|
7141
|
+
/**
|
|
7142
|
+
* Optional free-form scope label. Persisted on the report and
|
|
7143
|
+
* forwarded to every runner. Defaults to the empty string.
|
|
7144
|
+
*/
|
|
7145
|
+
readonly scope?: string;
|
|
7146
|
+
/**
|
|
7147
|
+
* Drift-check runners to invoke in order. Empty by default —
|
|
7148
|
+
* #518 ships the orchestrator skeleton without any wired
|
|
7149
|
+
* checks; #519 and #520 plug them in.
|
|
7150
|
+
*/
|
|
7151
|
+
readonly checks?: ReadonlyArray<AuditCheckRunner>;
|
|
7152
|
+
/**
|
|
7153
|
+
* Override the timestamp embedded on the report. Used in tests
|
|
7154
|
+
* to make output deterministic. Defaults to `new Date()` at
|
|
7155
|
+
* scan start.
|
|
7156
|
+
*/
|
|
7157
|
+
readonly now?: Date;
|
|
7158
|
+
/**
|
|
7159
|
+
* When `true`, persist the report to disk under
|
|
7160
|
+
* `<repoRoot>/<reportDir>/<issueNumber>-audit.json`. When
|
|
7161
|
+
* `false` (the default), the report is returned in memory only.
|
|
7162
|
+
*
|
|
7163
|
+
* @default false
|
|
7164
|
+
*/
|
|
7165
|
+
readonly persist?: boolean;
|
|
7166
|
+
/**
|
|
7167
|
+
* Override the directory the report is written to (relative to
|
|
7168
|
+
* {@link RunScanOptions.repoRoot}). Defaults to
|
|
7169
|
+
* {@link DEFAULT_AUDIT_REPORT_DIR}.
|
|
7170
|
+
*
|
|
7171
|
+
* @default ".claude/state/docs-sync"
|
|
7172
|
+
*/
|
|
7173
|
+
readonly reportDir?: string;
|
|
7174
|
+
}
|
|
7175
|
+
/**
|
|
7176
|
+
* Result returned by {@link runScan}. Always carries the report;
|
|
7177
|
+
* `reportPath` is non-empty only when persistence was requested.
|
|
7178
|
+
*/
|
|
7179
|
+
interface RunScanResult {
|
|
7180
|
+
/**
|
|
7181
|
+
* The report produced by the scan. Schema-compliant whether or
|
|
7182
|
+
* not any checks ran — empty `categories` arrays are persisted
|
|
7183
|
+
* explicitly.
|
|
7184
|
+
*/
|
|
7185
|
+
readonly report: AuditReport;
|
|
7186
|
+
/**
|
|
7187
|
+
* Absolute path the report was persisted to. Empty string when
|
|
7188
|
+
* `persist` was `false`.
|
|
7189
|
+
*/
|
|
7190
|
+
readonly reportPath: string;
|
|
7191
|
+
}
|
|
7192
|
+
/**
|
|
7193
|
+
* Run the docs-sync scan phase. Invokes every registered check
|
|
7194
|
+
* runner in order, merges the findings into a single
|
|
7195
|
+
* schema-compliant {@link AuditReport}, and optionally persists
|
|
7196
|
+
* the report to `<repoRoot>/<reportDir>/<issueNumber>-audit.json`.
|
|
7197
|
+
*
|
|
7198
|
+
* #518 ships this function with an **empty default check list**:
|
|
7199
|
+
* invoking `runScan({ repoRoot, issueNumber, mode: "pr" })`
|
|
7200
|
+
* produces a report whose `findings` and per-category arrays are
|
|
7201
|
+
* all empty. Children #519 and #520 register the real checks by
|
|
7202
|
+
* passing them via the `checks` option.
|
|
7203
|
+
*/
|
|
7204
|
+
declare function runScan(options: RunScanOptions): RunScanResult;
|
|
7205
|
+
/**
|
|
7206
|
+
* Compute the final {@link AuditReport} from a flat list of
|
|
7207
|
+
* findings. Group by category, sort each bucket deterministically,
|
|
7208
|
+
* and produce the flat `findings` aggregation in the documented
|
|
7209
|
+
* order. Exported so #519 / #520 can build reports incrementally
|
|
7210
|
+
* without re-running the whole scan.
|
|
7211
|
+
*/
|
|
7212
|
+
declare function buildReport(args: {
|
|
7213
|
+
readonly issueNumber: number;
|
|
7214
|
+
readonly mode: AuditMode;
|
|
7215
|
+
readonly scope: string;
|
|
7216
|
+
readonly repoRoot: string;
|
|
7217
|
+
readonly generatedAt: Date;
|
|
7218
|
+
readonly findings: ReadonlyArray<AuditFinding>;
|
|
7219
|
+
}): AuditReport;
|
|
7220
|
+
/**
|
|
7221
|
+
* Persist an {@link AuditReport} to disk. The directory is created
|
|
7222
|
+
* recursively when missing; the file is written atomically via a
|
|
7223
|
+
* temp-file + rename so a partial write never produces a corrupt
|
|
7224
|
+
* report.
|
|
7225
|
+
*/
|
|
7226
|
+
declare function persistAuditReport(args: {
|
|
7227
|
+
readonly report: AuditReport;
|
|
7228
|
+
readonly repoRoot: string;
|
|
7229
|
+
readonly reportDir?: string;
|
|
7230
|
+
}): string;
|
|
7231
|
+
/**
|
|
7232
|
+
* Build an empty {@link AuditReport.categories} record with every
|
|
7233
|
+
* key explicitly set to an empty array. Exported so callers that
|
|
7234
|
+
* stub the report shape in tests don't have to repeat the keys.
|
|
7235
|
+
*/
|
|
7236
|
+
declare function emptyCategoryBuckets(): {
|
|
7237
|
+
apiDiff: Array<AuditFinding & {
|
|
7238
|
+
category: typeof AuditCategory.ApiDiff;
|
|
7239
|
+
}>;
|
|
7240
|
+
tsdocCoverage: Array<AuditFinding & {
|
|
7241
|
+
category: typeof AuditCategory.TsdocCoverage;
|
|
7242
|
+
}>;
|
|
7243
|
+
referenceMismatches: Array<AuditFinding & {
|
|
7244
|
+
category: typeof AuditCategory.ReferenceMismatches;
|
|
7245
|
+
}>;
|
|
7246
|
+
linkFailures: Array<AuditFinding & {
|
|
7247
|
+
category: typeof AuditCategory.LinkFailures;
|
|
7248
|
+
}>;
|
|
7249
|
+
sampleFailures: Array<AuditFinding & {
|
|
7250
|
+
category: typeof AuditCategory.SampleFailures;
|
|
7251
|
+
}>;
|
|
7252
|
+
};
|
|
7253
|
+
|
|
6459
7254
|
/**
|
|
6460
7255
|
* One row in the TSDoc-coverage report — describes a single public
|
|
6461
7256
|
* symbol exported (transitively) from the package's entry point and
|
|
@@ -8474,4 +9269,4 @@ declare const COMPLETE_JOB_ID = "complete";
|
|
|
8474
9269
|
*/
|
|
8475
9270
|
declare function addBuildCompleteJob(buildWorkflow: BuildWorkflow): void;
|
|
8476
9271
|
|
|
8477
|
-
export { AGENT_MODEL, AGENT_PLATFORM, AGENT_RULE_SCOPE, AGENT_TIER_ROLES, AGENT_TIER_VALUES, AgentConfig, type AgentConfigOptions, type AgentExpansionRules, type AgentFeaturesConfig, type AgentModel, type AgentPathsConfig, type AgentPlatform, type AgentPlatformOverrides, type AgentProcedure, type AgentRule, type AgentRuleBundle, type AgentRuleScope, type AgentSkill, type AgentSubAgent, type AgentSubAgentPlatformOverrides, type AgentTier, type AgentTierConfig, type AgentTierEntry, type AnalyzeTsDocCoverageOptions, ApiExtractor, type ApiExtractorOptions, type ApiExtractorReportOptions, type ApproveMergeUpgradeOptions, AstroConfig, type AstroConfigOptions, type AstroIntegrationSpec, AstroOutput, AstroProject, type AstroProjectOptions, type AwsAccount, AwsCdkProject, type AwsCdkProjectOptions, AwsDeployWorkflow, AwsDeploymentConfig, AwsDeploymentTarget, type AwsDeploymentTargetOptions, type AwsLocalDeploymentConfig, type AwsOrganization, type AwsRegion, AwsTeardownWorkflow, type AwsTeardownWorkflowOptions, BUILT_IN_BUNDLES, CLAUDE_RULE_TARGET, COMPLETE_JOB_ID, type CiDeploymentConfig, type ClassTypeOptions, type ClaudeAutoModeConfig, type ClaudeHookAction, type ClaudeHookEntry, type ClaudeHooksConfig, type ClaudePermissionsConfig, type ClaudeRuleTarget, type ClaudeSandboxConfig, type ClaudeSettingsConfig, type CopilotHandoff, type CursorHookAction, type CursorHooksConfig, type CursorSettingsConfig, type CustomDocSection, DEFAULT_AC_THRESHOLDS, DEFAULT_AGENT_PATHS, DEFAULT_AGENT_TIERS, DEFAULT_API_EXTRACTOR_CONFIG_FILE, DEFAULT_API_EXTRACTOR_ENTRY_POINT, DEFAULT_API_EXTRACTOR_REPORT_FILENAME, DEFAULT_API_EXTRACTOR_REPORT_FOLDER, DEFAULT_DECOMPOSITION_TEMPLATE, DEFAULT_DELEGATE_TO_PR_REVIEWER, DEFAULT_DISPATCH_MODEL, DEFAULT_DISPATCH_TO_HOUSEKEEPING_RATIO, DEFAULT_HOUSEKEEPING_MODEL, DEFAULT_ISSUE_TEMPLATES_BUNDLE_PATH_PATTERNS, DEFAULT_ISSUE_TEMPLATES_EMIT_CHECKER, DEFAULT_ISSUE_TEMPLATES_EMIT_STARTER, DEFAULT_ISSUE_TEMPLATES_ENABLED, DEFAULT_ISSUE_TEMPLATES_PATH, DEFAULT_ISSUE_TEMPLATES_REQUIRE_REFERENCE, DEFAULT_MERGE_METHOD, DEFAULT_OFF_PEAK_CRON_EXAMPLE, DEFAULT_PARTIAL_UNBLOCK_COMMENT_TEMPLATE, DEFAULT_PRIORITY_LABELS, DEFAULT_PRODUCT_CONTEXT_PATH, DEFAULT_PROGRESS_FILES_ENABLED, DEFAULT_PROGRESS_FILES_FILENAME_PATTERN, DEFAULT_PROGRESS_FILES_FORMAT, DEFAULT_PROGRESS_FILES_STALE_AFTER_HOURS, DEFAULT_PROGRESS_FILES_STATE_DIR, DEFAULT_REQUIRE_LINKED_ISSUE, DEFAULT_REQUIRE_PRODUCT_CONTEXT, DEFAULT_SCHEDULED_TASKS_ROOT, DEFAULT_SCHEDULED_TASK_ENTRIES, DEFAULT_SHARED_EDITING_CONFLICT_STRATEGY, DEFAULT_SHARED_EDITING_EMIT_HELPER, DEFAULT_SHARED_EDITING_ENABLED, DEFAULT_SHARED_EDITING_VERIFY_COMMIT, DEFAULT_SHARED_INDEX_PATHS, DEFAULT_SKILL_EVALS_EMIT_RUNNER, DEFAULT_SKILL_EVALS_ENABLED, DEFAULT_SKILL_EVALS_SKILLS_ROOT, DEFAULT_SOURCES_THRESHOLDS, DEFAULT_STATE_FILE_PATH, DEFAULT_STATUS_LABELS, DEFAULT_TEARDOWN_BRANCH_PATTERNS, DEFAULT_TYPE_LABELS, DEFAULT_UNBLOCK_COMMENT_TEMPLATE, DEFAULT_UNBLOCK_DEPENDENTS_ENABLED, DEFAULT_WORKFLOW_DIAGRAMS_BUNDLE_PATH_PATTERNS, DEFAULT_WORKFLOW_DIAGRAMS_EMIT_CHECKER, DEFAULT_WORKFLOW_DIAGRAMS_EMIT_STARTER, DEFAULT_WORKFLOW_DIAGRAMS_ENABLED, DEFAULT_WORKFLOW_DIAGRAMS_PATH, DEFAULT_WORKFLOW_DIAGRAMS_REQUIRE_UPDATE, type DeployWorkflowOptions, type DeploymentMetadata, type DocReferenceRecord, type ExtractDocReferencesOptions, type FocusArea, type FocusAreaMatch, type FocusConfig, type GitBranch, type GitHubBoardMetadata, type GitHubProjectMetadata, type GitHubSprintMetadata, type IDependencyResolver, type IssueTemplatesConfig, JsiiFaker, LAYOUT_ENFORCEMENT, LAYOUT_ROOT_BY_PROJECT_TYPE, type LabelDefinition, type LayoutEnforcement, type LayoutViolation, MCP_TRANSPORT, MERGE_METHODS, MIMIMUM_RELEASE_AGE, MINIMUM_RELEASE_AGE, MONOREPO_LAYOUT, type McpServerConfig, type McpTransport, type MeetingArea, type MeetingScope, type MeetingType, type MeetingTypeKind, type MeetingsConfig, type MergeMethod, type MonorepoLayoutRoot, MonorepoProject, type MonorepoProjectOptions, type OrganizationMetadata, PREFLIGHT_MERGE_METHOD_VALUES, PROD_DEPLOY_NAME, PROGRESS_FILES_FORMAT_VALUES, PnpmWorkspace, type PnpmWorkspaceOptions, type PreflightMergeMethod, type PreflightPrConfig, type PriorityRule, type ProgressFilesConfig, ProjectMetadata, type ProjectMetadataOptions, REQUIREMENTS_WRITER_PATHS, ROOT_CI_TASK_NAME, ROOT_TURBO_TASK_NAME, type RemoteCacheOptions, type RepositoryMetadata, ResetTask, type ResetTaskOptions, type ResolvedAgentPaths, type ResolvedAgentTier, type ResolvedIssueTemplates, type ResolvedPreflightPr, type ResolvedProgressFiles, type ResolvedProjectMetadata, type ResolvedRunRatio, type ResolvedScheduledTask, type ResolvedScheduledTasks, type ResolvedScopeGate, type ResolvedSharedEditing, type ResolvedSkillEvals, type ResolvedUnblockDependents, type ResolvedWorkflowDiagrams, type RunRatioConfig, SCHEDULED_TASK_MODEL_VALUES, SCOPE_CLASS_VALUES, SHARED_EDITING_CONFLICT_STRATEGY_VALUES, STARLIGHT_ROLE, type ScheduledTaskEntry, type ScheduledTaskModel, type ScheduledTaskOverride, type ScheduledTasksConfig, type ScopeClass, type ScopeGateConfig, type ScopeGateThresholds, type SharedEditingConfig, type SkillEvalsConfig, type SlackMetadata, type SourceTierExamples, type StarlightEditLink, type StarlightLogo, StarlightProject, type StarlightProjectOptions, type StarlightRole, type StarlightSidebarItem, type StarlightSingletonViolation, type StarlightSocialLink, type SyncLabelsOptions, type TemplateResolveResult, TestRunner, TsDocCoverageKind, type TsDocCoverageRecord, TurboRepo, type TurboRepoOptions, TurboRepoTask, type TurboRepoTaskOptions, TypeScriptConfig, TypeScriptProject, type TypeScriptProjectOptions, UNKNOWN_TYPE_FALLBACK_TIER, type UnblockDependentsConfig, VERSION, VERSION_KEYS_SKIP, VERSION_NPM_PACKAGES, VSCodeConfig, type VersionKey, Vitest, type VitestConfigOptions, type VitestOptions, type WorkflowDiagramsConfig, addApproveMergeUpgradeWorkflow, addBuildCompleteJob, addSyncLabelsWorkflow, agendaBundle, analyzeTsDocCoverage, awsCdkBundle, baseBundle, bcmWriterBundle, buildBaseBundle, buildBcmWriterBundle, buildBuiltInBundles, buildBusinessModelsBundle, buildCheckBlockedProcedure, buildCompanyProfileBundle, buildCustomerProfileBundle, buildDocsSyncBundle, buildIndustryDiscoveryBundle, buildMaintenanceAuditBundle, buildOrchestratorConventionsContent, buildPeopleProfileBundle, buildRegulatoryResearchBundle, buildRequirementsAnalystBundle, buildRequirementsReviewerBundle, buildRequirementsWriterBundle, buildResearchPipelineBundle, buildSoftwareProfileBundle, buildStandardsResearchBundle, buildUnblockDependentsProcedure, businessModelsBundle, checkLinksProcedure, classifyIssueScope, classifyRun, companyProfileBundle, customerProfileBundle, docsSyncBundle, extractApiProcedure, extractDocReferences, formatLayoutViolation, formatStarlightSingletonViolation, getLatestEligibleVersion, githubWorkflowBundle, industryDiscoveryBundle, jestBundle, maintenanceAuditBundle, meetingAnalysisBundle, orchestratorBundle, peopleProfileBundle, pnpmBundle, prReviewBundle, projenBundle, regulatoryResearchBundle, renderAgentTierCaseStatement, renderAgentTierSection, renderCheckLinksProcedure, renderCustomDocSectionBlock, renderCustomDocSections, renderExtractApiProcedure, renderFocusSection, renderIssueTemplatesBundleHook, renderIssueTemplatesCheckerScript, renderIssueTemplatesRuleContent, renderIssueTemplatesStarterPage, renderMeetingTypesSection, renderPreflightPrSection, renderPreflightPrShellHelpers, renderPriorityRulesSection, renderProgressFileName, renderProgressFilePath, renderProgressFilesBundleHook, renderProgressFilesRuleContent, renderRunRatioSection, renderRunRatioShellHelpers, renderScheduledTaskSkillFile, renderScheduledTasksSection, renderScopeGateSection, renderScopeGateShellHelpers, renderSharedEditingBundleHook, renderSharedEditingHelperScript, renderSharedEditingRuleContent, renderSkillEvalsBundleHook, renderSkillEvalsRuleContent, renderSkillEvalsRunnerScript, renderSourceTierExamples, renderUnblockDependentsScript, renderUnblockDependentsSection, renderWorkflowDiagramsBundleHook, renderWorkflowDiagramsCheckerScript, renderWorkflowDiagramsRuleContent, renderWorkflowDiagramsStarterPage, requirementsAnalystBundle, requirementsReviewerBundle, requirementsWriterBundle, researchPipelineBundle, resolveAgentPaths, resolveAgentTiers, resolveAstroProjectOutdir, resolveAwsCdkProjectOutdir, resolveIssueTemplates, resolveModelAlias, resolveOrchestratorAssets, resolveOutdirFromPackageName, resolvePreflightPr, resolveProgressFiles, resolveRunRatio, resolveScheduledTasks, resolveScopeGate, resolveSharedEditing, resolveSkillEvals, resolveTemplateVariables, resolveTypeScriptProjectOutdir, resolveUnblockDependents, resolveWorkflowDiagrams, slackBundle, softwareProfileBundle, standardsResearchBundle, turborepoBundle, typescriptBundle, validateAgentTierConfig, validateIssueTemplatesConfig, validateMonorepoLayout, validatePreflightPrConfig, validateProgressFilesConfig, validateRunRatioConfig, validateScheduledTasksConfig, validateScopeGateConfig, validateSharedEditingConfig, validateSkillEvalsConfig, validateStarlightSingleton, validateUnblockDependentsConfig, validateWorkflowDiagramsConfig, vitestBundle };
|
|
9272
|
+
export { AGENT_MODEL, AGENT_PLATFORM, AGENT_RULE_SCOPE, AGENT_TIER_ROLES, AGENT_TIER_VALUES, AUDIT_CATEGORY_ORDER, AgentConfig, type AgentConfigOptions, type AgentExpansionRules, type AgentFeaturesConfig, type AgentModel, type AgentPathsConfig, type AgentPlatform, type AgentPlatformOverrides, type AgentProcedure, type AgentRule, type AgentRuleBundle, type AgentRuleScope, type AgentSkill, type AgentSubAgent, type AgentSubAgentPlatformOverrides, type AgentTier, type AgentTierConfig, type AgentTierEntry, type AnalyzeTsDocCoverageOptions, type ApiDiffFinding, ApiExtractor, type ApiExtractorOptions, type ApiExtractorReportOptions, type ApproveMergeUpgradeOptions, AstroConfig, type AstroConfigOptions, type AstroIntegrationSpec, AstroOutput, AstroProject, type AstroProjectOptions, AuditCategory, type AuditCheckRunner, type AuditCheckRunnerContext, type AuditFinding, type AuditFindingBase, type AuditLocation, AuditMode, type AuditReport, AuditSeverity, type AwsAccount, AwsCdkProject, type AwsCdkProjectOptions, AwsDeployWorkflow, AwsDeploymentConfig, AwsDeploymentTarget, type AwsDeploymentTargetOptions, type AwsLocalDeploymentConfig, type AwsOrganization, type AwsRegion, AwsTeardownWorkflow, type AwsTeardownWorkflowOptions, BUILT_IN_BUNDLES, CLAUDE_RULE_TARGET, COMPLETE_JOB_ID, type CiDeploymentConfig, type ClassTypeOptions, type ClaudeAutoModeConfig, type ClaudeHookAction, type ClaudeHookEntry, type ClaudeHooksConfig, type ClaudePermissionsConfig, type ClaudeRuleTarget, type ClaudeSandboxConfig, type ClaudeSettingsConfig, type CompileFencedSamplesOptions, type CopilotHandoff, type CursorHookAction, type CursorHooksConfig, type CursorSettingsConfig, type CustomDocSection, DEFAULT_AC_THRESHOLDS, DEFAULT_AGENT_PATHS, DEFAULT_AGENT_TIERS, DEFAULT_API_EXTRACTOR_CONFIG_FILE, DEFAULT_API_EXTRACTOR_ENTRY_POINT, DEFAULT_API_EXTRACTOR_REPORT_FILENAME, DEFAULT_API_EXTRACTOR_REPORT_FOLDER, DEFAULT_AUDIT_REPORT_DIR, DEFAULT_DECOMPOSITION_TEMPLATE, DEFAULT_DELEGATE_TO_PR_REVIEWER, DEFAULT_DISPATCH_MODEL, DEFAULT_DISPATCH_TO_HOUSEKEEPING_RATIO, DEFAULT_HOUSEKEEPING_MODEL, DEFAULT_ISSUE_TEMPLATES_BUNDLE_PATH_PATTERNS, DEFAULT_ISSUE_TEMPLATES_EMIT_CHECKER, DEFAULT_ISSUE_TEMPLATES_EMIT_STARTER, DEFAULT_ISSUE_TEMPLATES_ENABLED, DEFAULT_ISSUE_TEMPLATES_PATH, DEFAULT_ISSUE_TEMPLATES_REQUIRE_REFERENCE, DEFAULT_MERGE_METHOD, DEFAULT_OFF_PEAK_CRON_EXAMPLE, DEFAULT_PARTIAL_UNBLOCK_COMMENT_TEMPLATE, DEFAULT_PRIORITY_LABELS, DEFAULT_PRODUCT_CONTEXT_PATH, DEFAULT_PROGRESS_FILES_ENABLED, DEFAULT_PROGRESS_FILES_FILENAME_PATTERN, DEFAULT_PROGRESS_FILES_FORMAT, DEFAULT_PROGRESS_FILES_STALE_AFTER_HOURS, DEFAULT_PROGRESS_FILES_STATE_DIR, DEFAULT_REQUIRE_LINKED_ISSUE, DEFAULT_REQUIRE_PRODUCT_CONTEXT, DEFAULT_SAMPLE_COMPILER_OPTIONS, DEFAULT_SCHEDULED_TASKS_ROOT, DEFAULT_SCHEDULED_TASK_ENTRIES, DEFAULT_SHARED_EDITING_CONFLICT_STRATEGY, DEFAULT_SHARED_EDITING_EMIT_HELPER, DEFAULT_SHARED_EDITING_ENABLED, DEFAULT_SHARED_EDITING_VERIFY_COMMIT, DEFAULT_SHARED_INDEX_PATHS, DEFAULT_SKILL_EVALS_EMIT_RUNNER, DEFAULT_SKILL_EVALS_ENABLED, DEFAULT_SKILL_EVALS_SKILLS_ROOT, DEFAULT_SOURCES_THRESHOLDS, DEFAULT_STATE_FILE_PATH, DEFAULT_STATUS_LABELS, DEFAULT_TEARDOWN_BRANCH_PATTERNS, DEFAULT_TYPE_LABELS, DEFAULT_UNBLOCK_COMMENT_TEMPLATE, DEFAULT_UNBLOCK_DEPENDENTS_ENABLED, DEFAULT_WORKFLOW_DIAGRAMS_BUNDLE_PATH_PATTERNS, DEFAULT_WORKFLOW_DIAGRAMS_EMIT_CHECKER, DEFAULT_WORKFLOW_DIAGRAMS_EMIT_STARTER, DEFAULT_WORKFLOW_DIAGRAMS_ENABLED, DEFAULT_WORKFLOW_DIAGRAMS_PATH, DEFAULT_WORKFLOW_DIAGRAMS_REQUIRE_UPDATE, DOCS_SYNC_AUDIT_SCHEMA_VERSION, type DeployWorkflowOptions, type DeploymentMetadata, type DocReferenceRecord, type ExtractDocReferencesOptions, type ExtractFencedSamplesOptions, type FencedSampleRecord, type FocusArea, type FocusAreaMatch, type FocusConfig, type GitBranch, type GitHubBoardMetadata, type GitHubProjectMetadata, type GitHubSprintMetadata, type IDependencyResolver, type IssueTemplatesConfig, JsiiFaker, LAYOUT_ENFORCEMENT, LAYOUT_ROOT_BY_PROJECT_TYPE, type LabelDefinition, type LayoutEnforcement, type LayoutViolation, type LinkFailureFinding, MCP_TRANSPORT, MERGE_METHODS, MIMIMUM_RELEASE_AGE, MINIMUM_RELEASE_AGE, MONOREPO_LAYOUT, type McpServerConfig, type McpTransport, type MeetingArea, type MeetingScope, type MeetingType, type MeetingTypeKind, type MeetingsConfig, type MergeMethod, type MonorepoLayoutRoot, MonorepoProject, type MonorepoProjectOptions, type OrganizationMetadata, PREFLIGHT_MERGE_METHOD_VALUES, PROD_DEPLOY_NAME, PROGRESS_FILES_FORMAT_VALUES, PnpmWorkspace, type PnpmWorkspaceOptions, type PreflightMergeMethod, type PreflightPrConfig, type PriorityRule, type ProgressFilesConfig, ProjectMetadata, type ProjectMetadataOptions, REQUIREMENTS_WRITER_PATHS, ROOT_CI_TASK_NAME, ROOT_TURBO_TASK_NAME, type ReferenceMismatchFinding, type RemoteCacheOptions, type RepositoryMetadata, ResetTask, type ResetTaskOptions, type ResolvedAgentPaths, type ResolvedAgentTier, type ResolvedIssueTemplates, type ResolvedPreflightPr, type ResolvedProgressFiles, type ResolvedProjectMetadata, type ResolvedRunRatio, type ResolvedScheduledTask, type ResolvedScheduledTasks, type ResolvedScopeGate, type ResolvedSharedEditing, type ResolvedSkillEvals, type ResolvedUnblockDependents, type ResolvedWorkflowDiagrams, type RunRatioConfig, type RunScanOptions, type RunScanResult, SCHEDULED_TASK_MODEL_VALUES, SCOPE_CLASS_VALUES, SHARED_EDITING_CONFLICT_STRATEGY_VALUES, STARLIGHT_ROLE, type SampleCompilationFailure, type SampleFailureFinding, SampleLang, type ScheduledTaskEntry, type ScheduledTaskModel, type ScheduledTaskOverride, type ScheduledTasksConfig, type ScopeClass, type ScopeGateConfig, type ScopeGateThresholds, type SharedEditingConfig, type SkillEvalsConfig, type SlackMetadata, type SourceTierExamples, type StarlightEditLink, type StarlightLogo, StarlightProject, type StarlightProjectOptions, type StarlightRole, type StarlightSidebarItem, type StarlightSingletonViolation, type StarlightSocialLink, type SyncLabelsOptions, type TemplateResolveResult, TestRunner, TsDocCoverageKind, type TsDocCoverageRecord, type TsdocCoverageFinding, TurboRepo, type TurboRepoOptions, TurboRepoTask, type TurboRepoTaskOptions, TypeScriptConfig, TypeScriptProject, type TypeScriptProjectOptions, UNKNOWN_TYPE_FALLBACK_TIER, type UnblockDependentsConfig, VERSION, VERSION_KEYS_SKIP, VERSION_NPM_PACKAGES, VSCodeConfig, type VersionKey, Vitest, type VitestConfigOptions, type VitestOptions, type WorkflowDiagramsConfig, addApproveMergeUpgradeWorkflow, addBuildCompleteJob, addSyncLabelsWorkflow, agendaBundle, analyzeTsDocCoverage, auditReportJsonSchema, awsCdkBundle, baseBundle, bcmWriterBundle, buildBaseBundle, buildBcmWriterBundle, buildBuiltInBundles, buildBusinessModelsBundle, buildCheckBlockedProcedure, buildCompanyProfileBundle, buildCustomerProfileBundle, buildDocsSyncBundle, buildIndustryDiscoveryBundle, buildMaintenanceAuditBundle, buildOrchestratorConventionsContent, buildPeopleProfileBundle, buildRegulatoryResearchBundle, buildReport, buildRequirementsAnalystBundle, buildRequirementsReviewerBundle, buildRequirementsWriterBundle, buildResearchPipelineBundle, buildSoftwareProfileBundle, buildStandardsResearchBundle, buildUnblockDependentsProcedure, businessModelsBundle, checkDocSamplesProcedure, checkLinksProcedure, classifyIssueScope, classifyRun, companyProfileBundle, compileFencedSamples, customerProfileBundle, docsSyncBundle, emptyCategoryBuckets, extractApiProcedure, extractDocReferences, extractFencedSamples, formatLayoutViolation, formatStarlightSingletonViolation, getLatestEligibleVersion, githubWorkflowBundle, industryDiscoveryBundle, jestBundle, maintenanceAuditBundle, meetingAnalysisBundle, orchestratorBundle, peopleProfileBundle, persistAuditReport, pnpmBundle, prReviewBundle, projenBundle, regulatoryResearchBundle, renderAgentTierCaseStatement, renderAgentTierSection, renderCheckDocSamplesProcedure, renderCheckLinksProcedure, renderCustomDocSectionBlock, renderCustomDocSections, renderExtractApiProcedure, renderFocusSection, renderIssueTemplatesBundleHook, renderIssueTemplatesCheckerScript, renderIssueTemplatesRuleContent, renderIssueTemplatesStarterPage, renderMeetingTypesSection, renderPreflightPrSection, renderPreflightPrShellHelpers, renderPriorityRulesSection, renderProgressFileName, renderProgressFilePath, renderProgressFilesBundleHook, renderProgressFilesRuleContent, renderRunRatioSection, renderRunRatioShellHelpers, renderScheduledTaskSkillFile, renderScheduledTasksSection, renderScopeGateSection, renderScopeGateShellHelpers, renderSharedEditingBundleHook, renderSharedEditingHelperScript, renderSharedEditingRuleContent, renderSkillEvalsBundleHook, renderSkillEvalsRuleContent, renderSkillEvalsRunnerScript, renderSourceTierExamples, renderUnblockDependentsScript, renderUnblockDependentsSection, renderWorkflowDiagramsBundleHook, renderWorkflowDiagramsCheckerScript, renderWorkflowDiagramsRuleContent, renderWorkflowDiagramsStarterPage, requirementsAnalystBundle, requirementsReviewerBundle, requirementsWriterBundle, researchPipelineBundle, resolveAgentPaths, resolveAgentTiers, resolveAstroProjectOutdir, resolveAwsCdkProjectOutdir, resolveIssueTemplates, resolveModelAlias, resolveOrchestratorAssets, resolveOutdirFromPackageName, resolvePreflightPr, resolveProgressFiles, resolveRunRatio, resolveScheduledTasks, resolveScopeGate, resolveSharedEditing, resolveSkillEvals, resolveTemplateVariables, resolveTypeScriptProjectOutdir, resolveUnblockDependents, resolveWorkflowDiagrams, runScan, slackBundle, softwareProfileBundle, standardsResearchBundle, turborepoBundle, typescriptBundle, validateAgentTierConfig, validateIssueTemplatesConfig, validateMonorepoLayout, validatePreflightPrConfig, validateProgressFilesConfig, validateRunRatioConfig, validateScheduledTasksConfig, validateScopeGateConfig, validateSharedEditingConfig, validateSkillEvalsConfig, validateStarlightSingleton, validateUnblockDependentsConfig, validateWorkflowDiagramsConfig, vitestBundle };
|