@dommaker/harness 0.16.0 → 0.16.1
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/bin/harness.js +71 -0
- package/dist/cli/commands/doc-freshness-check.d.ts +53 -0
- package/dist/cli/commands/doc-freshness-check.d.ts.map +1 -0
- package/dist/cli/commands/doc-freshness-check.js +366 -0
- package/dist/cli/commands/doc-freshness-check.js.map +1 -0
- package/dist/cli/commands/index.d.ts +4 -1
- package/dist/cli/commands/index.d.ts.map +1 -1
- package/dist/cli/commands/index.js +13 -1
- package/dist/cli/commands/index.js.map +1 -1
- package/dist/cli/commands/knowledge.d.ts +12 -0
- package/dist/cli/commands/knowledge.d.ts.map +1 -1
- package/dist/cli/commands/knowledge.js +134 -0
- package/dist/cli/commands/knowledge.js.map +1 -1
- package/dist/cli/commands/release.d.ts +11 -0
- package/dist/cli/commands/release.d.ts.map +1 -1
- package/dist/cli/commands/release.js +43 -12
- package/dist/cli/commands/release.js.map +1 -1
- package/dist/cli/commands/sdd.d.ts +8 -0
- package/dist/cli/commands/sdd.d.ts.map +1 -0
- package/dist/cli/commands/sdd.js +68 -0
- package/dist/cli/commands/sdd.js.map +1 -0
- package/dist/cli/commands/spec-baseline-check.d.ts +30 -0
- package/dist/cli/commands/spec-baseline-check.d.ts.map +1 -0
- package/dist/cli/commands/spec-baseline-check.js +366 -0
- package/dist/cli/commands/spec-baseline-check.js.map +1 -0
- package/dist/knowledge/audit.d.ts +1 -1
- package/dist/knowledge/audit.d.ts.map +1 -1
- package/dist/knowledge/audit.js +59 -7
- package/dist/knowledge/audit.js.map +1 -1
- package/dist/knowledge/index-generator.d.ts +36 -0
- package/dist/knowledge/index-generator.d.ts.map +1 -0
- package/dist/knowledge/index-generator.js +241 -0
- package/dist/knowledge/index-generator.js.map +1 -0
- package/dist/knowledge/index.d.ts +2 -0
- package/dist/knowledge/index.d.ts.map +1 -1
- package/dist/knowledge/index.js +3 -1
- package/dist/knowledge/index.js.map +1 -1
- package/dist/knowledge/ingest.js +2 -2
- package/dist/knowledge/ingest.js.map +1 -1
- package/dist/knowledge/lifecycle.d.ts +15 -0
- package/dist/knowledge/lifecycle.d.ts.map +1 -1
- package/dist/knowledge/lifecycle.js +70 -0
- package/dist/knowledge/lifecycle.js.map +1 -1
- package/dist/knowledge/lint.js +3 -3
- package/dist/knowledge/lint.js.map +1 -1
- package/dist/knowledge/primitives/code-structure.d.ts +37 -0
- package/dist/knowledge/primitives/code-structure.d.ts.map +1 -0
- package/dist/knowledge/primitives/code-structure.js +168 -0
- package/dist/knowledge/primitives/code-structure.js.map +1 -0
- package/dist/knowledge/types.d.ts +3 -1
- package/dist/knowledge/types.d.ts.map +1 -1
- package/dist/knowledge/types.js.map +1 -1
- package/dist/sdd/index-generator.d.ts +22 -0
- package/dist/sdd/index-generator.d.ts.map +1 -0
- package/dist/sdd/index-generator.js +118 -0
- package/dist/sdd/index-generator.js.map +1 -0
- package/package.json +1 -1
- package/src/cli/commands/__tests__/doc-freshness-check.test.ts +168 -0
- package/src/cli/commands/__tests__/knowledge.test.ts +69 -1
- package/src/cli/commands/__tests__/spec-baseline-check.test.ts +235 -0
- package/src/cli/commands/doc-freshness-check.ts +397 -0
- package/src/cli/commands/index.ts +4 -1
- package/src/cli/commands/knowledge.ts +150 -0
- package/src/cli/commands/release.ts +48 -12
- package/src/cli/commands/sdd.ts +44 -0
- package/src/cli/commands/spec-baseline-check.ts +384 -0
- package/src/knowledge/__tests__/audit.test.ts +56 -0
- package/src/knowledge/__tests__/index-generator.test.ts +335 -0
- package/src/knowledge/audit.ts +64 -8
- package/src/knowledge/index-generator.ts +233 -0
- package/src/knowledge/index.ts +2 -0
- package/src/knowledge/ingest.ts +2 -2
- package/src/knowledge/lifecycle.ts +71 -0
- package/src/knowledge/lint.ts +3 -3
- package/src/knowledge/primitives/__tests__/code-structure.test.ts +120 -0
- package/src/knowledge/primitives/code-structure.ts +161 -0
- package/src/knowledge/types.ts +4 -1
- package/src/sdd/__tests__/index-generator.test.ts +150 -0
- package/src/sdd/index-generator.ts +109 -0
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* extractCodeStructure — Layer 1 代码结构提取(纯代码,零 LLM)
|
|
3
|
+
*
|
|
4
|
+
* 使用 TypeScript Compiler API 从 .ts 文件提取:
|
|
5
|
+
* - 函数声明
|
|
6
|
+
* - 类声明
|
|
7
|
+
* - 接口声明
|
|
8
|
+
* - 类型别名
|
|
9
|
+
* - import 语句
|
|
10
|
+
*
|
|
11
|
+
* 每个声明附带 JSDoc 注释(如果有)。
|
|
12
|
+
*/
|
|
13
|
+
export interface DeclarationInfo {
|
|
14
|
+
name: string;
|
|
15
|
+
signature: string;
|
|
16
|
+
jsdoc?: string;
|
|
17
|
+
}
|
|
18
|
+
export interface ImportInfo {
|
|
19
|
+
source: string;
|
|
20
|
+
names: string[];
|
|
21
|
+
}
|
|
22
|
+
export interface CodeStructure {
|
|
23
|
+
files: string[];
|
|
24
|
+
functions: DeclarationInfo[];
|
|
25
|
+
classes: DeclarationInfo[];
|
|
26
|
+
interfaces: DeclarationInfo[];
|
|
27
|
+
types: DeclarationInfo[];
|
|
28
|
+
imports: ImportInfo[];
|
|
29
|
+
}
|
|
30
|
+
/**
|
|
31
|
+
* 从目录中所有 .ts 文件提取代码结构。
|
|
32
|
+
*
|
|
33
|
+
* @param dir 目录路径
|
|
34
|
+
* @returns CodeStructure JSON
|
|
35
|
+
*/
|
|
36
|
+
export declare function extractCodeStructure(dir: string): CodeStructure;
|
|
37
|
+
//# sourceMappingURL=code-structure.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"code-structure.d.ts","sourceRoot":"","sources":["../../../src/knowledge/primitives/code-structure.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;GAWG;AAMH,MAAM,WAAW,eAAe;IAC9B,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,EAAE,MAAM,CAAC;IAClB,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,UAAU;IACzB,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,MAAM,EAAE,CAAC;CACjB;AAED,MAAM,WAAW,aAAa;IAC5B,KAAK,EAAE,MAAM,EAAE,CAAC;IAChB,SAAS,EAAE,eAAe,EAAE,CAAC;IAC7B,OAAO,EAAE,eAAe,EAAE,CAAC;IAC3B,UAAU,EAAE,eAAe,EAAE,CAAC;IAC9B,KAAK,EAAE,eAAe,EAAE,CAAC;IACzB,OAAO,EAAE,UAAU,EAAE,CAAC;CACvB;AAED;;;;;GAKG;AACH,wBAAgB,oBAAoB,CAAC,GAAG,EAAE,MAAM,GAAG,aAAa,CAiC/D"}
|
|
@@ -0,0 +1,168 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/**
|
|
3
|
+
* extractCodeStructure — Layer 1 代码结构提取(纯代码,零 LLM)
|
|
4
|
+
*
|
|
5
|
+
* 使用 TypeScript Compiler API 从 .ts 文件提取:
|
|
6
|
+
* - 函数声明
|
|
7
|
+
* - 类声明
|
|
8
|
+
* - 接口声明
|
|
9
|
+
* - 类型别名
|
|
10
|
+
* - import 语句
|
|
11
|
+
*
|
|
12
|
+
* 每个声明附带 JSDoc 注释(如果有)。
|
|
13
|
+
*/
|
|
14
|
+
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
|
|
15
|
+
if (k2 === undefined) k2 = k;
|
|
16
|
+
var desc = Object.getOwnPropertyDescriptor(m, k);
|
|
17
|
+
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
|
|
18
|
+
desc = { enumerable: true, get: function() { return m[k]; } };
|
|
19
|
+
}
|
|
20
|
+
Object.defineProperty(o, k2, desc);
|
|
21
|
+
}) : (function(o, m, k, k2) {
|
|
22
|
+
if (k2 === undefined) k2 = k;
|
|
23
|
+
o[k2] = m[k];
|
|
24
|
+
}));
|
|
25
|
+
var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
|
|
26
|
+
Object.defineProperty(o, "default", { enumerable: true, value: v });
|
|
27
|
+
}) : function(o, v) {
|
|
28
|
+
o["default"] = v;
|
|
29
|
+
});
|
|
30
|
+
var __importStar = (this && this.__importStar) || (function () {
|
|
31
|
+
var ownKeys = function(o) {
|
|
32
|
+
ownKeys = Object.getOwnPropertyNames || function (o) {
|
|
33
|
+
var ar = [];
|
|
34
|
+
for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
|
|
35
|
+
return ar;
|
|
36
|
+
};
|
|
37
|
+
return ownKeys(o);
|
|
38
|
+
};
|
|
39
|
+
return function (mod) {
|
|
40
|
+
if (mod && mod.__esModule) return mod;
|
|
41
|
+
var result = {};
|
|
42
|
+
if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
|
|
43
|
+
__setModuleDefault(result, mod);
|
|
44
|
+
return result;
|
|
45
|
+
};
|
|
46
|
+
})();
|
|
47
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
48
|
+
exports.extractCodeStructure = extractCodeStructure;
|
|
49
|
+
const fs = __importStar(require("fs"));
|
|
50
|
+
const path = __importStar(require("path"));
|
|
51
|
+
const ts = __importStar(require("typescript"));
|
|
52
|
+
/**
|
|
53
|
+
* 从目录中所有 .ts 文件提取代码结构。
|
|
54
|
+
*
|
|
55
|
+
* @param dir 目录路径
|
|
56
|
+
* @returns CodeStructure JSON
|
|
57
|
+
*/
|
|
58
|
+
function extractCodeStructure(dir) {
|
|
59
|
+
const result = {
|
|
60
|
+
files: [],
|
|
61
|
+
functions: [],
|
|
62
|
+
classes: [],
|
|
63
|
+
interfaces: [],
|
|
64
|
+
types: [],
|
|
65
|
+
imports: [],
|
|
66
|
+
};
|
|
67
|
+
let entries;
|
|
68
|
+
try {
|
|
69
|
+
entries = fs.readdirSync(dir, { withFileTypes: true });
|
|
70
|
+
}
|
|
71
|
+
catch {
|
|
72
|
+
return result;
|
|
73
|
+
}
|
|
74
|
+
const tsFiles = entries
|
|
75
|
+
.filter(e => e.isFile() && (e.name.endsWith('.ts') || e.name.endsWith('.tsx')) && !e.name.endsWith('.d.ts'))
|
|
76
|
+
.map(e => e.name)
|
|
77
|
+
.sort();
|
|
78
|
+
result.files = tsFiles;
|
|
79
|
+
for (const fileName of tsFiles) {
|
|
80
|
+
const filePath = path.join(dir, fileName);
|
|
81
|
+
const sourceText = fs.readFileSync(filePath, 'utf-8');
|
|
82
|
+
const sourceFile = ts.createSourceFile(fileName, sourceText, ts.ScriptTarget.Latest, true);
|
|
83
|
+
extractFromFile(sourceFile, result);
|
|
84
|
+
}
|
|
85
|
+
return result;
|
|
86
|
+
}
|
|
87
|
+
function extractFromFile(sourceFile, result) {
|
|
88
|
+
ts.forEachChild(sourceFile, node => {
|
|
89
|
+
if (ts.isFunctionDeclaration(node)) {
|
|
90
|
+
const info = extractDeclaration(node, sourceFile);
|
|
91
|
+
if (info)
|
|
92
|
+
result.functions.push(info);
|
|
93
|
+
}
|
|
94
|
+
else if (ts.isClassDeclaration(node)) {
|
|
95
|
+
const info = extractDeclaration(node, sourceFile);
|
|
96
|
+
if (info)
|
|
97
|
+
result.classes.push(info);
|
|
98
|
+
}
|
|
99
|
+
else if (ts.isInterfaceDeclaration(node)) {
|
|
100
|
+
const info = extractDeclaration(node, sourceFile);
|
|
101
|
+
if (info)
|
|
102
|
+
result.interfaces.push(info);
|
|
103
|
+
}
|
|
104
|
+
else if (ts.isTypeAliasDeclaration(node)) {
|
|
105
|
+
const info = extractDeclaration(node, sourceFile);
|
|
106
|
+
if (info)
|
|
107
|
+
result.types.push(info);
|
|
108
|
+
}
|
|
109
|
+
else if (ts.isImportDeclaration(node)) {
|
|
110
|
+
const importInfo = extractImport(node, sourceFile);
|
|
111
|
+
if (importInfo)
|
|
112
|
+
result.imports.push(importInfo);
|
|
113
|
+
}
|
|
114
|
+
});
|
|
115
|
+
}
|
|
116
|
+
function extractDeclaration(node, sourceFile) {
|
|
117
|
+
const name = node.name?.getText(sourceFile);
|
|
118
|
+
if (!name)
|
|
119
|
+
return undefined;
|
|
120
|
+
const signature = node.getText(sourceFile).split('\n')[0].trim();
|
|
121
|
+
const jsdoc = extractJSDoc(node, sourceFile);
|
|
122
|
+
return { name, signature, jsdoc };
|
|
123
|
+
}
|
|
124
|
+
function extractImport(node, sourceFile) {
|
|
125
|
+
const moduleSpecifier = node.moduleSpecifier;
|
|
126
|
+
if (!ts.isStringLiteral(moduleSpecifier))
|
|
127
|
+
return undefined;
|
|
128
|
+
const source = moduleSpecifier.text;
|
|
129
|
+
const names = [];
|
|
130
|
+
if (node.importClause) {
|
|
131
|
+
if (node.importClause.name) {
|
|
132
|
+
names.push(node.importClause.name.getText(sourceFile));
|
|
133
|
+
}
|
|
134
|
+
if (node.importClause.namedBindings) {
|
|
135
|
+
if (ts.isNamedImports(node.importClause.namedBindings)) {
|
|
136
|
+
for (const element of node.importClause.namedBindings.elements) {
|
|
137
|
+
names.push(element.name.getText(sourceFile));
|
|
138
|
+
}
|
|
139
|
+
}
|
|
140
|
+
}
|
|
141
|
+
}
|
|
142
|
+
return { source, names };
|
|
143
|
+
}
|
|
144
|
+
function extractJSDoc(node, sourceFile) {
|
|
145
|
+
const jsDocTags = ts.getJSDocTags(node);
|
|
146
|
+
const fullText = sourceFile.getFullText();
|
|
147
|
+
const nodeStart = node.getFullStart();
|
|
148
|
+
// Look backwards for JSDoc comment
|
|
149
|
+
const leadingCommentRanges = ts.getLeadingCommentRanges(fullText, nodeStart);
|
|
150
|
+
if (!leadingCommentRanges)
|
|
151
|
+
return undefined;
|
|
152
|
+
for (const range of leadingCommentRanges) {
|
|
153
|
+
const commentText = fullText.substring(range.pos, range.end);
|
|
154
|
+
if (commentText.startsWith('/**')) {
|
|
155
|
+
// Strip /** and */ and clean up
|
|
156
|
+
return commentText
|
|
157
|
+
.replace(/^\/\*\*\s*/, '')
|
|
158
|
+
.replace(/\s*\*\/$/, '')
|
|
159
|
+
.split('\n')
|
|
160
|
+
.map(line => line.replace(/^\s*\*\s?/, ''))
|
|
161
|
+
.filter(line => line.trim().length > 0)
|
|
162
|
+
.join(' ')
|
|
163
|
+
.trim();
|
|
164
|
+
}
|
|
165
|
+
}
|
|
166
|
+
return undefined;
|
|
167
|
+
}
|
|
168
|
+
//# sourceMappingURL=code-structure.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"code-structure.js","sourceRoot":"","sources":["../../../src/knowledge/primitives/code-structure.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;GAWG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAgCH,oDAiCC;AA/DD,uCAAyB;AACzB,2CAA6B;AAC7B,+CAAiC;AAsBjC;;;;;GAKG;AACH,SAAgB,oBAAoB,CAAC,GAAW;IAC9C,MAAM,MAAM,GAAkB;QAC5B,KAAK,EAAE,EAAE;QACT,SAAS,EAAE,EAAE;QACb,OAAO,EAAE,EAAE;QACX,UAAU,EAAE,EAAE;QACd,KAAK,EAAE,EAAE;QACT,OAAO,EAAE,EAAE;KACZ,CAAC;IAEF,IAAI,OAAoB,CAAC;IACzB,IAAI,CAAC;QACH,OAAO,GAAG,EAAE,CAAC,WAAW,CAAC,GAAG,EAAE,EAAE,aAAa,EAAE,IAAI,EAAE,CAAC,CAAC;IACzD,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,MAAM,CAAC;IAChB,CAAC;IAED,MAAM,OAAO,GAAG,OAAO;SACpB,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;SAC3G,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC;SAChB,IAAI,EAAE,CAAC;IAEV,MAAM,CAAC,KAAK,GAAG,OAAO,CAAC;IAEvB,KAAK,MAAM,QAAQ,IAAI,OAAO,EAAE,CAAC;QAC/B,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,QAAQ,CAAC,CAAC;QAC1C,MAAM,UAAU,GAAG,EAAE,CAAC,YAAY,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;QACtD,MAAM,UAAU,GAAG,EAAE,CAAC,gBAAgB,CAAC,QAAQ,EAAE,UAAU,EAAE,EAAE,CAAC,YAAY,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;QAE3F,eAAe,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC;IACtC,CAAC;IAED,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,SAAS,eAAe,CAAC,UAAyB,EAAE,MAAqB;IACvE,EAAE,CAAC,YAAY,CAAC,UAAU,EAAE,IAAI,CAAC,EAAE;QACjC,IAAI,EAAE,CAAC,qBAAqB,CAAC,IAAI,CAAC,EAAE,CAAC;YACnC,MAAM,IAAI,GAAG,kBAAkB,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC;YAClD,IAAI,IAAI;gBAAE,MAAM,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACxC,CAAC;aAAM,IAAI,EAAE,CAAC,kBAAkB,CAAC,IAAI,CAAC,EAAE,CAAC;YACvC,MAAM,IAAI,GAAG,kBAAkB,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC;YAClD,IAAI,IAAI;gBAAE,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACtC,CAAC;aAAM,IAAI,EAAE,CAAC,sBAAsB,CAAC,IAAI,CAAC,EAAE,CAAC;YAC3C,MAAM,IAAI,GAAG,kBAAkB,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC;YAClD,IAAI,IAAI;gBAAE,MAAM,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACzC,CAAC;aAAM,IAAI,EAAE,CAAC,sBAAsB,CAAC,IAAI,CAAC,EAAE,CAAC;YAC3C,MAAM,IAAI,GAAG,kBAAkB,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC;YAClD,IAAI,IAAI;gBAAE,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACpC,CAAC;aAAM,IAAI,EAAE,CAAC,mBAAmB,CAAC,IAAI,CAAC,EAAE,CAAC;YACxC,MAAM,UAAU,GAAG,aAAa,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC;YACnD,IAAI,UAAU;gBAAE,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAClD,CAAC;IACH,CAAC,CAAC,CAAC;AACL,CAAC;AAED,SAAS,kBAAkB,CACzB,IAAsG,EACtG,UAAyB;IAEzB,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,EAAE,OAAO,CAAC,UAAU,CAAC,CAAC;IAC5C,IAAI,CAAC,IAAI;QAAE,OAAO,SAAS,CAAC;IAE5B,MAAM,SAAS,GAAG,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;IACjE,MAAM,KAAK,GAAG,YAAY,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC;IAE7C,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE,CAAC;AACpC,CAAC;AAED,SAAS,aAAa,CAAC,IAA0B,EAAE,UAAyB;IAC1E,MAAM,eAAe,GAAG,IAAI,CAAC,eAAe,CAAC;IAC7C,IAAI,CAAC,EAAE,CAAC,eAAe,CAAC,eAAe,CAAC;QAAE,OAAO,SAAS,CAAC;IAE3D,MAAM,MAAM,GAAG,eAAe,CAAC,IAAI,CAAC;IACpC,MAAM,KAAK,GAAa,EAAE,CAAC;IAE3B,IAAI,IAAI,CAAC,YAAY,EAAE,CAAC;QACtB,IAAI,IAAI,CAAC,YAAY,CAAC,IAAI,EAAE,CAAC;YAC3B,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC;QACzD,CAAC;QACD,IAAI,IAAI,CAAC,YAAY,CAAC,aAAa,EAAE,CAAC;YACpC,IAAI,EAAE,CAAC,cAAc,CAAC,IAAI,CAAC,YAAY,CAAC,aAAa,CAAC,EAAE,CAAC;gBACvD,KAAK,MAAM,OAAO,IAAI,IAAI,CAAC,YAAY,CAAC,aAAa,CAAC,QAAQ,EAAE,CAAC;oBAC/D,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC;gBAC/C,CAAC;YACH,CAAC;QACH,CAAC;IACH,CAAC;IAED,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC;AAC3B,CAAC;AAED,SAAS,YAAY,CAAC,IAAa,EAAE,UAAyB;IAC5D,MAAM,SAAS,GAAG,EAAE,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;IACxC,MAAM,QAAQ,GAAG,UAAU,CAAC,WAAW,EAAE,CAAC;IAC1C,MAAM,SAAS,GAAG,IAAI,CAAC,YAAY,EAAE,CAAC;IAEtC,mCAAmC;IACnC,MAAM,oBAAoB,GAAG,EAAE,CAAC,uBAAuB,CAAC,QAAQ,EAAE,SAAS,CAAC,CAAC;IAC7E,IAAI,CAAC,oBAAoB;QAAE,OAAO,SAAS,CAAC;IAE5C,KAAK,MAAM,KAAK,IAAI,oBAAoB,EAAE,CAAC;QACzC,MAAM,WAAW,GAAG,QAAQ,CAAC,SAAS,CAAC,KAAK,CAAC,GAAG,EAAE,KAAK,CAAC,GAAG,CAAC,CAAC;QAC7D,IAAI,WAAW,CAAC,UAAU,CAAC,KAAK,CAAC,EAAE,CAAC;YAClC,gCAAgC;YAChC,OAAO,WAAW;iBACf,OAAO,CAAC,YAAY,EAAE,EAAE,CAAC;iBACzB,OAAO,CAAC,UAAU,EAAE,EAAE,CAAC;iBACvB,KAAK,CAAC,IAAI,CAAC;iBACX,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,WAAW,EAAE,EAAE,CAAC,CAAC;iBAC1C,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,MAAM,GAAG,CAAC,CAAC;iBACtC,IAAI,CAAC,GAAG,CAAC;iBACT,IAAI,EAAE,CAAC;QACZ,CAAC;IACH,CAAC;IAED,OAAO,SAAS,CAAC;AACnB,CAAC"}
|
|
@@ -6,7 +6,9 @@
|
|
|
6
6
|
* - KnowledgeType: what knowledge describes (MECE)
|
|
7
7
|
* - MaturityLevel: how trusted (lifecycle)
|
|
8
8
|
*/
|
|
9
|
-
export type
|
|
9
|
+
export type KnowledgeSubsystem = 'model' | 'decision' | 'guideline' | 'pitfall' | 'process' | 'architecture';
|
|
10
|
+
/** @deprecated Use KnowledgeSubsystem */
|
|
11
|
+
export type KnowledgeType = KnowledgeSubsystem;
|
|
10
12
|
export type MaturityLevel = 'draft' | 'verified' | 'proven' | 'archived' | 'active' | 'deprecated';
|
|
11
13
|
export type StorageLayer = 'personal' | 'team' | 'tech' | 'domain' | 'project' | 'system';
|
|
12
14
|
/** How agent consumes this knowledge — drives injection strategy and lifecycle */
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/knowledge/types.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAIH,MAAM,MAAM,
|
|
1
|
+
{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/knowledge/types.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAIH,MAAM,MAAM,kBAAkB,GAAG,OAAO,GAAG,UAAU,GAAG,WAAW,GAAG,SAAS,GAAG,SAAS,GAAG,cAAc,CAAC;AAE7G,yCAAyC;AACzC,MAAM,MAAM,aAAa,GAAG,kBAAkB,CAAC;AAE/C,MAAM,MAAM,aAAa,GAAG,OAAO,GAAG,UAAU,GAAG,QAAQ,GAAG,UAAU,GAAG,QAAQ,GAAG,YAAY,CAAC;AAEnG,MAAM,MAAM,YAAY,GAAG,UAAU,GAAG,MAAM,GAAG,MAAM,GAAG,QAAQ,GAAG,SAAS,GAAG,QAAQ,CAAC;AAE1F,kFAAkF;AAClF,MAAM,MAAM,eAAe,GAAG,MAAM,GAAG,WAAW,GAAG,SAAS,GAAG,QAAQ,CAAC;AAE1E,0EAA0E;AAC1E,MAAM,MAAM,eAAe,GAAG,OAAO,GAAG,OAAO,GAAG,UAAU,GAAG,QAAQ,CAAC;AAIxE,MAAM,WAAW,cAAc;IAC7B,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,aAAa,CAAC;IACpB,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,aAAa,CAAC;IACxB,KAAK,EAAE,YAAY,CAAC;IACpB,OAAO,EAAE,MAAM,CAAC;IAChB,cAAc,EAAE,MAAM,CAAC;IACvB,YAAY,EAAE,MAAM,EAAE,CAAC;IACvB,QAAQ,EAAE,MAAM,EAAE,CAAC;IACnB,IAAI,EAAE,MAAM,EAAE,CAAC;IACf,gBAAgB,EAAE,MAAM,EAAE,CAAC;IAC3B,gBAAgB,EAAE,SAAS,EAAE,CAAC;IAC9B,YAAY,EAAE,MAAM,EAAE,CAAC;IACvB,gBAAgB,EAAE,eAAe,EAAE,CAAC;IACpC,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,+DAA+D;IAC/D,eAAe,EAAE,eAAe,CAAC;IACjC,wDAAwD;IACxD,MAAM,EAAE,eAAe,CAAC;IACxB,uDAAuD;IACvD,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,0DAA0D;IAC1D,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,SAAS;IACxB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,eAAe;IAC9B,WAAW,EAAE,MAAM,CAAC;IACpB,OAAO,EAAE,OAAO,CAAC;IACjB,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,CAAC,EAAE,OAAO,GAAG,MAAM,CAAC;CAC3B;AAID,MAAM,WAAW,kBAAkB;IACjC,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,WAAW;IAC1B,KAAK,EAAE,MAAM,CAAC;IACd,SAAS,EAAE,MAAM,CAAC;IAClB,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,aAAa,EAAE,CAAC;CAC7B;AAED,MAAM,WAAW,WAAW;IAC1B,OAAO,EAAE,cAAc,EAAE,CAAC;IAC1B,UAAU,EAAE,MAAM,CAAC;IACnB,SAAS,EAAE,OAAO,CAAC;IACnB,SAAS,EAAE,OAAO,CAAC;CACpB;AAED,MAAM,WAAW,WAAW;IAC1B,KAAK,CAAC,EAAE,aAAa,EAAE,CAAC;IACxB,QAAQ,CAAC,EAAE,aAAa,EAAE,CAAC;IAC3B,MAAM,CAAC,EAAE,YAAY,EAAE,CAAC;IACxB,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;IAChB,gBAAgB,CAAC,EAAE,MAAM,EAAE,CAAC;IAC5B,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B,gBAAgB,CAAC,EAAE,eAAe,EAAE,CAAC;IACrC,OAAO,CAAC,EAAE,eAAe,EAAE,CAAC;CAC7B;AAID,MAAM,MAAM,aAAa,GAAG,QAAQ,GAAG,eAAe,GAAG,UAAU,GAAG,WAAW,GAAG,oBAAoB,CAAC;AAEzG,MAAM,WAAW,SAAS;IACxB,IAAI,EAAE,aAAa,CAAC;IACpB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,KAAK,GAAG,QAAQ,GAAG,MAAM,CAAC;IACpC,WAAW,EAAE,MAAM,CAAC;IACpB,UAAU,EAAE,MAAM,CAAC;CACpB;AAID,MAAM,WAAW,aAAa;IAC5B,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,YAAY,CAAC;IACpB,QAAQ,CAAC,EAAE,aAAa,CAAC;IACzB,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;IAChB,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;IACpB,eAAe,CAAC,EAAE,eAAe,CAAC;IAClC,MAAM,CAAC,EAAE,eAAe,CAAC;IACzB,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B;AAID,MAAM,WAAW,cAAc;IAC7B,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,aAAa,CAAC;IACpB,EAAE,EAAE,aAAa,CAAC;IAClB,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,WAAW;IAC1B,iBAAiB,EAAE,MAAM,CAAC;IAC1B,mBAAmB,EAAE,MAAM,CAAC;IAC5B,gBAAgB,EAAE,MAAM,CAAC;IACzB,8EAA8E;IAC9E,kBAAkB,EAAE,MAAM,EAAE,CAAC;CAC9B;AAED,eAAO,MAAM,oBAAoB,EAAE,WAKlC,CAAC;AAIF,MAAM,WAAW,cAAc;IAC7B,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,EAAE,cAAc,GAAG,SAAS,GAAG,SAAS,GAAG,QAAQ,CAAC;IAC5D,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,MAAM,CAAC;IACjB,YAAY,EAAE,MAAM,EAAE,CAAC;IACvB,SAAS,EAAE,MAAM,CAAC;IAClB,YAAY,EAAE,MAAM,CAAC;IACrB,YAAY,EAAE,MAAM,EAAE,CAAC;IACvB,UAAU,EAAE,MAAM,CAAC;IACnB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,OAAO,CAAC;IACnB,gBAAgB,CAAC,EAAE,MAAM,CAAC;CAC3B;AAID,MAAM,WAAW,eAAe;IAC9B,UAAU,EAAE,MAAM,CAAC;IACnB,QAAQ,EAAE,MAAM,EAAE,CAAC;IACnB,SAAS,EAAE,MAAM,CAAC;CACnB;AAID,MAAM,WAAW,UAAU;IACzB,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,aAAa,CAAC;IACpB,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,EAAE,aAAa,CAAC;IACxB,KAAK,EAAE,YAAY,CAAC;IACpB,IAAI,EAAE,MAAM,EAAE,CAAC;IACf,gBAAgB,EAAE,MAAM,EAAE,CAAC;IAC3B,cAAc,EAAE,MAAM,CAAC;IACvB,OAAO,EAAE,MAAM,CAAC;IAChB,eAAe,EAAE,eAAe,CAAC;IACjC,MAAM,EAAE,eAAe,CAAC;CACzB"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/knowledge/types.ts"],"names":[],"mappings":";AAAA;;;;;;;GAOG;;;
|
|
1
|
+
{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/knowledge/types.ts"],"names":[],"mappings":";AAAA;;;;;;;GAOG;;;AAyIU,QAAA,oBAAoB,GAAgB;IAC/C,iBAAiB,EAAE,EAAE;IACrB,mBAAmB,EAAE,CAAC;IACtB,gBAAgB,EAAE,CAAC;IACnB,kBAAkB,EAAE,EAAE;CACvB,CAAC"}
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
interface SDDIndexEntry {
|
|
2
|
+
slug: string;
|
|
3
|
+
pmoNumber: string;
|
|
4
|
+
status: string;
|
|
5
|
+
title: string;
|
|
6
|
+
tags: string;
|
|
7
|
+
}
|
|
8
|
+
export interface SDDIndexResult {
|
|
9
|
+
count: number;
|
|
10
|
+
entries: SDDIndexEntry[];
|
|
11
|
+
}
|
|
12
|
+
export declare class SDDIndexGenerator {
|
|
13
|
+
private sddDir;
|
|
14
|
+
constructor(baseDir: string);
|
|
15
|
+
regenerate(): SDDIndexResult;
|
|
16
|
+
private scanEntries;
|
|
17
|
+
private parseFrontmatter;
|
|
18
|
+
private sanitize;
|
|
19
|
+
private buildContent;
|
|
20
|
+
}
|
|
21
|
+
export {};
|
|
22
|
+
//# sourceMappingURL=index-generator.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index-generator.d.ts","sourceRoot":"","sources":["../../src/sdd/index-generator.ts"],"names":[],"mappings":"AAUA,UAAU,aAAa;IACrB,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,cAAc;IAC7B,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,aAAa,EAAE,CAAC;CAC1B;AAED,qBAAa,iBAAiB;IAC5B,OAAO,CAAC,MAAM,CAAS;gBAEX,OAAO,EAAE,MAAM;IAI3B,UAAU,IAAI,cAAc;IAe5B,OAAO,CAAC,WAAW;IA8BnB,OAAO,CAAC,gBAAgB;IAUxB,OAAO,CAAC,QAAQ;IAIhB,OAAO,CAAC,YAAY;CAmBrB"}
|
|
@@ -0,0 +1,118 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
// SDD Index Generator
|
|
3
|
+
// Scans docs/sdd/*/requirement.md, generates docs/sdd/_index.md
|
|
4
|
+
// Format: slug|pmoNumber|status|title|tags
|
|
5
|
+
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
|
|
6
|
+
if (k2 === undefined) k2 = k;
|
|
7
|
+
var desc = Object.getOwnPropertyDescriptor(m, k);
|
|
8
|
+
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
|
|
9
|
+
desc = { enumerable: true, get: function() { return m[k]; } };
|
|
10
|
+
}
|
|
11
|
+
Object.defineProperty(o, k2, desc);
|
|
12
|
+
}) : (function(o, m, k, k2) {
|
|
13
|
+
if (k2 === undefined) k2 = k;
|
|
14
|
+
o[k2] = m[k];
|
|
15
|
+
}));
|
|
16
|
+
var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
|
|
17
|
+
Object.defineProperty(o, "default", { enumerable: true, value: v });
|
|
18
|
+
}) : function(o, v) {
|
|
19
|
+
o["default"] = v;
|
|
20
|
+
});
|
|
21
|
+
var __importStar = (this && this.__importStar) || (function () {
|
|
22
|
+
var ownKeys = function(o) {
|
|
23
|
+
ownKeys = Object.getOwnPropertyNames || function (o) {
|
|
24
|
+
var ar = [];
|
|
25
|
+
for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
|
|
26
|
+
return ar;
|
|
27
|
+
};
|
|
28
|
+
return ownKeys(o);
|
|
29
|
+
};
|
|
30
|
+
return function (mod) {
|
|
31
|
+
if (mod && mod.__esModule) return mod;
|
|
32
|
+
var result = {};
|
|
33
|
+
if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
|
|
34
|
+
__setModuleDefault(result, mod);
|
|
35
|
+
return result;
|
|
36
|
+
};
|
|
37
|
+
})();
|
|
38
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
39
|
+
exports.SDDIndexGenerator = void 0;
|
|
40
|
+
const fs = __importStar(require("fs"));
|
|
41
|
+
const path = __importStar(require("path"));
|
|
42
|
+
const yaml = __importStar(require("js-yaml"));
|
|
43
|
+
const INDEX_FILENAME = '_index.md';
|
|
44
|
+
class SDDIndexGenerator {
|
|
45
|
+
sddDir;
|
|
46
|
+
constructor(baseDir) {
|
|
47
|
+
this.sddDir = path.join(baseDir, 'docs', 'sdd');
|
|
48
|
+
}
|
|
49
|
+
regenerate() {
|
|
50
|
+
if (!fs.existsSync(this.sddDir)) {
|
|
51
|
+
throw new Error(`SDD directory not found: ${this.sddDir}`);
|
|
52
|
+
}
|
|
53
|
+
const entries = this.scanEntries();
|
|
54
|
+
entries.sort((a, b) => a.slug.localeCompare(b.slug));
|
|
55
|
+
const content = this.buildContent(entries);
|
|
56
|
+
const indexPath = path.join(this.sddDir, INDEX_FILENAME);
|
|
57
|
+
fs.writeFileSync(indexPath, content, 'utf-8');
|
|
58
|
+
return { count: entries.length, entries };
|
|
59
|
+
}
|
|
60
|
+
scanEntries() {
|
|
61
|
+
const entries = [];
|
|
62
|
+
const dirs = fs.readdirSync(this.sddDir, { withFileTypes: true })
|
|
63
|
+
.filter(d => d.isDirectory())
|
|
64
|
+
.map(d => d.name);
|
|
65
|
+
for (const dir of dirs) {
|
|
66
|
+
const reqPath = path.join(this.sddDir, dir, 'requirement.md');
|
|
67
|
+
if (!fs.existsSync(reqPath))
|
|
68
|
+
continue;
|
|
69
|
+
const content = fs.readFileSync(reqPath, 'utf-8');
|
|
70
|
+
const fm = this.parseFrontmatter(content);
|
|
71
|
+
if (!fm)
|
|
72
|
+
continue;
|
|
73
|
+
// Skip stale SDDs
|
|
74
|
+
const status = String(fm.status || 'unknown');
|
|
75
|
+
if (status === 'stale')
|
|
76
|
+
continue;
|
|
77
|
+
entries.push({
|
|
78
|
+
slug: String(fm.slug || dir),
|
|
79
|
+
pmoNumber: String(fm.pmoNumber || ''),
|
|
80
|
+
status,
|
|
81
|
+
title: this.sanitize(String(fm.title || dir)),
|
|
82
|
+
tags: Array.isArray(fm.tags) ? fm.tags.join(',') : '',
|
|
83
|
+
});
|
|
84
|
+
}
|
|
85
|
+
return entries;
|
|
86
|
+
}
|
|
87
|
+
parseFrontmatter(content) {
|
|
88
|
+
const match = content.match(/^---\n([\s\S]*?)\n---/);
|
|
89
|
+
if (!match)
|
|
90
|
+
return null;
|
|
91
|
+
try {
|
|
92
|
+
return yaml.load(match[1]) || null;
|
|
93
|
+
}
|
|
94
|
+
catch {
|
|
95
|
+
return null;
|
|
96
|
+
}
|
|
97
|
+
}
|
|
98
|
+
sanitize(s) {
|
|
99
|
+
return s.replace(/\n/g, ' ').replace(/\|/g, '/').replace(/\s+/g, ' ').trim();
|
|
100
|
+
}
|
|
101
|
+
buildContent(entries) {
|
|
102
|
+
const header = [
|
|
103
|
+
'# SDD Index',
|
|
104
|
+
'# Auto-generated — run `harness sdd index` to rebuild',
|
|
105
|
+
`# Total: ${entries.length} entries`,
|
|
106
|
+
'#',
|
|
107
|
+
'# Usage:',
|
|
108
|
+
'# grep "<pmoNumber>" docs/sdd/_index.md',
|
|
109
|
+
'# Then Read the matching SDD directory for full content.',
|
|
110
|
+
'#',
|
|
111
|
+
'# slug|pmoNumber|status|title|tags',
|
|
112
|
+
].join('\n');
|
|
113
|
+
const lines = entries.map(e => `${e.slug}|${e.pmoNumber}|${e.status}|${e.title}|${e.tags}`);
|
|
114
|
+
return header + '\n' + lines.join('\n') + '\n';
|
|
115
|
+
}
|
|
116
|
+
}
|
|
117
|
+
exports.SDDIndexGenerator = SDDIndexGenerator;
|
|
118
|
+
//# sourceMappingURL=index-generator.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index-generator.js","sourceRoot":"","sources":["../../src/sdd/index-generator.ts"],"names":[],"mappings":";AAAA,sBAAsB;AACtB,gEAAgE;AAChE,2CAA2C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAE3C,uCAAyB;AACzB,2CAA6B;AAC7B,8CAAgC;AAEhC,MAAM,cAAc,GAAG,WAAW,CAAC;AAenC,MAAa,iBAAiB;IACpB,MAAM,CAAS;IAEvB,YAAY,OAAe;QACzB,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,KAAK,CAAC,CAAC;IAClD,CAAC;IAED,UAAU;QACR,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC;YAChC,MAAM,IAAI,KAAK,CAAC,4BAA4B,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC;QAC7D,CAAC;QAED,MAAM,OAAO,GAAG,IAAI,CAAC,WAAW,EAAE,CAAC;QACnC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC;QAErD,MAAM,OAAO,GAAG,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC;QAC3C,MAAM,SAAS,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC;QACzD,EAAE,CAAC,aAAa,CAAC,SAAS,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;QAE9C,OAAO,EAAE,KAAK,EAAE,OAAO,CAAC,MAAM,EAAE,OAAO,EAAE,CAAC;IAC5C,CAAC;IAEO,WAAW;QACjB,MAAM,OAAO,GAAoB,EAAE,CAAC;QACpC,MAAM,IAAI,GAAG,EAAE,CAAC,WAAW,CAAC,IAAI,CAAC,MAAM,EAAE,EAAE,aAAa,EAAE,IAAI,EAAE,CAAC;aAC9D,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC;aAC5B,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;QAEpB,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;YACvB,MAAM,OAAO,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,EAAE,gBAAgB,CAAC,CAAC;YAC9D,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,OAAO,CAAC;gBAAE,SAAS;YAEtC,MAAM,OAAO,GAAG,EAAE,CAAC,YAAY,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;YAClD,MAAM,EAAE,GAAG,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;YAC1C,IAAI,CAAC,EAAE;gBAAE,SAAS;YAElB,kBAAkB;YAClB,MAAM,MAAM,GAAG,MAAM,CAAC,EAAE,CAAC,MAAM,IAAI,SAAS,CAAC,CAAC;YAC9C,IAAI,MAAM,KAAK,OAAO;gBAAE,SAAS;YAEjC,OAAO,CAAC,IAAI,CAAC;gBACX,IAAI,EAAE,MAAM,CAAC,EAAE,CAAC,IAAI,IAAI,GAAG,CAAC;gBAC5B,SAAS,EAAE,MAAM,CAAC,EAAE,CAAC,SAAS,IAAI,EAAE,CAAC;gBACrC,MAAM;gBACN,KAAK,EAAE,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC,KAAK,IAAI,GAAG,CAAC,CAAC;gBAC7C,IAAI,EAAE,KAAK,CAAC,OAAO,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE;aACtD,CAAC,CAAC;QACL,CAAC;QAED,OAAO,OAAO,CAAC;IACjB,CAAC;IAEO,gBAAgB,CAAC,OAAe;QACtC,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK,CAAC,uBAAuB,CAAC,CAAC;QACrD,IAAI,CAAC,KAAK;YAAE,OAAO,IAAI,CAAC;QACxB,IAAI,CAAC;YACH,OAAO,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAA4B,IAAI,IAAI,CAAC;QAChE,CAAC;QAAC,MAAM,CAAC;YACP,OAAO,IAAI,CAAC;QACd,CAAC;IACH,CAAC;IAEO,QAAQ,CAAC,CAAS;QACxB,OAAO,CAAC,CAAC,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC,OAAO,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,IAAI,EAAE,CAAC;IAC/E,CAAC;IAEO,YAAY,CAAC,OAAwB;QAC3C,MAAM,MAAM,GAAG;YACb,aAAa;YACb,uDAAuD;YACvD,YAAY,OAAO,CAAC,MAAM,UAAU;YACpC,GAAG;YACH,UAAU;YACV,2CAA2C;YAC3C,4DAA4D;YAC5D,GAAG;YACH,oCAAoC;SACrC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAEb,MAAM,KAAK,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAC5B,GAAG,CAAC,CAAC,IAAI,IAAI,CAAC,CAAC,SAAS,IAAI,CAAC,CAAC,MAAM,IAAI,CAAC,CAAC,KAAK,IAAI,CAAC,CAAC,IAAI,EAAE,CAC5D,CAAC;QAEF,OAAO,MAAM,GAAG,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC;IACjD,CAAC;CACF;AArFD,8CAqFC"}
|
package/package.json
CHANGED
|
@@ -0,0 +1,168 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* doc-freshness-check 命令测试
|
|
3
|
+
*/
|
|
4
|
+
|
|
5
|
+
import * as fs from 'fs';
|
|
6
|
+
import * as path from 'path';
|
|
7
|
+
import { extractClaims, verifyClaims, docFreshnessCheck } from '../doc-freshness-check';
|
|
8
|
+
|
|
9
|
+
describe('doc-freshness-check', () => {
|
|
10
|
+
const tempDir = path.join(process.cwd(), 'temp-test-doc-freshness');
|
|
11
|
+
let consoleSpy: jest.SpyInstance;
|
|
12
|
+
let errorSpy: jest.SpyInstance;
|
|
13
|
+
let originalExitCode: string | number | undefined;
|
|
14
|
+
|
|
15
|
+
beforeAll(() => {
|
|
16
|
+
fs.mkdirSync(tempDir, { recursive: true });
|
|
17
|
+
});
|
|
18
|
+
|
|
19
|
+
afterAll(() => {
|
|
20
|
+
try {
|
|
21
|
+
fs.rmSync(tempDir, { recursive: true, force: true });
|
|
22
|
+
} catch {
|
|
23
|
+
// ignore
|
|
24
|
+
}
|
|
25
|
+
});
|
|
26
|
+
|
|
27
|
+
beforeEach(() => {
|
|
28
|
+
jest.clearAllMocks();
|
|
29
|
+
consoleSpy = jest.spyOn(console, 'log').mockImplementation();
|
|
30
|
+
errorSpy = jest.spyOn(console, 'error').mockImplementation();
|
|
31
|
+
originalExitCode = process.exitCode;
|
|
32
|
+
process.exitCode = 0;
|
|
33
|
+
});
|
|
34
|
+
|
|
35
|
+
afterEach(() => {
|
|
36
|
+
consoleSpy.mockRestore();
|
|
37
|
+
errorSpy.mockRestore();
|
|
38
|
+
process.exitCode = originalExitCode;
|
|
39
|
+
});
|
|
40
|
+
|
|
41
|
+
describe('extractClaims', () => {
|
|
42
|
+
it('应该提取数字声明', () => {
|
|
43
|
+
const content = '系统包含 9 个 Agent 和 13 条规则';
|
|
44
|
+
const results = extractClaims(content, 'test.md');
|
|
45
|
+
|
|
46
|
+
expect(results.length).toBeGreaterThanOrEqual(2);
|
|
47
|
+
const numericResults = results.filter(r => r.type === 'numeric');
|
|
48
|
+
expect(numericResults.length).toBeGreaterThanOrEqual(2);
|
|
49
|
+
expect(numericResults.some(r => r.expected === '9')).toBe(true);
|
|
50
|
+
expect(numericResults.some(r => r.expected === '13')).toBe(true);
|
|
51
|
+
});
|
|
52
|
+
|
|
53
|
+
it('应该提取列表声明', () => {
|
|
54
|
+
const content = '组件包括 Analyst, Executor, Reviewer, Monitor';
|
|
55
|
+
const results = extractClaims(content, 'test.md');
|
|
56
|
+
|
|
57
|
+
const listResults = results.filter(r => r.type === 'list');
|
|
58
|
+
expect(listResults.length).toBeGreaterThanOrEqual(1);
|
|
59
|
+
expect(listResults[0].expected).toContain('Analyst');
|
|
60
|
+
expect(listResults[0].expected).toContain('Executor');
|
|
61
|
+
});
|
|
62
|
+
|
|
63
|
+
it('应该提取状态标记', () => {
|
|
64
|
+
const content = '✅ 已完成\n❌ 缺失\nDEPRECATED\n待开发';
|
|
65
|
+
const results = extractClaims(content, 'test.md');
|
|
66
|
+
|
|
67
|
+
const statusResults = results.filter(r => r.type === 'status');
|
|
68
|
+
expect(statusResults.length).toBeGreaterThanOrEqual(3);
|
|
69
|
+
});
|
|
70
|
+
|
|
71
|
+
it('应该忽略不含声明的行', () => {
|
|
72
|
+
const content = '这是一段普通的描述文字\n没有可验证的内容';
|
|
73
|
+
const results = extractClaims(content, 'test.md');
|
|
74
|
+
|
|
75
|
+
expect(results.length).toBe(0);
|
|
76
|
+
});
|
|
77
|
+
|
|
78
|
+
it('应该处理混合内容', () => {
|
|
79
|
+
const content = [
|
|
80
|
+
'# 系统架构',
|
|
81
|
+
'包含 8 个 Agent,5 大能力',
|
|
82
|
+
'Agent 列表: Analyst, Executor, Reviewer, Knowledge, Monitor',
|
|
83
|
+
'✅ 已完成核心功能',
|
|
84
|
+
'待开发: xxx',
|
|
85
|
+
'普通段落文字',
|
|
86
|
+
].join('\n');
|
|
87
|
+
|
|
88
|
+
const results = extractClaims(content, 'test.md');
|
|
89
|
+
expect(results.length).toBeGreaterThanOrEqual(4);
|
|
90
|
+
});
|
|
91
|
+
});
|
|
92
|
+
|
|
93
|
+
describe('verifyClaims', () => {
|
|
94
|
+
it('应该验证数字声明(命令计数)', () => {
|
|
95
|
+
const claims = extractClaims('包含 22 个 subcommand', 'test.md');
|
|
96
|
+
const results = verifyClaims(claims, path.join(__dirname, '../../../../'));
|
|
97
|
+
|
|
98
|
+
expect(results.length).toBe(1);
|
|
99
|
+
// harness 实际有很多命令,数字可能不完全匹配但应该有值
|
|
100
|
+
expect(results[0].actual).not.toBe('');
|
|
101
|
+
});
|
|
102
|
+
|
|
103
|
+
it('应该验证列表声明', () => {
|
|
104
|
+
const claims = extractClaims('组件: Analyst, Executor, Reviewer', 'test.md');
|
|
105
|
+
// 用 harness 源码目录作为 projectPath
|
|
106
|
+
const results = verifyClaims(claims, path.join(__dirname, '../../../../'));
|
|
107
|
+
|
|
108
|
+
// 列表验证会检查代码中是否存在这些名称
|
|
109
|
+
expect(results.length).toBe(1);
|
|
110
|
+
expect(results[0].type).toBe('list');
|
|
111
|
+
});
|
|
112
|
+
|
|
113
|
+
it('状态标记应该标记为需人工确认', () => {
|
|
114
|
+
const claims = extractClaims('✅ 已完成', 'test.md');
|
|
115
|
+
const results = verifyClaims(claims, tempDir);
|
|
116
|
+
|
|
117
|
+
expect(results.length).toBe(1);
|
|
118
|
+
expect(results[0].match).toBe(true); // 不阻断
|
|
119
|
+
});
|
|
120
|
+
});
|
|
121
|
+
|
|
122
|
+
describe('docFreshnessCheck CLI', () => {
|
|
123
|
+
it('应该在文件不存在时报错', async () => {
|
|
124
|
+
await docFreshnessCheck('/nonexistent/file.md');
|
|
125
|
+
|
|
126
|
+
expect(errorSpy).toHaveBeenCalledWith(expect.stringContaining('文件不存在'));
|
|
127
|
+
expect(process.exitCode).toBe(1);
|
|
128
|
+
});
|
|
129
|
+
|
|
130
|
+
it('应该输出 table 格式', async () => {
|
|
131
|
+
const docPath = path.join(tempDir, 'test-doc.md');
|
|
132
|
+
fs.writeFileSync(docPath, '# Test\n系统有 9 个 Agent 和 13 条规则');
|
|
133
|
+
|
|
134
|
+
await docFreshnessCheck(docPath, { projectPath: tempDir });
|
|
135
|
+
|
|
136
|
+
expect(consoleSpy).toHaveBeenCalled();
|
|
137
|
+
const output = consoleSpy.mock.calls.map((c: any[]) => c[0]).join('\n');
|
|
138
|
+
expect(output).toContain('文档新鲜度检查');
|
|
139
|
+
});
|
|
140
|
+
|
|
141
|
+
it('应该输出 JSON 格式', async () => {
|
|
142
|
+
const docPath = path.join(tempDir, 'test-json.md');
|
|
143
|
+
fs.writeFileSync(docPath, '# Test\n系统有 5 个 Agent');
|
|
144
|
+
|
|
145
|
+
await docFreshnessCheck(docPath, { format: 'json', projectPath: tempDir });
|
|
146
|
+
|
|
147
|
+
const jsonCall = consoleSpy.mock.calls.find((c: any[]) => {
|
|
148
|
+
try {
|
|
149
|
+
const parsed = JSON.parse(c[0]);
|
|
150
|
+
return Array.isArray(parsed);
|
|
151
|
+
} catch {
|
|
152
|
+
return false;
|
|
153
|
+
}
|
|
154
|
+
});
|
|
155
|
+
expect(jsonCall).toBeTruthy();
|
|
156
|
+
});
|
|
157
|
+
|
|
158
|
+
it('空文档应该输出 0 条声明', async () => {
|
|
159
|
+
const docPath = path.join(tempDir, 'empty.md');
|
|
160
|
+
fs.writeFileSync(docPath, '# Empty\n\nNo claims here.');
|
|
161
|
+
|
|
162
|
+
await docFreshnessCheck(docPath, { projectPath: tempDir });
|
|
163
|
+
|
|
164
|
+
const output = consoleSpy.mock.calls.map((c: any[]) => c[0]).join('\n');
|
|
165
|
+
expect(output).toContain('未发现可验证的声明');
|
|
166
|
+
});
|
|
167
|
+
});
|
|
168
|
+
});
|