@doccov/sdk 0.27.4 → 0.28.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/dist/analysis/index.d.ts +4 -21
- package/dist/analysis/index.js +2 -6
- package/dist/index.d.ts +92 -81
- package/dist/index.js +13560 -71
- package/dist/shared/{chunk-v1vce2mg.js → chunk-3p1hd5h3.js} +57 -87
- package/dist/shared/{chunk-esptwrfq.js → chunk-r4wa72ae.js} +10 -1
- package/dist/types/index.d.ts +0 -12
- package/dist/types/index.js +1 -1
- package/package.json +2 -2
package/dist/analysis/index.d.ts
CHANGED
|
@@ -297,14 +297,6 @@ interface CoverageTrend {
|
|
|
297
297
|
sparkline: number[];
|
|
298
298
|
}
|
|
299
299
|
/**
|
|
300
|
-
* Tier-based retention settings.
|
|
301
|
-
*/
|
|
302
|
-
type RetentionTier = "free" | "team" | "pro";
|
|
303
|
-
/**
|
|
304
|
-
* Retention days per tier.
|
|
305
|
-
*/
|
|
306
|
-
declare const RETENTION_DAYS: Record<RetentionTier, number>;
|
|
307
|
-
/**
|
|
308
300
|
* Weekly summary of coverage data.
|
|
309
301
|
*/
|
|
310
302
|
interface WeeklySummary {
|
|
@@ -335,8 +327,8 @@ interface ExtendedTrendAnalysis {
|
|
|
335
327
|
velocity7d: number;
|
|
336
328
|
/** 30-day velocity */
|
|
337
329
|
velocity30d: number;
|
|
338
|
-
/** 90-day velocity
|
|
339
|
-
velocity90d
|
|
330
|
+
/** 90-day velocity */
|
|
331
|
+
velocity90d: number;
|
|
340
332
|
/** Projected coverage in 30 days (based on velocity) */
|
|
341
333
|
projected30d: number;
|
|
342
334
|
/** Best coverage ever recorded */
|
|
@@ -405,14 +397,6 @@ declare function formatDelta(delta: number): string;
|
|
|
405
397
|
*/
|
|
406
398
|
declare function pruneHistory(cwd: string, keepCount?: number): number;
|
|
407
399
|
/**
|
|
408
|
-
* Prune snapshots based on tier retention policy.
|
|
409
|
-
*
|
|
410
|
-
* @param cwd - Working directory
|
|
411
|
-
* @param tier - Retention tier (free: 7d, team: 30d, pro: 90d)
|
|
412
|
-
* @returns Number of snapshots deleted
|
|
413
|
-
*/
|
|
414
|
-
declare function pruneByTier(cwd: string, tier: RetentionTier): number;
|
|
415
|
-
/**
|
|
416
400
|
* Load snapshots within a date range.
|
|
417
401
|
*
|
|
418
402
|
* @param cwd - Working directory
|
|
@@ -432,13 +416,12 @@ declare function generateWeeklySummaries(snapshots: CoverageSnapshot[]): WeeklyS
|
|
|
432
416
|
*
|
|
433
417
|
* @param spec - Current OpenPkg spec
|
|
434
418
|
* @param cwd - Working directory
|
|
435
|
-
* @param options -
|
|
419
|
+
* @param options - Optional git metadata
|
|
436
420
|
* @returns Extended trend analysis
|
|
437
421
|
*/
|
|
438
422
|
declare function getExtendedTrend(spec: OpenPkg2, cwd: string, options?: {
|
|
439
423
|
commit?: string;
|
|
440
424
|
branch?: string;
|
|
441
|
-
tier?: RetentionTier;
|
|
442
425
|
}): ExtendedTrendAnalysis;
|
|
443
426
|
import { DocCovDrift, DocCovSpec as DocCovSpec2, ExportAnalysis, MissingDocRule } from "@doccov/spec";
|
|
444
427
|
import { SpecExport as SpecExport7 } from "@openpkg-ts/spec";
|
|
@@ -692,4 +675,4 @@ interface SchemaDetectionResult {
|
|
|
692
675
|
noCompiledJsWarning?: boolean;
|
|
693
676
|
}
|
|
694
677
|
declare function detectRuntimeSchemas(context: SchemaDetectionContext): Promise<SchemaDetectionResult>;
|
|
695
|
-
export { saveSnapshot, saveReport, renderSparkline, renderApiSurface, pruneHistory,
|
|
678
|
+
export { saveSnapshot, saveReport, renderSparkline, renderApiSurface, pruneHistory, parseAssertions, loadSnapshotsForDays, loadSnapshots, loadCachedReport, isExportFullyDocumented, isCachedReportValid, hasNonAssertionComments, groupDriftsByCategory, getTrend, getExtendedTrend, getExportScore, getExportMissing, getExportDrift, getExportAnalysis, getDriftSummary, generateWeeklySummaries, generateReportFromDocCov, generateReport, formatDriftSummaryLine, formatDelta, ensureSpecCoverage, detectRuntimeSchemas, detectExampleRuntimeErrors, detectExampleAssertionFailures, computeSnapshot, computeExportDrift, computeDrift, categorizeDrift, calculateAggregateCoverage, buildExportRegistry, buildDocCovSpec, WeeklySummary, SchemaDetectionResult, SchemaDetectionContext, OpenPkgSpec, HISTORY_DIR, ExtractForgottenExport, ExtendedTrendAnalysis, ExportDriftResult, DriftSummary, DriftResult, DetectedSchemaEntry, CoverageTrend, CoverageSnapshot, CategorizedDrift, BuildDocCovOptions };
|
package/dist/analysis/index.js
CHANGED
|
@@ -1,6 +1,5 @@
|
|
|
1
1
|
import {
|
|
2
2
|
HISTORY_DIR,
|
|
3
|
-
RETENTION_DAYS,
|
|
4
3
|
buildDocCovSpec,
|
|
5
4
|
buildExportRegistry,
|
|
6
5
|
calculateAggregateCoverage,
|
|
@@ -32,21 +31,19 @@ import {
|
|
|
32
31
|
loadSnapshots,
|
|
33
32
|
loadSnapshotsForDays,
|
|
34
33
|
parseAssertions,
|
|
35
|
-
pruneByTier,
|
|
36
34
|
pruneHistory,
|
|
37
35
|
renderApiSurface,
|
|
38
36
|
renderSparkline,
|
|
39
37
|
saveReport,
|
|
40
38
|
saveSnapshot
|
|
41
|
-
} from "../shared/chunk-
|
|
42
|
-
import"../shared/chunk-
|
|
39
|
+
} from "../shared/chunk-3p1hd5h3.js";
|
|
40
|
+
import"../shared/chunk-r4wa72ae.js";
|
|
43
41
|
export {
|
|
44
42
|
saveSnapshot,
|
|
45
43
|
saveReport,
|
|
46
44
|
renderSparkline,
|
|
47
45
|
renderApiSurface,
|
|
48
46
|
pruneHistory,
|
|
49
|
-
pruneByTier,
|
|
50
47
|
parseAssertions,
|
|
51
48
|
loadSnapshotsForDays,
|
|
52
49
|
loadSnapshots,
|
|
@@ -78,6 +75,5 @@ export {
|
|
|
78
75
|
calculateAggregateCoverage,
|
|
79
76
|
buildExportRegistry,
|
|
80
77
|
buildDocCovSpec,
|
|
81
|
-
RETENTION_DAYS,
|
|
82
78
|
HISTORY_DIR
|
|
83
79
|
};
|
package/dist/index.d.ts
CHANGED
|
@@ -1,39 +1,3 @@
|
|
|
1
|
-
import { DocumentationHealth, DriftCategory, MissingDocRule } from "@doccov/spec";
|
|
2
|
-
/**
|
|
3
|
-
* Input data for computing documentation health score.
|
|
4
|
-
*/
|
|
5
|
-
interface HealthInput {
|
|
6
|
-
/** Coverage score (0-100) */
|
|
7
|
-
coverageScore: number;
|
|
8
|
-
/** Number of documented exports */
|
|
9
|
-
documentedExports: number;
|
|
10
|
-
/** Total exports analyzed */
|
|
11
|
-
totalExports: number;
|
|
12
|
-
/** Missing docs by rule */
|
|
13
|
-
missingByRule: Record<MissingDocRule, number>;
|
|
14
|
-
/** Total drift issues */
|
|
15
|
-
driftIssues: number;
|
|
16
|
-
/** Fixable drift issues */
|
|
17
|
-
fixableDrift: number;
|
|
18
|
-
/** Drift by category */
|
|
19
|
-
driftByCategory: Record<DriftCategory, number>;
|
|
20
|
-
/** Example validation results (optional) */
|
|
21
|
-
examples?: {
|
|
22
|
-
passed: number;
|
|
23
|
-
failed: number;
|
|
24
|
-
total: number;
|
|
25
|
-
};
|
|
26
|
-
}
|
|
27
|
-
/**
|
|
28
|
-
* Compute unified documentation health score.
|
|
29
|
-
*
|
|
30
|
-
* Formula: health = completeness × (1 - drift_ratio × 0.5)
|
|
31
|
-
* - Max 50% drift penalty
|
|
32
|
-
* - Optional 30% example penalty if examples validated
|
|
33
|
-
*
|
|
34
|
-
* Score thresholds: green 80+, yellow 60-79, red <60
|
|
35
|
-
*/
|
|
36
|
-
declare function computeHealth(input: HealthInput): DocumentationHealth;
|
|
37
1
|
import { DocCovSpec, TypeReferenceLocation } from "@doccov/spec";
|
|
38
2
|
import { OpenPkg } from "@openpkg-ts/spec";
|
|
39
3
|
type OpenPkgSpec = OpenPkg;
|
|
@@ -79,19 +43,19 @@ type SpecDocDrift = {
|
|
|
79
43
|
/**
|
|
80
44
|
* Drift categories group related drift types for progressive disclosure.
|
|
81
45
|
*/
|
|
82
|
-
type
|
|
46
|
+
type DriftCategory = "structural" | "semantic" | "example";
|
|
83
47
|
/**
|
|
84
48
|
* Maps each drift type to its category.
|
|
85
49
|
*/
|
|
86
|
-
declare const DRIFT_CATEGORIES: Record<DriftType,
|
|
50
|
+
declare const DRIFT_CATEGORIES: Record<DriftType, DriftCategory>;
|
|
87
51
|
/**
|
|
88
52
|
* Human-readable category labels.
|
|
89
53
|
*/
|
|
90
|
-
declare const DRIFT_CATEGORY_LABELS: Record<
|
|
54
|
+
declare const DRIFT_CATEGORY_LABELS: Record<DriftCategory, string>;
|
|
91
55
|
/**
|
|
92
56
|
* Category descriptions for help text.
|
|
93
57
|
*/
|
|
94
|
-
declare const DRIFT_CATEGORY_DESCRIPTIONS: Record<
|
|
58
|
+
declare const DRIFT_CATEGORY_DESCRIPTIONS: Record<DriftCategory, string>;
|
|
95
59
|
/**
|
|
96
60
|
* Result of computing drift for a single export.
|
|
97
61
|
*/
|
|
@@ -128,7 +92,7 @@ interface ExportRegistry {
|
|
|
128
92
|
* Extended drift with category and fixability metadata.
|
|
129
93
|
*/
|
|
130
94
|
interface CategorizedDrift extends SpecDocDrift {
|
|
131
|
-
category:
|
|
95
|
+
category: DriftCategory;
|
|
132
96
|
fixable: boolean;
|
|
133
97
|
}
|
|
134
98
|
/**
|
|
@@ -136,7 +100,7 @@ interface CategorizedDrift extends SpecDocDrift {
|
|
|
136
100
|
*/
|
|
137
101
|
interface DriftSummary {
|
|
138
102
|
total: number;
|
|
139
|
-
byCategory: Record<
|
|
103
|
+
byCategory: Record<DriftCategory, number>;
|
|
140
104
|
fixable: number;
|
|
141
105
|
}
|
|
142
106
|
/**
|
|
@@ -172,7 +136,7 @@ declare function categorizeDrift(drift: SpecDocDrift): CategorizedDrift;
|
|
|
172
136
|
* console.log(grouped.example.length); // Number of example issues
|
|
173
137
|
* ```
|
|
174
138
|
*/
|
|
175
|
-
declare function groupDriftsByCategory(drifts: SpecDocDrift[]): Record<
|
|
139
|
+
declare function groupDriftsByCategory(drifts: SpecDocDrift[]): Record<DriftCategory, CategorizedDrift[]>;
|
|
176
140
|
/**
|
|
177
141
|
* Get drift summary counts by category.
|
|
178
142
|
*
|
|
@@ -337,6 +301,42 @@ declare function hasNonAssertionComments(code: string): boolean;
|
|
|
337
301
|
* Detect assertion failures by comparing stdout to expected values.
|
|
338
302
|
*/
|
|
339
303
|
declare function detectExampleAssertionFailures(entry: SpecExport2, runtimeResults: Map<number, ExampleRunResult>): SpecDocDrift[];
|
|
304
|
+
import { DocumentationHealth, DriftCategory as DriftCategory2, MissingDocRule } from "@doccov/spec";
|
|
305
|
+
/**
|
|
306
|
+
* Input data for computing documentation health score.
|
|
307
|
+
*/
|
|
308
|
+
interface HealthInput {
|
|
309
|
+
/** Coverage score (0-100) */
|
|
310
|
+
coverageScore: number;
|
|
311
|
+
/** Number of documented exports */
|
|
312
|
+
documentedExports: number;
|
|
313
|
+
/** Total exports analyzed */
|
|
314
|
+
totalExports: number;
|
|
315
|
+
/** Missing docs by rule */
|
|
316
|
+
missingByRule: Record<MissingDocRule, number>;
|
|
317
|
+
/** Total drift issues */
|
|
318
|
+
driftIssues: number;
|
|
319
|
+
/** Fixable drift issues */
|
|
320
|
+
fixableDrift: number;
|
|
321
|
+
/** Drift by category */
|
|
322
|
+
driftByCategory: Record<DriftCategory2, number>;
|
|
323
|
+
/** Example validation results (optional) */
|
|
324
|
+
examples?: {
|
|
325
|
+
passed: number;
|
|
326
|
+
failed: number;
|
|
327
|
+
total: number;
|
|
328
|
+
};
|
|
329
|
+
}
|
|
330
|
+
/**
|
|
331
|
+
* Compute unified documentation health score.
|
|
332
|
+
*
|
|
333
|
+
* Formula: health = completeness × (1 - drift_ratio × 0.5)
|
|
334
|
+
* - Max 50% drift penalty
|
|
335
|
+
* - Optional 30% example penalty if examples validated
|
|
336
|
+
*
|
|
337
|
+
* Score thresholds: green 80+, yellow 60-79, red <60
|
|
338
|
+
*/
|
|
339
|
+
declare function computeHealth(input: HealthInput): DocumentationHealth;
|
|
340
340
|
import { DocCovDrift, DocCovSpec as DocCovSpec2, ExportAnalysis, MissingDocRule as MissingDocRule2 } from "@doccov/spec";
|
|
341
341
|
import { SpecExport as SpecExport7 } from "@openpkg-ts/spec";
|
|
342
342
|
/**
|
|
@@ -441,7 +441,7 @@ interface DriftReportSummary {
|
|
|
441
441
|
/**
|
|
442
442
|
* Count of issues per category.
|
|
443
443
|
*/
|
|
444
|
-
byCategory: Record<
|
|
444
|
+
byCategory: Record<DriftCategory, number>;
|
|
445
445
|
/**
|
|
446
446
|
* Number of auto-fixable issues.
|
|
447
447
|
*/
|
|
@@ -463,7 +463,7 @@ interface DriftReport {
|
|
|
463
463
|
/**
|
|
464
464
|
* Issues grouped by category.
|
|
465
465
|
*/
|
|
466
|
-
byCategory: Record<
|
|
466
|
+
byCategory: Record<DriftCategory, CategorizedDrift[]>;
|
|
467
467
|
/**
|
|
468
468
|
* Flat list of all drift issues (backward compatible).
|
|
469
469
|
*/
|
|
@@ -784,6 +784,7 @@ interface FilterOptions {
|
|
|
784
784
|
/** Filter by visibility/release stage (e.g., ['public', 'beta']) */
|
|
785
785
|
visibility?: ReleaseTag[];
|
|
786
786
|
}
|
|
787
|
+
import { z } from "zod";
|
|
787
788
|
/**
|
|
788
789
|
* Configuration types for DocCov.
|
|
789
790
|
* These types are shared between CLI and API.
|
|
@@ -834,18 +835,6 @@ interface CheckConfig {
|
|
|
834
835
|
examples?: ExampleValidationMode | ExampleValidationMode[] | string;
|
|
835
836
|
/** Minimum health score required (0-100). Unified metric combining coverage + accuracy. */
|
|
836
837
|
minHealth?: number;
|
|
837
|
-
/**
|
|
838
|
-
* Minimum coverage percentage required (0-100)
|
|
839
|
-
* @deprecated Use `minHealth` instead. Will be removed in next major.
|
|
840
|
-
*/
|
|
841
|
-
minCoverage?: number;
|
|
842
|
-
/**
|
|
843
|
-
* Maximum drift percentage allowed (0-100)
|
|
844
|
-
* @deprecated Use `minHealth` instead. Drift is now factored into health score.
|
|
845
|
-
*/
|
|
846
|
-
maxDrift?: number;
|
|
847
|
-
/** Minimum API surface completeness percentage (0-100) - deprecated, use apiSurface.minCompleteness */
|
|
848
|
-
minApiSurface?: number;
|
|
849
838
|
/** API surface configuration */
|
|
850
839
|
apiSurface?: ApiSurfaceConfig;
|
|
851
840
|
}
|
|
@@ -892,12 +881,51 @@ interface DocCovConfig {
|
|
|
892
881
|
* include: ['MyClass', 'myFunction'],
|
|
893
882
|
* exclude: ['internal*'],
|
|
894
883
|
* check: {
|
|
895
|
-
*
|
|
884
|
+
* minHealth: 80,
|
|
896
885
|
* },
|
|
897
886
|
* });
|
|
898
887
|
* ```
|
|
899
888
|
*/
|
|
900
889
|
declare function defineConfig(config: DocCovConfig): DocCovConfig;
|
|
890
|
+
declare const stringList: z.ZodUnion<[z.ZodString, z.ZodArray<z.ZodString, "many">]>;
|
|
891
|
+
/**
|
|
892
|
+
* Docs configuration schema
|
|
893
|
+
*/
|
|
894
|
+
declare const docsConfigSchema: z.ZodObject<{
|
|
895
|
+
include: z.ZodOptional<typeof stringList>;
|
|
896
|
+
exclude: z.ZodOptional<typeof stringList>;
|
|
897
|
+
}>;
|
|
898
|
+
/** Example validation mode */
|
|
899
|
+
declare const exampleModeSchema: z.ZodEnum<["presence", "typecheck", "run"]>;
|
|
900
|
+
/** Example validation modes - can be single, array, or comma-separated */
|
|
901
|
+
declare const exampleModesSchema: z.ZodUnion<[typeof exampleModeSchema, z.ZodArray<typeof exampleModeSchema>, z.ZodString]>;
|
|
902
|
+
/**
|
|
903
|
+
* API surface configuration schema.
|
|
904
|
+
*/
|
|
905
|
+
declare const apiSurfaceConfigSchema: z.ZodObject<{
|
|
906
|
+
minCompleteness: z.ZodOptional<z.ZodNumber>;
|
|
907
|
+
warnBelow: z.ZodOptional<z.ZodNumber>;
|
|
908
|
+
ignore: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
909
|
+
}>;
|
|
910
|
+
/**
|
|
911
|
+
* Check command configuration schema.
|
|
912
|
+
*/
|
|
913
|
+
declare const checkConfigSchema: z.ZodObject<{
|
|
914
|
+
examples: z.ZodOptional<typeof exampleModesSchema>;
|
|
915
|
+
minHealth: z.ZodOptional<z.ZodNumber>;
|
|
916
|
+
minCoverage: z.ZodOptional<z.ZodNumber>;
|
|
917
|
+
maxDrift: z.ZodOptional<z.ZodNumber>;
|
|
918
|
+
apiSurface: z.ZodOptional<typeof apiSurfaceConfigSchema>;
|
|
919
|
+
}>;
|
|
920
|
+
declare const docCovConfigSchema: z.ZodObject<{
|
|
921
|
+
include: z.ZodOptional<typeof stringList>;
|
|
922
|
+
exclude: z.ZodOptional<typeof stringList>;
|
|
923
|
+
plugins: z.ZodOptional<z.ZodArray<z.ZodUnknown>>;
|
|
924
|
+
docs: z.ZodOptional<typeof docsConfigSchema>;
|
|
925
|
+
check: z.ZodOptional<typeof checkConfigSchema>;
|
|
926
|
+
}>;
|
|
927
|
+
type DocCovConfigInput = z.infer<typeof docCovConfigSchema>;
|
|
928
|
+
declare const normalizeConfig: (input: DocCovConfigInput) => DocCovConfig;
|
|
901
929
|
interface DocCovOptions {
|
|
902
930
|
includePrivate?: boolean;
|
|
903
931
|
followImports?: boolean;
|
|
@@ -1995,14 +2023,6 @@ interface CoverageTrend {
|
|
|
1995
2023
|
sparkline: number[];
|
|
1996
2024
|
}
|
|
1997
2025
|
/**
|
|
1998
|
-
* Tier-based retention settings.
|
|
1999
|
-
*/
|
|
2000
|
-
type RetentionTier = "free" | "team" | "pro";
|
|
2001
|
-
/**
|
|
2002
|
-
* Retention days per tier.
|
|
2003
|
-
*/
|
|
2004
|
-
declare const RETENTION_DAYS: Record<RetentionTier, number>;
|
|
2005
|
-
/**
|
|
2006
2026
|
* Weekly summary of coverage data.
|
|
2007
2027
|
*/
|
|
2008
2028
|
interface WeeklySummary {
|
|
@@ -2033,8 +2053,8 @@ interface ExtendedTrendAnalysis {
|
|
|
2033
2053
|
velocity7d: number;
|
|
2034
2054
|
/** 30-day velocity */
|
|
2035
2055
|
velocity30d: number;
|
|
2036
|
-
/** 90-day velocity
|
|
2037
|
-
velocity90d
|
|
2056
|
+
/** 90-day velocity */
|
|
2057
|
+
velocity90d: number;
|
|
2038
2058
|
/** Projected coverage in 30 days (based on velocity) */
|
|
2039
2059
|
projected30d: number;
|
|
2040
2060
|
/** Best coverage ever recorded */
|
|
@@ -2103,25 +2123,16 @@ declare function formatDelta(delta: number): string;
|
|
|
2103
2123
|
*/
|
|
2104
2124
|
declare function pruneHistory(cwd: string, keepCount?: number): number;
|
|
2105
2125
|
/**
|
|
2106
|
-
* Prune snapshots based on tier retention policy.
|
|
2107
|
-
*
|
|
2108
|
-
* @param cwd - Working directory
|
|
2109
|
-
* @param tier - Retention tier (free: 7d, team: 30d, pro: 90d)
|
|
2110
|
-
* @returns Number of snapshots deleted
|
|
2111
|
-
*/
|
|
2112
|
-
declare function pruneByTier(cwd: string, tier: RetentionTier): number;
|
|
2113
|
-
/**
|
|
2114
2126
|
* Get extended trend analysis with velocity and projections.
|
|
2115
2127
|
*
|
|
2116
2128
|
* @param spec - Current OpenPkg spec
|
|
2117
2129
|
* @param cwd - Working directory
|
|
2118
|
-
* @param options -
|
|
2130
|
+
* @param options - Optional git metadata
|
|
2119
2131
|
* @returns Extended trend analysis
|
|
2120
2132
|
*/
|
|
2121
2133
|
declare function getExtendedTrend(spec: OpenPkg6, cwd: string, options?: {
|
|
2122
2134
|
commit?: string;
|
|
2123
2135
|
branch?: string;
|
|
2124
|
-
tier?: RetentionTier;
|
|
2125
2136
|
}): ExtendedTrendAnalysis;
|
|
2126
2137
|
interface SchemaDetectionContext {
|
|
2127
2138
|
baseDir: string;
|
|
@@ -2565,7 +2576,7 @@ interface SpecSummary {
|
|
|
2565
2576
|
* ```
|
|
2566
2577
|
*/
|
|
2567
2578
|
declare function extractSpecSummary(openpkg: OpenPkg8, doccov: DocCovSpec4): SpecSummary;
|
|
2568
|
-
import { OpenPkg as
|
|
2579
|
+
import { OpenPkg as OpenPkg_yvexjmhfbt } from "@openpkg-ts/spec";
|
|
2569
2580
|
/**
|
|
2570
2581
|
* Build Plan types for AI-powered repository scanning.
|
|
2571
2582
|
*/
|
|
@@ -2662,7 +2673,7 @@ interface BuildPlanExecutionResult {
|
|
|
2662
2673
|
/** Whether all required steps succeeded */
|
|
2663
2674
|
success: boolean;
|
|
2664
2675
|
/** Generated OpenPkg spec (if successful) */
|
|
2665
|
-
spec?:
|
|
2676
|
+
spec?: OpenPkg_yvexjmhfbt;
|
|
2666
2677
|
/** Results for each step */
|
|
2667
2678
|
stepResults: BuildPlanStepResult[];
|
|
2668
2679
|
/** Total execution time in milliseconds */
|
|
@@ -2670,4 +2681,4 @@ interface BuildPlanExecutionResult {
|
|
|
2670
2681
|
/** Overall error message if failed */
|
|
2671
2682
|
error?: string;
|
|
2672
2683
|
}
|
|
2673
|
-
export { validateSpecCache, validateExamples, typecheckExamples, typecheckExample, shouldValidate, serializeJSDoc, saveSpecCache, saveSnapshot, saveReport, safeParseJson, runExamplesWithPackage, runExamples, runExample, resolveTarget, resolveCompiledPath, renderSparkline, renderApiSurface, readPackageJson, pruneHistory,
|
|
2684
|
+
export { validateSpecCache, validateExamples, typecheckExamples, typecheckExample, shouldValidate, serializeJSDoc, saveSpecCache, saveSnapshot, saveReport, safeParseJson, runExamplesWithPackage, runExamples, runExample, resolveTarget, resolveCompiledPath, renderSparkline, renderApiSurface, readPackageJson, pruneHistory, previewForgottenExportFixes, parseGitHubUrl2 as parseScanGitHubUrl, parseMarkdownFiles, parseMarkdownFile, parseListFlag, parseJSDocToPatch, parseGitHubUrl, parseExamplesFlag, parseAssertions, normalizeConfig, mergeFixes, mergeFilters, loadSpecCache, loadSnapshots, loadCachedReport, listWorkspacePackages, isStandardJSONSchema, isSchemaType, isFixableDrift, isExportFullyDocumented, isExecutableLang, installDependencies, hashString, hashFiles, hashFile, hasNonAssertionComments, hasDocsImpact, hasDocsForExport, groupFixesByFile, groupDriftsByCategory, getUndocumentedExports, getTrend, getSupportedLibraries, getSpecCachePath, getRunCommand, getReportPath, getRegisteredAdapters, getPrimaryBuildScript, getInstallCommand, getExtendedTrend, getExportScore, getExportMissing, getExportDrift, getExportAnalysis, getDriftSummary, getDocumentedExports, getDocsImpactSummary, getDiffReportPath, generateReportFromDocCov, generateReport, generateForgottenExportFixes, generateFixesForExport, generateFix, formatPackageList, formatDriftSummaryLine, formatDelta, findRemovedReferences, findPackageByName, findJSDocLocation, findExportReferences, findDeprecatedReferences, findAdapter, fetchSpecFromGitHub, fetchSpec, fetchGitHubContext, extractStandardSchemasFromProject, extractStandardSchemas, extractSpecSummary, extractSchemaType, extractSchemaOutputType, extractPackageSpec, extractImports, extractFunctionCalls, ensureSpecCoverage, docCovConfigSchema, diffSpecWithDocs, diffHashes, detectRuntimeSchemas, detectPackageManager, detectMonorepo, detectExampleRuntimeErrors, detectExampleAssertionFailures, detectEntryPoint, detectBuildInfo, defineConfig, createSourceFile, createNodeCommandRunner, computeSnapshot, computeHealth, computeExportDrift, computeDrift, clearSpecCache, categorizeDrifts, categorizeDrift, calculateAggregateCoverage, buildRawUrl, buildExportRegistry, buildDocCovSpec, buildDisplayUrl, buildCloneUrl, blockReferencesExport, applyPatchToJSDoc, applyForgottenExportFixes, applyEdits, analyzeProject2 as analyzeProject, analyzeFile, analyzeDocsImpact, analyze, WorkspacePackage, WorkspaceConfig, VALIDATION_INFO, TypecheckValidationResult, TypecheckResult, TypecheckOptions, SummaryDriftIssue, StandardSchemaExtractionResult, StandardSchemaExtractionOutput, StandardJSONSchemaV1, SpecSummary, SpecDocDrift, SpecDiffWithDocs, SpecCacheConfig, SpecCache, SchemaExtractionResult, SchemaExtractionMode, SchemaDetectionResult, SchemaDetectionContext, SchemaAdapter, SandboxFileSystem, SPEC_CACHE_FILE, RuntimeDrift, RunValidationResult, RunExamplesWithPackageResult, RunExamplesWithPackageOptions, RunExampleOptions, ResolvedTarget, ResolvedFilters, ResolveTargetOptions, ReleaseTag, REPORT_VERSION, REPORT_EXTENSIONS, ProjectInfo, PresenceResult, ParsedGitHubUrl, PackageManagerInfo, PackageManager, PackageJson, PackageExports, OpenPkgSpec, NodeFileSystem, MonorepoType, MonorepoInfo, MemberChange, MarkdownDocFile, MarkdownCodeBlock, LLMAssertion, JSDocTag, JSDocReturn, JSDocPatch, JSDocParam, JSDocEdit, InstallResult, InstallOptions, HealthInput, HISTORY_DIR, GitHubRepoMetadata, GitHubProjectContext, GenerateForgottenExportFixesOptions, ForgottenExportResult, ForgottenExportFix, FixType, FixSuggestion, FilterSource, FilterOptions, FileSystem, FetchGitHubContextOptions, ExtractStandardSchemasOptions, ExtendedTrendAnalysis, ExportReference, ExportDriftResult, ExportCoverageData, ExampleValidationTypeError, ExampleValidationResult, ExampleValidationOptions, ExampleValidationMode, ExampleValidation, ExampleTypeError, ExampleRunResult, EntryPointSource, EntryPointInfo, DriftType, DriftSummary, DriftResult, DriftReportSummary, DriftReport, DriftCategory, DocsImpactResult, DocsImpactReference, DocsImpact, DocsConfig, DocsChangeType, DocCovReport, DocCovOptions, DocCovConfigInput, DocCovConfig, DocCov, DiffWithDocsOptions, Diagnostic, DetectedSchemaEntry, DetectedPackageManager, DRIFT_CATEGORY_LABELS, DRIFT_CATEGORY_DESCRIPTIONS, DRIFT_CATEGORIES, DEFAULT_REPORT_PATH, DEFAULT_REPORT_DIR, CoverageTrend, CoverageSummary, CoverageSnapshot, CommandRunner, CommandResult, CheckConfig, CategorizedDrift, CacheValidationResult, CacheContext, CACHE_VERSION, BuildPlanTarget, BuildPlanStepResult, BuildPlanStep, BuildPlanExecutionResult, BuildPlanEnvironment, BuildPlan, BuildInfo, BuildHints, BuildDocCovOptions, ApplyForgottenExportResult, ApplyEditsResult, AnalyzeProjectOptions, AnalyzeOptions, AnalysisResult, ALL_VALIDATIONS };
|