@theglitchking/hit-em-with-the-docs 2.0.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/.claude-plugin/marketplace.json +46 -0
- package/.claude-plugin/plugin.json +114 -0
- package/LICENSE +21 -0
- package/MIGRATION.md +255 -0
- package/README.backup.md +714 -0
- package/README.md +869 -0
- package/action.yml +56 -0
- package/dist/action/action/index.d.ts +2 -0
- package/dist/action/action/index.d.ts.map +1 -0
- package/dist/action/cli/index.d.ts +3 -0
- package/dist/action/cli/index.d.ts.map +1 -0
- package/dist/action/core/audit/auditor.d.ts +43 -0
- package/dist/action/core/audit/auditor.d.ts.map +1 -0
- package/dist/action/core/audit/rules.d.ts +37 -0
- package/dist/action/core/audit/rules.d.ts.map +1 -0
- package/dist/action/core/discover/antipatterns.d.ts +24 -0
- package/dist/action/core/discover/antipatterns.d.ts.map +1 -0
- package/dist/action/core/discover/dependencies.d.ts +57 -0
- package/dist/action/core/discover/dependencies.d.ts.map +1 -0
- package/dist/action/core/discover/patterns.d.ts +38 -0
- package/dist/action/core/discover/patterns.d.ts.map +1 -0
- package/dist/action/core/discover/standards.d.ts +58 -0
- package/dist/action/core/discover/standards.d.ts.map +1 -0
- package/dist/action/core/domains/classifier.d.ts +41 -0
- package/dist/action/core/domains/classifier.d.ts.map +1 -0
- package/dist/action/core/domains/constants.d.ts +40 -0
- package/dist/action/core/domains/constants.d.ts.map +1 -0
- package/dist/action/core/domains/detector.d.ts +35 -0
- package/dist/action/core/domains/detector.d.ts.map +1 -0
- package/dist/action/core/integrate/integrator.d.ts +35 -0
- package/dist/action/core/integrate/integrator.d.ts.map +1 -0
- package/dist/action/core/links/checker.d.ts +64 -0
- package/dist/action/core/links/checker.d.ts.map +1 -0
- package/dist/action/core/links/tracker.d.ts +69 -0
- package/dist/action/core/links/tracker.d.ts.map +1 -0
- package/dist/action/core/maintain/orchestrator.d.ts +39 -0
- package/dist/action/core/maintain/orchestrator.d.ts.map +1 -0
- package/dist/action/core/metadata/generator.d.ts +26 -0
- package/dist/action/core/metadata/generator.d.ts.map +1 -0
- package/dist/action/core/metadata/schema.d.ts +201 -0
- package/dist/action/core/metadata/schema.d.ts.map +1 -0
- package/dist/action/core/metadata/sync.d.ts +36 -0
- package/dist/action/core/metadata/sync.d.ts.map +1 -0
- package/dist/action/generators/index-generator.d.ts +19 -0
- package/dist/action/generators/index-generator.d.ts.map +1 -0
- package/dist/action/generators/registry-generator.d.ts +11 -0
- package/dist/action/generators/registry-generator.d.ts.map +1 -0
- package/dist/action/generators/scaffold.d.ts +30 -0
- package/dist/action/generators/scaffold.d.ts.map +1 -0
- package/dist/action/generators/templates/document.d.ts +14 -0
- package/dist/action/generators/templates/document.d.ts.map +1 -0
- package/dist/action/generators/templates/domain-index.d.ts +6 -0
- package/dist/action/generators/templates/domain-index.d.ts.map +1 -0
- package/dist/action/generators/templates/domain-registry.d.ts +6 -0
- package/dist/action/generators/templates/domain-registry.d.ts.map +1 -0
- package/dist/action/index.d.ts +31 -0
- package/dist/action/index.d.ts.map +1 -0
- package/dist/action/index.js +17 -0
- package/dist/action/index.js.map +1 -0
- package/dist/action/package.json +3 -0
- package/dist/action/reports/audit-report.d.ts +15 -0
- package/dist/action/reports/audit-report.d.ts.map +1 -0
- package/dist/action/reports/health-report.d.ts +15 -0
- package/dist/action/reports/health-report.d.ts.map +1 -0
- package/dist/action/reports/link-report.d.ts +15 -0
- package/dist/action/reports/link-report.d.ts.map +1 -0
- package/dist/action/utils/frontmatter.d.ts +50 -0
- package/dist/action/utils/frontmatter.d.ts.map +1 -0
- package/dist/action/utils/glob.d.ts +63 -0
- package/dist/action/utils/glob.d.ts.map +1 -0
- package/dist/action/utils/logger.d.ts +42 -0
- package/dist/action/utils/logger.d.ts.map +1 -0
- package/dist/action/utils/markdown.d.ts +89 -0
- package/dist/action/utils/markdown.d.ts.map +1 -0
- package/dist/cli/index.d.ts +3 -0
- package/dist/cli/index.d.ts.map +1 -0
- package/dist/cli/index.js +287 -0
- package/dist/cli/index.js.map +1 -0
- package/dist/core/audit/auditor.d.ts +43 -0
- package/dist/core/audit/auditor.d.ts.map +1 -0
- package/dist/core/audit/auditor.js +273 -0
- package/dist/core/audit/auditor.js.map +1 -0
- package/dist/core/audit/rules.d.ts +37 -0
- package/dist/core/audit/rules.d.ts.map +1 -0
- package/dist/core/audit/rules.js +223 -0
- package/dist/core/audit/rules.js.map +1 -0
- package/dist/core/discover/antipatterns.d.ts +24 -0
- package/dist/core/discover/antipatterns.d.ts.map +1 -0
- package/dist/core/discover/antipatterns.js +354 -0
- package/dist/core/discover/antipatterns.js.map +1 -0
- package/dist/core/discover/dependencies.d.ts +57 -0
- package/dist/core/discover/dependencies.d.ts.map +1 -0
- package/dist/core/discover/dependencies.js +311 -0
- package/dist/core/discover/dependencies.js.map +1 -0
- package/dist/core/discover/patterns.d.ts +38 -0
- package/dist/core/discover/patterns.d.ts.map +1 -0
- package/dist/core/discover/patterns.js +371 -0
- package/dist/core/discover/patterns.js.map +1 -0
- package/dist/core/discover/standards.d.ts +58 -0
- package/dist/core/discover/standards.d.ts.map +1 -0
- package/dist/core/discover/standards.js +359 -0
- package/dist/core/discover/standards.js.map +1 -0
- package/dist/core/domains/classifier.d.ts +41 -0
- package/dist/core/domains/classifier.d.ts.map +1 -0
- package/dist/core/domains/classifier.js +208 -0
- package/dist/core/domains/classifier.js.map +1 -0
- package/dist/core/domains/constants.d.ts +40 -0
- package/dist/core/domains/constants.d.ts.map +1 -0
- package/dist/core/domains/constants.js +252 -0
- package/dist/core/domains/constants.js.map +1 -0
- package/dist/core/domains/detector.d.ts +35 -0
- package/dist/core/domains/detector.d.ts.map +1 -0
- package/dist/core/domains/detector.js +176 -0
- package/dist/core/domains/detector.js.map +1 -0
- package/dist/core/integrate/integrator.d.ts +35 -0
- package/dist/core/integrate/integrator.d.ts.map +1 -0
- package/dist/core/integrate/integrator.js +216 -0
- package/dist/core/integrate/integrator.js.map +1 -0
- package/dist/core/links/checker.d.ts +64 -0
- package/dist/core/links/checker.d.ts.map +1 -0
- package/dist/core/links/checker.js +190 -0
- package/dist/core/links/checker.js.map +1 -0
- package/dist/core/links/tracker.d.ts +69 -0
- package/dist/core/links/tracker.d.ts.map +1 -0
- package/dist/core/links/tracker.js +184 -0
- package/dist/core/links/tracker.js.map +1 -0
- package/dist/core/maintain/orchestrator.d.ts +39 -0
- package/dist/core/maintain/orchestrator.d.ts.map +1 -0
- package/dist/core/maintain/orchestrator.js +372 -0
- package/dist/core/maintain/orchestrator.js.map +1 -0
- package/dist/core/metadata/generator.d.ts +26 -0
- package/dist/core/metadata/generator.d.ts.map +1 -0
- package/dist/core/metadata/generator.js +221 -0
- package/dist/core/metadata/generator.js.map +1 -0
- package/dist/core/metadata/schema.d.ts +201 -0
- package/dist/core/metadata/schema.d.ts.map +1 -0
- package/dist/core/metadata/schema.js +184 -0
- package/dist/core/metadata/schema.js.map +1 -0
- package/dist/core/metadata/sync.d.ts +36 -0
- package/dist/core/metadata/sync.d.ts.map +1 -0
- package/dist/core/metadata/sync.js +195 -0
- package/dist/core/metadata/sync.js.map +1 -0
- package/dist/generators/index-generator.d.ts +19 -0
- package/dist/generators/index-generator.d.ts.map +1 -0
- package/dist/generators/index-generator.js +191 -0
- package/dist/generators/index-generator.js.map +1 -0
- package/dist/generators/registry-generator.d.ts +11 -0
- package/dist/generators/registry-generator.d.ts.map +1 -0
- package/dist/generators/registry-generator.js +156 -0
- package/dist/generators/registry-generator.js.map +1 -0
- package/dist/generators/scaffold.d.ts +30 -0
- package/dist/generators/scaffold.d.ts.map +1 -0
- package/dist/generators/scaffold.js +213 -0
- package/dist/generators/scaffold.js.map +1 -0
- package/dist/generators/templates/document.d.ts +14 -0
- package/dist/generators/templates/document.d.ts.map +1 -0
- package/dist/generators/templates/document.js +305 -0
- package/dist/generators/templates/document.js.map +1 -0
- package/dist/generators/templates/domain-index.d.ts +6 -0
- package/dist/generators/templates/domain-index.d.ts.map +1 -0
- package/dist/generators/templates/domain-index.js +68 -0
- package/dist/generators/templates/domain-index.js.map +1 -0
- package/dist/generators/templates/domain-registry.d.ts +6 -0
- package/dist/generators/templates/domain-registry.d.ts.map +1 -0
- package/dist/generators/templates/domain-registry.js +59 -0
- package/dist/generators/templates/domain-registry.js.map +1 -0
- package/dist/index.d.ts +32 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +39 -0
- package/dist/index.js.map +1 -0
- package/dist/reports/audit-report.d.ts +15 -0
- package/dist/reports/audit-report.d.ts.map +1 -0
- package/dist/reports/audit-report.js +150 -0
- package/dist/reports/audit-report.js.map +1 -0
- package/dist/reports/health-report.d.ts +15 -0
- package/dist/reports/health-report.d.ts.map +1 -0
- package/dist/reports/health-report.js +175 -0
- package/dist/reports/health-report.js.map +1 -0
- package/dist/reports/link-report.d.ts +15 -0
- package/dist/reports/link-report.d.ts.map +1 -0
- package/dist/reports/link-report.js +165 -0
- package/dist/reports/link-report.js.map +1 -0
- package/dist/utils/frontmatter.d.ts +50 -0
- package/dist/utils/frontmatter.d.ts.map +1 -0
- package/dist/utils/frontmatter.js +93 -0
- package/dist/utils/frontmatter.js.map +1 -0
- package/dist/utils/glob.d.ts +63 -0
- package/dist/utils/glob.d.ts.map +1 -0
- package/dist/utils/glob.js +128 -0
- package/dist/utils/glob.js.map +1 -0
- package/dist/utils/logger.d.ts +42 -0
- package/dist/utils/logger.d.ts.map +1 -0
- package/dist/utils/logger.js +118 -0
- package/dist/utils/logger.js.map +1 -0
- package/dist/utils/markdown.d.ts +89 -0
- package/dist/utils/markdown.d.ts.map +1 -0
- package/dist/utils/markdown.js +192 -0
- package/dist/utils/markdown.js.map +1 -0
- package/package.json +100 -0
- package/templates/claude/CLAUDE.md +204 -0
|
@@ -0,0 +1,69 @@
|
|
|
1
|
+
import type { Domain } from '../domains/constants.js';
|
|
2
|
+
export interface LinkGraph {
|
|
3
|
+
nodes: LinkNode[];
|
|
4
|
+
edges: LinkEdge[];
|
|
5
|
+
}
|
|
6
|
+
export interface LinkNode {
|
|
7
|
+
id: string;
|
|
8
|
+
path: string;
|
|
9
|
+
domain: Domain | null;
|
|
10
|
+
title?: string;
|
|
11
|
+
inDegree: number;
|
|
12
|
+
outDegree: number;
|
|
13
|
+
}
|
|
14
|
+
export interface LinkEdge {
|
|
15
|
+
source: string;
|
|
16
|
+
target: string;
|
|
17
|
+
linkText: string;
|
|
18
|
+
lineNumber: number;
|
|
19
|
+
}
|
|
20
|
+
export interface DomainConnectionMatrix {
|
|
21
|
+
domains: Domain[];
|
|
22
|
+
matrix: number[][];
|
|
23
|
+
totalConnections: number;
|
|
24
|
+
}
|
|
25
|
+
/**
|
|
26
|
+
* Build a complete link graph for the documentation
|
|
27
|
+
*/
|
|
28
|
+
export declare function buildLinkGraph(docsPath: string): Promise<LinkGraph>;
|
|
29
|
+
/**
|
|
30
|
+
* Build a domain connection matrix showing how domains link to each other
|
|
31
|
+
*/
|
|
32
|
+
export declare function buildDomainConnectionMatrix(docsPath: string): Promise<DomainConnectionMatrix>;
|
|
33
|
+
/**
|
|
34
|
+
* Get top connected domain pairs
|
|
35
|
+
*/
|
|
36
|
+
export declare function getTopConnectedDomains(docsPath: string, limit?: number): Promise<{
|
|
37
|
+
from: Domain;
|
|
38
|
+
to: Domain;
|
|
39
|
+
count: number;
|
|
40
|
+
}[]>;
|
|
41
|
+
/**
|
|
42
|
+
* Get backlinks for a specific file
|
|
43
|
+
*/
|
|
44
|
+
export declare function getBacklinks(targetFile: string, docsPath: string): Promise<{
|
|
45
|
+
source: string;
|
|
46
|
+
linkText: string;
|
|
47
|
+
lineNumber: number;
|
|
48
|
+
}[]>;
|
|
49
|
+
/**
|
|
50
|
+
* Find orphan files (files with no incoming links)
|
|
51
|
+
*/
|
|
52
|
+
export declare function findOrphanFiles(docsPath: string): Promise<string[]>;
|
|
53
|
+
/**
|
|
54
|
+
* Find highly connected files (hubs)
|
|
55
|
+
*/
|
|
56
|
+
export declare function findHubFiles(docsPath: string, minDegree?: number): Promise<LinkNode[]>;
|
|
57
|
+
/**
|
|
58
|
+
* Get link statistics summary
|
|
59
|
+
*/
|
|
60
|
+
export declare function getLinkStatistics(docsPath: string): Promise<{
|
|
61
|
+
totalNodes: number;
|
|
62
|
+
totalEdges: number;
|
|
63
|
+
avgInDegree: number;
|
|
64
|
+
avgOutDegree: number;
|
|
65
|
+
orphanCount: number;
|
|
66
|
+
hubCount: number;
|
|
67
|
+
crossDomainPercentage: number;
|
|
68
|
+
}>;
|
|
69
|
+
//# sourceMappingURL=tracker.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"tracker.d.ts","sourceRoot":"","sources":["file:///mnt/e/docker-containers/hit-em-with-the-docs/src/core/links/tracker.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,yBAAyB,CAAC;AAGtD,MAAM,WAAW,SAAS;IACxB,KAAK,EAAE,QAAQ,EAAE,CAAC;IAClB,KAAK,EAAE,QAAQ,EAAE,CAAC;CACnB;AAED,MAAM,WAAW,QAAQ;IACvB,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IACtB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,MAAM,CAAC;IACjB,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,QAAQ;IACvB,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,MAAM,CAAC;IACjB,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,sBAAsB;IACrC,OAAO,EAAE,MAAM,EAAE,CAAC;IAClB,MAAM,EAAE,MAAM,EAAE,EAAE,CAAC;IACnB,gBAAgB,EAAE,MAAM,CAAC;CAC1B;AAED;;GAEG;AACH,wBAAsB,cAAc,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,SAAS,CAAC,CAiEzE;AAED;;GAEG;AACH,wBAAsB,2BAA2B,CAC/C,QAAQ,EAAE,MAAM,GACf,OAAO,CAAC,sBAAsB,CAAC,CA+BjC;AAED;;GAEG;AACH,wBAAsB,sBAAsB,CAC1C,QAAQ,EAAE,MAAM,EAChB,KAAK,GAAE,MAAW,GACjB,OAAO,CAAC;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,EAAE,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,MAAM,CAAA;CAAE,EAAE,CAAC,CAoBxD;AAED;;GAEG;AACH,wBAAsB,YAAY,CAChC,UAAU,EAAE,MAAM,EAClB,QAAQ,EAAE,MAAM,GACf,OAAO,CAAC;IAAE,MAAM,EAAE,MAAM,CAAC;IAAC,QAAQ,EAAE,MAAM,CAAC;IAAC,UAAU,EAAE,MAAM,CAAA;CAAE,EAAE,CAAC,CAWrE;AAED;;GAEG;AACH,wBAAsB,eAAe,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC,CAWzE;AAED;;GAEG;AACH,wBAAsB,YAAY,CAChC,QAAQ,EAAE,MAAM,EAChB,SAAS,GAAE,MAAU,GACpB,OAAO,CAAC,QAAQ,EAAE,CAAC,CAMrB;AAED;;GAEG;AACH,wBAAsB,iBAAiB,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC;IACjE,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,MAAM,CAAC;IACnB,WAAW,EAAE,MAAM,CAAC;IACpB,YAAY,EAAE,MAAM,CAAC;IACrB,WAAW,EAAE,MAAM,CAAC;IACpB,QAAQ,EAAE,MAAM,CAAC;IACjB,qBAAqB,EAAE,MAAM,CAAC;CAC/B,CAAC,CA8BD"}
|
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
import { type SyncResult } from '../metadata/sync.js';
|
|
2
|
+
import { type LinkCheckResult } from '../links/checker.js';
|
|
3
|
+
import { type AuditResult } from '../audit/auditor.js';
|
|
4
|
+
export interface MaintainOptions {
|
|
5
|
+
docsPath: string;
|
|
6
|
+
quick?: boolean;
|
|
7
|
+
fix?: boolean;
|
|
8
|
+
silent?: boolean;
|
|
9
|
+
}
|
|
10
|
+
export interface MaintainResult {
|
|
11
|
+
success: boolean;
|
|
12
|
+
domainHealth: DomainHealthResult;
|
|
13
|
+
metadataSync?: SyncResult;
|
|
14
|
+
linkCheck?: LinkCheckResult;
|
|
15
|
+
audit?: AuditResult;
|
|
16
|
+
healthScore: number;
|
|
17
|
+
reportPath?: string;
|
|
18
|
+
errors: string[];
|
|
19
|
+
}
|
|
20
|
+
export interface DomainHealthResult {
|
|
21
|
+
healthy: boolean;
|
|
22
|
+
presentDomains: string[];
|
|
23
|
+
missingDomains: string[];
|
|
24
|
+
missingIndexes: string[];
|
|
25
|
+
missingRegistries: string[];
|
|
26
|
+
}
|
|
27
|
+
/**
|
|
28
|
+
* Run full maintenance on documentation
|
|
29
|
+
*/
|
|
30
|
+
export declare function runMaintenance(options: MaintainOptions): Promise<MaintainResult>;
|
|
31
|
+
/**
|
|
32
|
+
* Quick health check without full maintenance
|
|
33
|
+
*/
|
|
34
|
+
export declare function quickHealthCheck(docsPath: string): Promise<{
|
|
35
|
+
healthy: boolean;
|
|
36
|
+
score: number;
|
|
37
|
+
issues: string[];
|
|
38
|
+
}>;
|
|
39
|
+
//# sourceMappingURL=orchestrator.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"orchestrator.d.ts","sourceRoot":"","sources":["file:///mnt/e/docker-containers/hit-em-with-the-docs/src/core/maintain/orchestrator.ts"],"names":[],"mappings":"AAIA,OAAO,EAAgB,KAAK,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACpE,OAAO,EAAc,KAAK,eAAe,EAAE,MAAM,qBAAqB,CAAC;AACvE,OAAO,EAAsB,KAAK,WAAW,EAAE,MAAM,qBAAqB,CAAC;AAI3E,MAAM,WAAW,eAAe;IAC9B,QAAQ,EAAE,MAAM,CAAC;IACjB,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,GAAG,CAAC,EAAE,OAAO,CAAC;IACd,MAAM,CAAC,EAAE,OAAO,CAAC;CAClB;AAED,MAAM,WAAW,cAAc;IAC7B,OAAO,EAAE,OAAO,CAAC;IACjB,YAAY,EAAE,kBAAkB,CAAC;IACjC,YAAY,CAAC,EAAE,UAAU,CAAC;IAC1B,SAAS,CAAC,EAAE,eAAe,CAAC;IAC5B,KAAK,CAAC,EAAE,WAAW,CAAC;IACpB,WAAW,EAAE,MAAM,CAAC;IACpB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,MAAM,EAAE,MAAM,EAAE,CAAC;CAClB;AAED,MAAM,WAAW,kBAAkB;IACjC,OAAO,EAAE,OAAO,CAAC;IACjB,cAAc,EAAE,MAAM,EAAE,CAAC;IACzB,cAAc,EAAE,MAAM,EAAE,CAAC;IACzB,cAAc,EAAE,MAAM,EAAE,CAAC;IACzB,iBAAiB,EAAE,MAAM,EAAE,CAAC;CAC7B;AAED;;GAEG;AACH,wBAAsB,cAAc,CAAC,OAAO,EAAE,eAAe,GAAG,OAAO,CAAC,cAAc,CAAC,CA0JtF;AA4OD;;GAEG;AACH,wBAAsB,gBAAgB,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC;IAChE,OAAO,EAAE,OAAO,CAAC;IACjB,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,EAAE,CAAC;CAClB,CAAC,CAoBD"}
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
import type { DocumentMetadata, PartialDocumentMetadata } from './schema.js';
|
|
2
|
+
export interface GeneratorOptions {
|
|
3
|
+
filePath: string;
|
|
4
|
+
content: string;
|
|
5
|
+
docsRoot?: string;
|
|
6
|
+
existingMetadata?: PartialDocumentMetadata;
|
|
7
|
+
}
|
|
8
|
+
export interface GeneratedMetadata extends Partial<DocumentMetadata> {
|
|
9
|
+
_generated: {
|
|
10
|
+
fields: string[];
|
|
11
|
+
confidence: Record<string, number>;
|
|
12
|
+
};
|
|
13
|
+
}
|
|
14
|
+
/**
|
|
15
|
+
* Generate metadata for a document
|
|
16
|
+
*/
|
|
17
|
+
export declare function generateMetadata(options: GeneratorOptions): GeneratedMetadata;
|
|
18
|
+
/**
|
|
19
|
+
* Merge generated metadata with existing metadata
|
|
20
|
+
*/
|
|
21
|
+
export declare function mergeMetadata(existing: PartialDocumentMetadata, generated: GeneratedMetadata): DocumentMetadata;
|
|
22
|
+
/**
|
|
23
|
+
* Format a date as YYYY-MM-DD
|
|
24
|
+
*/
|
|
25
|
+
export declare function formatDate(date: Date): string;
|
|
26
|
+
//# sourceMappingURL=generator.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"generator.d.ts","sourceRoot":"","sources":["file:///mnt/e/docker-containers/hit-em-with-the-docs/src/core/metadata/generator.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,gBAAgB,EAAE,uBAAuB,EAAE,MAAM,aAAa,CAAC;AAE7E,MAAM,WAAW,gBAAgB;IAC/B,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,gBAAgB,CAAC,EAAE,uBAAuB,CAAC;CAC5C;AAED,MAAM,WAAW,iBAAkB,SAAQ,OAAO,CAAC,gBAAgB,CAAC;IAClE,UAAU,EAAE;QACV,MAAM,EAAE,MAAM,EAAE,CAAC;QACjB,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;KACpC,CAAC;CACH;AAED;;GAEG;AACH,wBAAgB,gBAAgB,CAAC,OAAO,EAAE,gBAAgB,GAAG,iBAAiB,CAgH7E;AAED;;GAEG;AACH,wBAAgB,aAAa,CAC3B,QAAQ,EAAE,uBAAuB,EACjC,SAAS,EAAE,iBAAiB,GAC3B,gBAAgB,CAqClB;AAED;;GAEG;AACH,wBAAgB,UAAU,CAAC,IAAI,EAAE,IAAI,GAAG,MAAM,CAE7C"}
|
|
@@ -0,0 +1,201 @@
|
|
|
1
|
+
import { z } from 'zod';
|
|
2
|
+
/**
|
|
3
|
+
* Complete 22-field metadata schema
|
|
4
|
+
*/
|
|
5
|
+
export declare const MetadataSchema: z.ZodObject<{
|
|
6
|
+
title: z.ZodString;
|
|
7
|
+
tier: z.ZodEnum<["guide" | "standard" | "example" | "reference" | "admin", ...("guide" | "standard" | "example" | "reference" | "admin")[]]>;
|
|
8
|
+
domains: z.ZodArray<z.ZodString, "many">;
|
|
9
|
+
audience: z.ZodDefault<z.ZodArray<z.ZodEnum<["all", "developers", "devops", "admin"]>, "many">>;
|
|
10
|
+
tags: z.ZodDefault<z.ZodArray<z.ZodString, "many">>;
|
|
11
|
+
} & {
|
|
12
|
+
status: z.ZodEnum<["draft", "active", "deprecated", "archived"]>;
|
|
13
|
+
last_updated: z.ZodString;
|
|
14
|
+
version: z.ZodString;
|
|
15
|
+
} & {
|
|
16
|
+
purpose: z.ZodOptional<z.ZodString>;
|
|
17
|
+
related_docs: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
|
|
18
|
+
load_priority: z.ZodOptional<z.ZodNumber>;
|
|
19
|
+
} & {
|
|
20
|
+
author: z.ZodOptional<z.ZodString>;
|
|
21
|
+
maintainer: z.ZodOptional<z.ZodString>;
|
|
22
|
+
review_frequency: z.ZodOptional<z.ZodEnum<["weekly", "monthly", "quarterly", "annually"]>>;
|
|
23
|
+
} & {
|
|
24
|
+
implementation_status: z.ZodOptional<z.ZodEnum<["planned", "in_progress", "complete", "deprecated"]>>;
|
|
25
|
+
tested: z.ZodOptional<z.ZodBoolean>;
|
|
26
|
+
production_ready: z.ZodOptional<z.ZodBoolean>;
|
|
27
|
+
} & {
|
|
28
|
+
estimated_read_time: z.ZodOptional<z.ZodString>;
|
|
29
|
+
word_count: z.ZodOptional<z.ZodNumber>;
|
|
30
|
+
last_validated: z.ZodOptional<z.ZodString>;
|
|
31
|
+
backlinks: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
|
|
32
|
+
}, "strip", z.ZodTypeAny, {
|
|
33
|
+
domains: string[];
|
|
34
|
+
version: string;
|
|
35
|
+
title: string;
|
|
36
|
+
tier: "guide" | "standard" | "example" | "reference" | "admin";
|
|
37
|
+
status: "draft" | "active" | "deprecated" | "archived";
|
|
38
|
+
audience: ("devops" | "admin" | "all" | "developers")[];
|
|
39
|
+
tags: string[];
|
|
40
|
+
last_updated: string;
|
|
41
|
+
purpose?: string | undefined;
|
|
42
|
+
related_docs?: string[] | undefined;
|
|
43
|
+
load_priority?: number | undefined;
|
|
44
|
+
author?: string | undefined;
|
|
45
|
+
maintainer?: string | undefined;
|
|
46
|
+
review_frequency?: "weekly" | "monthly" | "quarterly" | "annually" | undefined;
|
|
47
|
+
implementation_status?: "deprecated" | "planned" | "in_progress" | "complete" | undefined;
|
|
48
|
+
tested?: boolean | undefined;
|
|
49
|
+
production_ready?: boolean | undefined;
|
|
50
|
+
estimated_read_time?: string | undefined;
|
|
51
|
+
word_count?: number | undefined;
|
|
52
|
+
last_validated?: string | undefined;
|
|
53
|
+
backlinks?: string[] | undefined;
|
|
54
|
+
}, {
|
|
55
|
+
domains: string[];
|
|
56
|
+
version: string;
|
|
57
|
+
title: string;
|
|
58
|
+
tier: "guide" | "standard" | "example" | "reference" | "admin";
|
|
59
|
+
status: "draft" | "active" | "deprecated" | "archived";
|
|
60
|
+
last_updated: string;
|
|
61
|
+
audience?: ("devops" | "admin" | "all" | "developers")[] | undefined;
|
|
62
|
+
tags?: string[] | undefined;
|
|
63
|
+
purpose?: string | undefined;
|
|
64
|
+
related_docs?: string[] | undefined;
|
|
65
|
+
load_priority?: number | undefined;
|
|
66
|
+
author?: string | undefined;
|
|
67
|
+
maintainer?: string | undefined;
|
|
68
|
+
review_frequency?: "weekly" | "monthly" | "quarterly" | "annually" | undefined;
|
|
69
|
+
implementation_status?: "deprecated" | "planned" | "in_progress" | "complete" | undefined;
|
|
70
|
+
tested?: boolean | undefined;
|
|
71
|
+
production_ready?: boolean | undefined;
|
|
72
|
+
estimated_read_time?: string | undefined;
|
|
73
|
+
word_count?: number | undefined;
|
|
74
|
+
last_validated?: string | undefined;
|
|
75
|
+
backlinks?: string[] | undefined;
|
|
76
|
+
}>;
|
|
77
|
+
export type DocumentMetadata = z.infer<typeof MetadataSchema>;
|
|
78
|
+
/**
|
|
79
|
+
* Partial schema for documents that may have incomplete metadata
|
|
80
|
+
*/
|
|
81
|
+
export declare const PartialMetadataSchema: z.ZodObject<{
|
|
82
|
+
title: z.ZodOptional<z.ZodString>;
|
|
83
|
+
tier: z.ZodOptional<z.ZodEnum<["guide" | "standard" | "example" | "reference" | "admin", ...("guide" | "standard" | "example" | "reference" | "admin")[]]>>;
|
|
84
|
+
domains: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
|
|
85
|
+
audience: z.ZodOptional<z.ZodDefault<z.ZodArray<z.ZodEnum<["all", "developers", "devops", "admin"]>, "many">>>;
|
|
86
|
+
tags: z.ZodOptional<z.ZodDefault<z.ZodArray<z.ZodString, "many">>>;
|
|
87
|
+
status: z.ZodOptional<z.ZodEnum<["draft", "active", "deprecated", "archived"]>>;
|
|
88
|
+
last_updated: z.ZodOptional<z.ZodString>;
|
|
89
|
+
version: z.ZodOptional<z.ZodString>;
|
|
90
|
+
purpose: z.ZodOptional<z.ZodOptional<z.ZodString>>;
|
|
91
|
+
related_docs: z.ZodOptional<z.ZodOptional<z.ZodArray<z.ZodString, "many">>>;
|
|
92
|
+
load_priority: z.ZodOptional<z.ZodOptional<z.ZodNumber>>;
|
|
93
|
+
author: z.ZodOptional<z.ZodOptional<z.ZodString>>;
|
|
94
|
+
maintainer: z.ZodOptional<z.ZodOptional<z.ZodString>>;
|
|
95
|
+
review_frequency: z.ZodOptional<z.ZodOptional<z.ZodEnum<["weekly", "monthly", "quarterly", "annually"]>>>;
|
|
96
|
+
implementation_status: z.ZodOptional<z.ZodOptional<z.ZodEnum<["planned", "in_progress", "complete", "deprecated"]>>>;
|
|
97
|
+
tested: z.ZodOptional<z.ZodOptional<z.ZodBoolean>>;
|
|
98
|
+
production_ready: z.ZodOptional<z.ZodOptional<z.ZodBoolean>>;
|
|
99
|
+
estimated_read_time: z.ZodOptional<z.ZodOptional<z.ZodString>>;
|
|
100
|
+
word_count: z.ZodOptional<z.ZodOptional<z.ZodNumber>>;
|
|
101
|
+
last_validated: z.ZodOptional<z.ZodOptional<z.ZodString>>;
|
|
102
|
+
backlinks: z.ZodOptional<z.ZodOptional<z.ZodArray<z.ZodString, "many">>>;
|
|
103
|
+
}, "strip", z.ZodTypeAny, {
|
|
104
|
+
domains?: string[] | undefined;
|
|
105
|
+
version?: string | undefined;
|
|
106
|
+
title?: string | undefined;
|
|
107
|
+
tier?: "guide" | "standard" | "example" | "reference" | "admin" | undefined;
|
|
108
|
+
status?: "draft" | "active" | "deprecated" | "archived" | undefined;
|
|
109
|
+
audience?: ("devops" | "admin" | "all" | "developers")[] | undefined;
|
|
110
|
+
tags?: string[] | undefined;
|
|
111
|
+
last_updated?: string | undefined;
|
|
112
|
+
purpose?: string | undefined;
|
|
113
|
+
related_docs?: string[] | undefined;
|
|
114
|
+
load_priority?: number | undefined;
|
|
115
|
+
author?: string | undefined;
|
|
116
|
+
maintainer?: string | undefined;
|
|
117
|
+
review_frequency?: "weekly" | "monthly" | "quarterly" | "annually" | undefined;
|
|
118
|
+
implementation_status?: "deprecated" | "planned" | "in_progress" | "complete" | undefined;
|
|
119
|
+
tested?: boolean | undefined;
|
|
120
|
+
production_ready?: boolean | undefined;
|
|
121
|
+
estimated_read_time?: string | undefined;
|
|
122
|
+
word_count?: number | undefined;
|
|
123
|
+
last_validated?: string | undefined;
|
|
124
|
+
backlinks?: string[] | undefined;
|
|
125
|
+
}, {
|
|
126
|
+
domains?: string[] | undefined;
|
|
127
|
+
version?: string | undefined;
|
|
128
|
+
title?: string | undefined;
|
|
129
|
+
tier?: "guide" | "standard" | "example" | "reference" | "admin" | undefined;
|
|
130
|
+
status?: "draft" | "active" | "deprecated" | "archived" | undefined;
|
|
131
|
+
audience?: ("devops" | "admin" | "all" | "developers")[] | undefined;
|
|
132
|
+
tags?: string[] | undefined;
|
|
133
|
+
last_updated?: string | undefined;
|
|
134
|
+
purpose?: string | undefined;
|
|
135
|
+
related_docs?: string[] | undefined;
|
|
136
|
+
load_priority?: number | undefined;
|
|
137
|
+
author?: string | undefined;
|
|
138
|
+
maintainer?: string | undefined;
|
|
139
|
+
review_frequency?: "weekly" | "monthly" | "quarterly" | "annually" | undefined;
|
|
140
|
+
implementation_status?: "deprecated" | "planned" | "in_progress" | "complete" | undefined;
|
|
141
|
+
tested?: boolean | undefined;
|
|
142
|
+
production_ready?: boolean | undefined;
|
|
143
|
+
estimated_read_time?: string | undefined;
|
|
144
|
+
word_count?: number | undefined;
|
|
145
|
+
last_validated?: string | undefined;
|
|
146
|
+
backlinks?: string[] | undefined;
|
|
147
|
+
}>;
|
|
148
|
+
export type PartialDocumentMetadata = z.infer<typeof PartialMetadataSchema>;
|
|
149
|
+
/**
|
|
150
|
+
* Required fields that must always be present
|
|
151
|
+
*/
|
|
152
|
+
export declare const REQUIRED_FIELDS: readonly ["title", "tier", "domains", "status", "last_updated", "version"];
|
|
153
|
+
/**
|
|
154
|
+
* Optional fields with their default values
|
|
155
|
+
*/
|
|
156
|
+
export declare const OPTIONAL_FIELDS_DEFAULTS: Partial<DocumentMetadata>;
|
|
157
|
+
/**
|
|
158
|
+
* Auto-generated fields that should not be manually edited
|
|
159
|
+
*/
|
|
160
|
+
export declare const AUTO_GENERATED_FIELDS: readonly ["estimated_read_time", "word_count", "last_validated", "backlinks"];
|
|
161
|
+
/**
|
|
162
|
+
* All 22 field names
|
|
163
|
+
*/
|
|
164
|
+
export declare const ALL_METADATA_FIELDS: readonly ["title", "tier", "domains", "audience", "tags", "status", "last_updated", "version", "purpose", "related_docs", "load_priority", "author", "maintainer", "review_frequency", "implementation_status", "tested", "production_ready", "estimated_read_time", "word_count", "last_validated", "backlinks"];
|
|
165
|
+
export type MetadataField = (typeof ALL_METADATA_FIELDS)[number];
|
|
166
|
+
/**
|
|
167
|
+
* Validate metadata against the schema
|
|
168
|
+
*/
|
|
169
|
+
export declare function validateMetadata(data: unknown): {
|
|
170
|
+
valid: boolean;
|
|
171
|
+
errors: string[];
|
|
172
|
+
data?: DocumentMetadata;
|
|
173
|
+
};
|
|
174
|
+
/**
|
|
175
|
+
* Validate partial metadata (for documents being fixed)
|
|
176
|
+
*/
|
|
177
|
+
export declare function validatePartialMetadata(data: unknown): {
|
|
178
|
+
valid: boolean;
|
|
179
|
+
errors: string[];
|
|
180
|
+
data?: PartialDocumentMetadata;
|
|
181
|
+
};
|
|
182
|
+
/**
|
|
183
|
+
* Get missing required fields
|
|
184
|
+
*/
|
|
185
|
+
export declare function getMissingRequiredFields(data: Record<string, unknown>): string[];
|
|
186
|
+
/**
|
|
187
|
+
* Get all missing fields (both required and optional)
|
|
188
|
+
*/
|
|
189
|
+
export declare function getMissingFields(data: Record<string, unknown>): {
|
|
190
|
+
required: string[];
|
|
191
|
+
optional: string[];
|
|
192
|
+
};
|
|
193
|
+
/**
|
|
194
|
+
* Calculate metadata completeness percentage
|
|
195
|
+
*/
|
|
196
|
+
export declare function calculateMetadataCompleteness(data: Record<string, unknown>): number;
|
|
197
|
+
/**
|
|
198
|
+
* Get field category
|
|
199
|
+
*/
|
|
200
|
+
export declare function getFieldCategory(field: MetadataField): 'core' | 'status' | 'discovery' | 'ownership' | 'implementation' | 'auto';
|
|
201
|
+
//# sourceMappingURL=schema.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"schema.d.ts","sourceRoot":"","sources":["file:///mnt/e/docker-containers/hit-em-with-the-docs/src/core/metadata/schema.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAqDxB;;GAEG;AACH,eAAO,MAAM,cAAc;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAKE,CAAC;AAE9B,MAAM,MAAM,gBAAgB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,cAAc,CAAC,CAAC;AAE9D;;GAEG;AACH,eAAO,MAAM,qBAAqB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAA2B,CAAC;AAC9D,MAAM,MAAM,uBAAuB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,qBAAqB,CAAC,CAAC;AAE5E;;GAEG;AACH,eAAO,MAAM,eAAe,4EAOlB,CAAC;AAEX;;GAEG;AACH,eAAO,MAAM,wBAAwB,EAAE,OAAO,CAAC,gBAAgB,CAI9D,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,qBAAqB,+EAKxB,CAAC;AAEX;;GAEG;AACH,eAAO,MAAM,mBAAmB,mTA4BtB,CAAC;AAEX,MAAM,MAAM,aAAa,GAAG,CAAC,OAAO,mBAAmB,CAAC,CAAC,MAAM,CAAC,CAAC;AAEjE;;GAEG;AACH,wBAAgB,gBAAgB,CAAC,IAAI,EAAE,OAAO,GAAG;IAC/C,KAAK,EAAE,OAAO,CAAC;IACf,MAAM,EAAE,MAAM,EAAE,CAAC;IACjB,IAAI,CAAC,EAAE,gBAAgB,CAAC;CACzB,CAYA;AAED;;GAEG;AACH,wBAAgB,uBAAuB,CAAC,IAAI,EAAE,OAAO,GAAG;IACtD,KAAK,EAAE,OAAO,CAAC;IACf,MAAM,EAAE,MAAM,EAAE,CAAC;IACjB,IAAI,CAAC,EAAE,uBAAuB,CAAC;CAChC,CAYA;AAED;;GAEG;AACH,wBAAgB,wBAAwB,CACtC,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAC5B,MAAM,EAAE,CAIV;AAED;;GAEG;AACH,wBAAgB,gBAAgB,CAC9B,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAC5B;IAAE,QAAQ,EAAE,MAAM,EAAE,CAAC;IAAC,QAAQ,EAAE,MAAM,EAAE,CAAA;CAAE,CAY5C;AAED;;GAEG;AACH,wBAAgB,6BAA6B,CAC3C,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAC5B,MAAM,CAMR;AAED;;GAEG;AACH,wBAAgB,gBAAgB,CAC9B,KAAK,EAAE,aAAa,GACnB,MAAM,GAAG,QAAQ,GAAG,WAAW,GAAG,WAAW,GAAG,gBAAgB,GAAG,MAAM,CAiB3E"}
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
export interface SyncOptions {
|
|
2
|
+
docsPath: string;
|
|
3
|
+
dryRun?: boolean;
|
|
4
|
+
fix?: boolean;
|
|
5
|
+
domain?: string;
|
|
6
|
+
silent?: boolean;
|
|
7
|
+
}
|
|
8
|
+
export interface SyncResult {
|
|
9
|
+
totalFiles: number;
|
|
10
|
+
validFiles: number;
|
|
11
|
+
fixedFiles: number;
|
|
12
|
+
skippedFiles: number;
|
|
13
|
+
errors: SyncError[];
|
|
14
|
+
stats: SyncStats;
|
|
15
|
+
}
|
|
16
|
+
export interface SyncError {
|
|
17
|
+
file: string;
|
|
18
|
+
error: string;
|
|
19
|
+
fixable: boolean;
|
|
20
|
+
}
|
|
21
|
+
export interface SyncStats {
|
|
22
|
+
totalWordCount: number;
|
|
23
|
+
avgCompleteness: number;
|
|
24
|
+
byDomain: Record<string, number>;
|
|
25
|
+
byStatus: Record<string, number>;
|
|
26
|
+
byTier: Record<string, number>;
|
|
27
|
+
}
|
|
28
|
+
/**
|
|
29
|
+
* Sync metadata across all documentation files
|
|
30
|
+
*/
|
|
31
|
+
export declare function syncMetadata(options: SyncOptions): Promise<SyncResult>;
|
|
32
|
+
/**
|
|
33
|
+
* Get sync statistics for a documentation root
|
|
34
|
+
*/
|
|
35
|
+
export declare function getSyncStats(docsPath: string): Promise<SyncStats>;
|
|
36
|
+
//# sourceMappingURL=sync.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"sync.d.ts","sourceRoot":"","sources":["file:///mnt/e/docker-containers/hit-em-with-the-docs/src/core/metadata/sync.ts"],"names":[],"mappings":"AAcA,MAAM,WAAW,WAAW;IAC1B,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,GAAG,CAAC,EAAE,OAAO,CAAC;IACd,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,OAAO,CAAC;CAClB;AAED,MAAM,WAAW,UAAU;IACzB,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,MAAM,CAAC;IACnB,YAAY,EAAE,MAAM,CAAC;IACrB,MAAM,EAAE,SAAS,EAAE,CAAC;IACpB,KAAK,EAAE,SAAS,CAAC;CAClB;AAED,MAAM,WAAW,SAAS;IACxB,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,OAAO,CAAC;CAClB;AAED,MAAM,WAAW,SAAS;IACxB,cAAc,EAAE,MAAM,CAAC;IACvB,eAAe,EAAE,MAAM,CAAC;IACxB,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACjC,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACjC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CAChC;AAED;;GAEG;AACH,wBAAsB,YAAY,CAAC,OAAO,EAAE,WAAW,GAAG,OAAO,CAAC,UAAU,CAAC,CAyH5E;AAwGD;;GAEG;AACH,wBAAsB,YAAY,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,SAAS,CAAC,CASvE"}
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
import { type Domain } from '../core/domains/constants.js';
|
|
2
|
+
export interface IndexEntry {
|
|
3
|
+
path: string;
|
|
4
|
+
title: string;
|
|
5
|
+
tier: string;
|
|
6
|
+
status: string;
|
|
7
|
+
lastUpdated: string;
|
|
8
|
+
wordCount?: number;
|
|
9
|
+
description?: string;
|
|
10
|
+
}
|
|
11
|
+
/**
|
|
12
|
+
* Generate the root INDEX.md content
|
|
13
|
+
*/
|
|
14
|
+
export declare function generateRootIndex(entries?: Record<Domain, IndexEntry[]>): string;
|
|
15
|
+
/**
|
|
16
|
+
* Generate a domain-specific INDEX.md content
|
|
17
|
+
*/
|
|
18
|
+
export declare function generateDomainIndexContent(domain: Domain, entries?: IndexEntry[]): string;
|
|
19
|
+
//# sourceMappingURL=index-generator.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index-generator.d.ts","sourceRoot":"","sources":["file:///mnt/e/docker-containers/hit-em-with-the-docs/src/generators/index-generator.ts"],"names":[],"mappings":"AAAA,OAAO,EAA+B,KAAK,MAAM,EAAE,MAAM,8BAA8B,CAAC;AAGxF,MAAM,WAAW,UAAU;IACzB,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,WAAW,EAAE,MAAM,CAAC;IACpB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED;;GAEG;AACH,wBAAgB,iBAAiB,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,UAAU,EAAE,CAAC,GAAG,MAAM,CA+DhF;AAED;;GAEG;AACH,wBAAgB,0BAA0B,CACxC,MAAM,EAAE,MAAM,EACd,OAAO,GAAE,UAAU,EAAO,GACzB,MAAM,CA0ER"}
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
import { type Domain } from '../core/domains/constants.js';
|
|
2
|
+
import type { IndexEntry } from './index-generator.js';
|
|
3
|
+
/**
|
|
4
|
+
* Generate the root REGISTRY.md content (quick reference)
|
|
5
|
+
*/
|
|
6
|
+
export declare function generateRootRegistry(): string;
|
|
7
|
+
/**
|
|
8
|
+
* Generate domain-specific REGISTRY.md content
|
|
9
|
+
*/
|
|
10
|
+
export declare function generateDomainRegistryContent(domain: Domain, entries?: IndexEntry[]): string;
|
|
11
|
+
//# sourceMappingURL=registry-generator.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"registry-generator.d.ts","sourceRoot":"","sources":["file:///mnt/e/docker-containers/hit-em-with-the-docs/src/generators/registry-generator.ts"],"names":[],"mappings":"AAAA,OAAO,EAA+B,KAAK,MAAM,EAAE,MAAM,8BAA8B,CAAC;AAExF,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAC;AAEvD;;GAEG;AACH,wBAAgB,oBAAoB,IAAI,MAAM,CA+D7C;AAED;;GAEG;AACH,wBAAgB,6BAA6B,CAC3C,MAAM,EAAE,MAAM,EACd,OAAO,GAAE,UAAU,EAAO,GACzB,MAAM,CA8ER"}
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
import { type Domain } from '../core/domains/constants.js';
|
|
2
|
+
export interface ScaffoldOptions {
|
|
3
|
+
rootPath: string;
|
|
4
|
+
overwrite?: boolean;
|
|
5
|
+
domains?: Domain[];
|
|
6
|
+
silent?: boolean;
|
|
7
|
+
}
|
|
8
|
+
export interface ScaffoldResult {
|
|
9
|
+
success: boolean;
|
|
10
|
+
created: string[];
|
|
11
|
+
skipped: string[];
|
|
12
|
+
errors: string[];
|
|
13
|
+
}
|
|
14
|
+
/**
|
|
15
|
+
* Create the complete documentation scaffold
|
|
16
|
+
*/
|
|
17
|
+
export declare function createScaffold(options: ScaffoldOptions): Promise<ScaffoldResult>;
|
|
18
|
+
/**
|
|
19
|
+
* Check if scaffold already exists
|
|
20
|
+
*/
|
|
21
|
+
export declare function scaffoldExists(rootPath: string): Promise<boolean>;
|
|
22
|
+
/**
|
|
23
|
+
* Get scaffold status
|
|
24
|
+
*/
|
|
25
|
+
export declare function getScaffoldStatus(rootPath: string): Promise<{
|
|
26
|
+
exists: boolean;
|
|
27
|
+
domains: Domain[];
|
|
28
|
+
missingDomains: Domain[];
|
|
29
|
+
}>;
|
|
30
|
+
//# sourceMappingURL=scaffold.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"scaffold.d.ts","sourceRoot":"","sources":["file:///mnt/e/docker-containers/hit-em-with-the-docs/src/generators/scaffold.ts"],"names":[],"mappings":"AAEA,OAAO,EAA+B,KAAK,MAAM,EAAE,MAAM,8BAA8B,CAAC;AAQxF,MAAM,WAAW,eAAe;IAC9B,QAAQ,EAAE,MAAM,CAAC;IACjB,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IACnB,MAAM,CAAC,EAAE,OAAO,CAAC;CAClB;AAED,MAAM,WAAW,cAAc;IAC7B,OAAO,EAAE,OAAO,CAAC;IACjB,OAAO,EAAE,MAAM,EAAE,CAAC;IAClB,OAAO,EAAE,MAAM,EAAE,CAAC;IAClB,MAAM,EAAE,MAAM,EAAE,CAAC;CAClB;AAED;;GAEG;AACH,wBAAsB,cAAc,CAAC,OAAO,EAAE,eAAe,GAAG,OAAO,CAAC,cAAc,CAAC,CAsDtF;AA6KD;;GAEG;AACH,wBAAsB,cAAc,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAGvE;AAED;;GAEG;AACH,wBAAsB,iBAAiB,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC;IACjE,MAAM,EAAE,OAAO,CAAC;IAChB,OAAO,EAAE,MAAM,EAAE,CAAC;IAClB,cAAc,EAAE,MAAM,EAAE,CAAC;CAC1B,CAAC,CA4BD"}
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
import type { Domain } from '../../core/domains/constants.js';
|
|
2
|
+
import type { Tier } from '../../core/domains/classifier.js';
|
|
3
|
+
export interface DocumentTemplateOptions {
|
|
4
|
+
title: string;
|
|
5
|
+
tier?: Tier;
|
|
6
|
+
domain?: Domain;
|
|
7
|
+
author?: string;
|
|
8
|
+
tags?: string[];
|
|
9
|
+
}
|
|
10
|
+
/**
|
|
11
|
+
* Generate a new document template with frontmatter
|
|
12
|
+
*/
|
|
13
|
+
export declare function generateDocumentTemplate(options: DocumentTemplateOptions): string;
|
|
14
|
+
//# sourceMappingURL=document.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"document.d.ts","sourceRoot":"","sources":["file:///mnt/e/docker-containers/hit-em-with-the-docs/src/generators/templates/document.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,iCAAiC,CAAC;AAC9D,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,kCAAkC,CAAC;AAG7D,MAAM,WAAW,uBAAuB;IACtC,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,IAAI,CAAC;IACZ,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;CACjB;AAED;;GAEG;AACH,wBAAgB,wBAAwB,CAAC,OAAO,EAAE,uBAAuB,GAAG,MAAM,CAkCjF"}
|
|
@@ -0,0 +1,6 @@
|
|
|
1
|
+
import type { Domain, DomainDefinition } from '../../core/domains/constants.js';
|
|
2
|
+
/**
|
|
3
|
+
* Generate initial domain INDEX.md content
|
|
4
|
+
*/
|
|
5
|
+
export declare function generateDomainIndex(domain: Domain, def: DomainDefinition): string;
|
|
6
|
+
//# sourceMappingURL=domain-index.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"domain-index.d.ts","sourceRoot":"","sources":["file:///mnt/e/docker-containers/hit-em-with-the-docs/src/generators/templates/domain-index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,gBAAgB,EAAE,MAAM,iCAAiC,CAAC;AAGhF;;GAEG;AACH,wBAAgB,mBAAmB,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,gBAAgB,GAAG,MAAM,CA+DjF"}
|
|
@@ -0,0 +1,6 @@
|
|
|
1
|
+
import type { Domain, DomainDefinition } from '../../core/domains/constants.js';
|
|
2
|
+
/**
|
|
3
|
+
* Generate initial domain REGISTRY.md content
|
|
4
|
+
*/
|
|
5
|
+
export declare function generateDomainRegistry(domain: Domain, def: DomainDefinition): string;
|
|
6
|
+
//# sourceMappingURL=domain-registry.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"domain-registry.d.ts","sourceRoot":"","sources":["file:///mnt/e/docker-containers/hit-em-with-the-docs/src/generators/templates/domain-registry.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,gBAAgB,EAAE,MAAM,iCAAiC,CAAC;AAGhF;;GAEG;AACH,wBAAgB,sBAAsB,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,gBAAgB,GAAG,MAAM,CAsDpF"}
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* hit-em-with-the-docs
|
|
3
|
+
*
|
|
4
|
+
* Self-managing documentation system with hierarchical structure,
|
|
5
|
+
* intelligent automation, pattern discovery, and agent orchestration.
|
|
6
|
+
*/
|
|
7
|
+
export * from './core/domains/constants.js';
|
|
8
|
+
export * from './core/domains/detector.js';
|
|
9
|
+
export * from './core/domains/classifier.js';
|
|
10
|
+
export * from './core/metadata/schema.js';
|
|
11
|
+
export * from './core/metadata/generator.js';
|
|
12
|
+
export * from './utils/logger.js';
|
|
13
|
+
export * from './utils/glob.js';
|
|
14
|
+
export * from './utils/frontmatter.js';
|
|
15
|
+
export * from './utils/markdown.js';
|
|
16
|
+
export * from './generators/scaffold.js';
|
|
17
|
+
export * from './generators/index-generator.js';
|
|
18
|
+
export * from './generators/registry-generator.js';
|
|
19
|
+
export * from './core/metadata/sync.js';
|
|
20
|
+
export * from './core/links/checker.js';
|
|
21
|
+
export * from './core/links/tracker.js';
|
|
22
|
+
export * from './core/audit/auditor.js';
|
|
23
|
+
export * from './core/integrate/integrator.js';
|
|
24
|
+
export * from './core/maintain/orchestrator.js';
|
|
25
|
+
export * from './core/discover/patterns.js';
|
|
26
|
+
export * from './core/discover/antipatterns.js';
|
|
27
|
+
export * from './core/discover/standards.js';
|
|
28
|
+
export * from './core/discover/dependencies.js';
|
|
29
|
+
export * from './reports/health-report.js';
|
|
30
|
+
export * from './reports/audit-report.js';
|
|
31
|
+
export * from './reports/link-report.js';
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"","sourceRoot":"","sources":["file:///mnt/e/docker-containers/hit-em-with-the-docs/src/index.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAGH,cAAc,6BAA6B,CAAC;AAC5C,cAAc,4BAA4B,CAAC;AAC3C,cAAc,8BAA8B,CAAC;AAG7C,cAAc,2BAA2B,CAAC;AAC1C,cAAc,8BAA8B,CAAC;AAG7C,cAAc,mBAAmB,CAAC;AAClC,cAAc,iBAAiB,CAAC;AAChC,cAAc,wBAAwB,CAAC;AACvC,cAAc,qBAAqB,CAAC;AAGpC,cAAc,0BAA0B,CAAC;AACzC,cAAc,iCAAiC,CAAC;AAChD,cAAc,oCAAoC,CAAC;AAGnD,cAAc,yBAAyB,CAAC;AACxC,cAAc,yBAAyB,CAAC;AACxC,cAAc,yBAAyB,CAAC;AACxC,cAAc,yBAAyB,CAAC;AACxC,cAAc,gCAAgC,CAAC;AAC/C,cAAc,iCAAiC,CAAC;AAGhD,cAAc,6BAA6B,CAAC;AAC5C,cAAc,iCAAiC,CAAC;AAChD,cAAc,8BAA8B,CAAC;AAC7C,cAAc,iCAAiC,CAAC;AAGhD,cAAc,4BAA4B,CAAC;AAC3C,cAAc,2BAA2B,CAAC;AAC1C,cAAc,0BAA0B,CAAC"}
|