mewkit 1.9.6 → 1.9.7
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/commands/validate.d.ts.map +1 -1
- package/dist/commands/validate.js +41 -0
- package/dist/commands/validate.js.map +1 -1
- package/dist/core/check-docs-references.d.ts +23 -0
- package/dist/core/check-docs-references.d.ts.map +1 -0
- package/dist/core/check-docs-references.js +159 -0
- package/dist/core/check-docs-references.js.map +1 -0
- package/package.json +1 -1
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"validate.d.ts","sourceRoot":"","sources":["../../src/commands/validate.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"validate.d.ts","sourceRoot":"","sources":["../../src/commands/validate.ts"],"names":[],"mappings":"AAiKA,wBAAsB,QAAQ,IAAI,OAAO,CAAC,IAAI,CAAC,CAgD9C"}
|
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
import fs from "node:fs";
|
|
2
2
|
import path from "node:path";
|
|
3
3
|
import pc from "picocolors";
|
|
4
|
+
import { checkDocsReferences } from "../core/check-docs-references.js";
|
|
4
5
|
/** Find MeowKit .claude/ in cwd only (no walk-up). */
|
|
5
6
|
function findMeowkitDir(startDir) {
|
|
6
7
|
const candidate = path.join(startDir, ".claude");
|
|
@@ -94,6 +95,44 @@ function checkConfigJson(meowkitDir) {
|
|
|
94
95
|
};
|
|
95
96
|
}
|
|
96
97
|
}
|
|
98
|
+
function checkDocsRefsContract(meowkitDir) {
|
|
99
|
+
const results = [];
|
|
100
|
+
const contractPath = path.join(meowkitDir, "rules", "docs-reference-contract.md");
|
|
101
|
+
if (!fs.existsSync(contractPath)) {
|
|
102
|
+
results.push({
|
|
103
|
+
name: "Docs-reference contract present",
|
|
104
|
+
passed: false,
|
|
105
|
+
detail: `Missing: ${contractPath}`,
|
|
106
|
+
});
|
|
107
|
+
return results;
|
|
108
|
+
}
|
|
109
|
+
try {
|
|
110
|
+
const { scannedFiles, findings, errorCount, warnCount } = checkDocsReferences(meowkitDir);
|
|
111
|
+
const passed = errorCount === 0;
|
|
112
|
+
const summary = `Scanned ${scannedFiles} files — ${errorCount} error(s), ${warnCount} warning(s)`;
|
|
113
|
+
const detail = passed
|
|
114
|
+
? summary
|
|
115
|
+
: `${summary}\n ${findings
|
|
116
|
+
.filter((f) => f.level === "ERROR")
|
|
117
|
+
.slice(0, 10)
|
|
118
|
+
.map((f) => `${f.file}:${f.line}: ${f.token}`)
|
|
119
|
+
.join("\n ")}`;
|
|
120
|
+
results.push({
|
|
121
|
+
name: "Docs references on Type-1 allowlist",
|
|
122
|
+
passed,
|
|
123
|
+
detail,
|
|
124
|
+
});
|
|
125
|
+
}
|
|
126
|
+
catch (error) {
|
|
127
|
+
const message = error instanceof Error ? error.message : String(error);
|
|
128
|
+
results.push({
|
|
129
|
+
name: "Docs references on Type-1 allowlist",
|
|
130
|
+
passed: false,
|
|
131
|
+
detail: `Validator crashed: ${message}`,
|
|
132
|
+
});
|
|
133
|
+
}
|
|
134
|
+
return results;
|
|
135
|
+
}
|
|
97
136
|
function printResult(result) {
|
|
98
137
|
const icon = result.passed ? pc.green("PASS") : pc.red("FAIL");
|
|
99
138
|
console.log(` [${icon}] ${result.name}`);
|
|
@@ -122,6 +161,8 @@ export async function validate() {
|
|
|
122
161
|
results.push(...checkHooksExecutable(meowkitDir));
|
|
123
162
|
// Config JSON
|
|
124
163
|
results.push(checkConfigJson(meowkitDir));
|
|
164
|
+
// Docs-reference contract (Type-1 allowlist)
|
|
165
|
+
results.push(...checkDocsRefsContract(meowkitDir));
|
|
125
166
|
for (const result of results) {
|
|
126
167
|
printResult(result);
|
|
127
168
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"validate.js","sourceRoot":"","sources":["../../src/commands/validate.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,SAAS,CAAC;AACzB,OAAO,IAAI,MAAM,WAAW,CAAC;AAC7B,OAAO,EAAE,MAAM,YAAY,CAAC;
|
|
1
|
+
{"version":3,"file":"validate.js","sourceRoot":"","sources":["../../src/commands/validate.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,SAAS,CAAC;AACzB,OAAO,IAAI,MAAM,WAAW,CAAC;AAC7B,OAAO,EAAE,MAAM,YAAY,CAAC;AAC5B,OAAO,EAAE,mBAAmB,EAAE,MAAM,kCAAkC,CAAC;AAQvE,sDAAsD;AACtD,SAAS,cAAc,CAAC,QAAgB;IACvC,MAAM,SAAS,GAAG,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,SAAS,CAAC,CAAC;IACjD,IAAI,EAAE,CAAC,UAAU,CAAC,SAAS,CAAC,IAAI,EAAE,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC,WAAW,EAAE,EAAE,CAAC;QACtE,OAAO,SAAS,CAAC;IAClB,CAAC;IACD,OAAO,IAAI,CAAC;AACb,CAAC;AAED,SAAS,eAAe,CAAC,UAAkB,EAAE,YAAoB;IAChE,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,YAAY,CAAC,CAAC;IACrD,MAAM,MAAM,GAAG,EAAE,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;IACvC,OAAO;QACN,IAAI,EAAE,gBAAgB,YAAY,EAAE;QACpC,MAAM,EAAE,MAAM;QACd,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,YAAY,QAAQ,EAAE;KAClD,CAAC;AACH,CAAC;AAED,SAAS,cAAc,CAAC,UAAkB,EAAE,YAAoB;IAC/D,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,YAAY,CAAC,CAAC;IACrD,MAAM,MAAM,GAAG,EAAE,CAAC,UAAU,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC,WAAW,EAAE,CAAC;IAC9E,OAAO;QACN,IAAI,EAAE,qBAAqB,YAAY,EAAE;QACzC,MAAM,EAAE,MAAM;QACd,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,YAAY,QAAQ,EAAE;KAClD,CAAC;AACH,CAAC;AAED,SAAS,oBAAoB,CAAC,UAAkB;IAC/C,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC;IAChD,MAAM,OAAO,GAAkB,EAAE,CAAC;IAElC,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE,CAAC;QAC9B,OAAO,CAAC,IAAI,CAAC;YACZ,IAAI,EAAE,iBAAiB;YACvB,MAAM,EAAE,KAAK;YACb,MAAM,EAAE,YAAY,QAAQ,EAAE;SAC9B,CAAC,CAAC;QACH,OAAO,OAAO,CAAC;IAChB,CAAC;IAED,MAAM,SAAS,GAAG,EAAE,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC;IAE7E,IAAI,SAAS,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC5B,OAAO,CAAC,IAAI,CAAC;YACZ,IAAI,EAAE,eAAe;YACrB,MAAM,EAAE,KAAK;YACb,MAAM,EAAE,+BAA+B;SACvC,CAAC,CAAC;QACH,OAAO,OAAO,CAAC;IAChB,CAAC;IAED,KAAK,MAAM,IAAI,IAAI,SAAS,EAAE,CAAC;QAC9B,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;QAC3C,IAAI,CAAC;YACJ,EAAE,CAAC,UAAU,CAAC,QAAQ,EAAE,EAAE,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;YAC3C,OAAO,CAAC,IAAI,CAAC;gBACZ,IAAI,EAAE,oBAAoB,IAAI,EAAE;gBAChC,MAAM,EAAE,IAAI;gBACZ,MAAM,EAAE,QAAQ;aAChB,CAAC,CAAC;QACJ,CAAC;QAAC,MAAM,CAAC;YACR,OAAO,CAAC,IAAI,CAAC;gBACZ,IAAI,EAAE,oBAAoB,IAAI,EAAE;gBAChC,MAAM,EAAE,KAAK;gBACb,MAAM,EAAE,mBAAmB,QAAQ,EAAE;aACrC,CAAC,CAAC;QACJ,CAAC;IACF,CAAC;IAED,OAAO,OAAO,CAAC;AAChB,CAAC;AAED,SAAS,eAAe,CAAC,UAAkB;IAC1C,MAAM,UAAU,GAAG,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,qBAAqB,CAAC,CAAC;IAChE,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,UAAU,CAAC,EAAE,CAAC;QAChC,OAAO;YACN,IAAI,EAAE,mBAAmB;YACzB,MAAM,EAAE,KAAK;YACb,MAAM,EAAE,YAAY,UAAU,EAAE;SAChC,CAAC;IACH,CAAC;IAED,IAAI,CAAC;QACJ,MAAM,OAAO,GAAG,EAAE,CAAC,YAAY,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC;QACrD,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QACpB,OAAO;YACN,IAAI,EAAE,mBAAmB;YACzB,MAAM,EAAE,IAAI;YACZ,MAAM,EAAE,UAAU;SAClB,CAAC;IACH,CAAC;IAAC,OAAO,KAAc,EAAE,CAAC;QACzB,MAAM,OAAO,GAAG,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;QACvE,OAAO;YACN,IAAI,EAAE,mBAAmB;YACzB,MAAM,EAAE,KAAK;YACb,MAAM,EAAE,iBAAiB,OAAO,EAAE;SAClC,CAAC;IACH,CAAC;AACF,CAAC;AAED,SAAS,qBAAqB,CAAC,UAAkB;IAChD,MAAM,OAAO,GAAkB,EAAE,CAAC;IAClC,MAAM,YAAY,GAAG,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,OAAO,EAAE,4BAA4B,CAAC,CAAC;IAClF,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,YAAY,CAAC,EAAE,CAAC;QAClC,OAAO,CAAC,IAAI,CAAC;YACZ,IAAI,EAAE,iCAAiC;YACvC,MAAM,EAAE,KAAK;YACb,MAAM,EAAE,YAAY,YAAY,EAAE;SAClC,CAAC,CAAC;QACH,OAAO,OAAO,CAAC;IAChB,CAAC;IAED,IAAI,CAAC;QACJ,MAAM,EAAE,YAAY,EAAE,QAAQ,EAAE,UAAU,EAAE,SAAS,EAAE,GAAG,mBAAmB,CAAC,UAAU,CAAC,CAAC;QAC1F,MAAM,MAAM,GAAG,UAAU,KAAK,CAAC,CAAC;QAChC,MAAM,OAAO,GAAG,WAAW,YAAY,YAAY,UAAU,cAAc,SAAS,aAAa,CAAC;QAClG,MAAM,MAAM,GAAG,MAAM;YACpB,CAAC,CAAC,OAAO;YACT,CAAC,CAAC,GAAG,OAAO,cAAc,QAAQ;iBAChC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,KAAK,OAAO,CAAC;iBAClC,KAAK,CAAC,CAAC,EAAE,EAAE,CAAC;iBACZ,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,GAAG,CAAC,CAAC,IAAI,IAAI,CAAC,CAAC,IAAI,KAAK,CAAC,CAAC,KAAK,EAAE,CAAC;iBAC7C,IAAI,CAAC,aAAa,CAAC,EAAE,CAAC;QACzB,OAAO,CAAC,IAAI,CAAC;YACZ,IAAI,EAAE,qCAAqC;YAC3C,MAAM;YACN,MAAM;SACN,CAAC,CAAC;IACJ,CAAC;IAAC,OAAO,KAAc,EAAE,CAAC;QACzB,MAAM,OAAO,GAAG,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;QACvE,OAAO,CAAC,IAAI,CAAC;YACZ,IAAI,EAAE,qCAAqC;YAC3C,MAAM,EAAE,KAAK;YACb,MAAM,EAAE,sBAAsB,OAAO,EAAE;SACvC,CAAC,CAAC;IACJ,CAAC;IAED,OAAO,OAAO,CAAC;AAChB,CAAC;AAED,SAAS,WAAW,CAAC,MAAmB;IACvC,MAAM,IAAI,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;IAC/D,OAAO,CAAC,GAAG,CAAC,MAAM,IAAI,KAAK,MAAM,CAAC,IAAI,EAAE,CAAC,CAAC;IAC1C,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC;QACpB,OAAO,CAAC,GAAG,CAAC,YAAY,EAAE,CAAC,GAAG,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;IAClD,CAAC;AACF,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,QAAQ;IAC7B,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,0CAA0C,CAAC,CAAC,CAAC,CAAC;IAC1E,OAAO,CAAC,GAAG,EAAE,CAAC;IAEd,MAAM,UAAU,GAAG,cAAc,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC,CAAC;IAEjD,IAAI,CAAC,UAAU,EAAE,CAAC;QACjB,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC,GAAG,CAAC,qEAAqE,CAAC,CAAC,CAAC;QAC7F,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IACjB,CAAC;IAED,OAAO,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,UAAU,EAAE,CAAC,CAAC;IACjD,OAAO,CAAC,GAAG,EAAE,CAAC;IAEd,MAAM,OAAO,GAAkB,EAAE,CAAC;IAElC,uBAAuB;IACvB,OAAO,CAAC,IAAI,CAAC,cAAc,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC,CAAC;IACnD,OAAO,CAAC,IAAI,CAAC,cAAc,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC,CAAC;IAElD,oEAAoE;IACpE,MAAM,WAAW,GAAG,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;IAC7C,OAAO,CAAC,IAAI,CAAC,eAAe,CAAC,WAAW,EAAE,WAAW,CAAC,CAAC,CAAC;IAExD,mBAAmB;IACnB,OAAO,CAAC,IAAI,CAAC,GAAG,oBAAoB,CAAC,UAAU,CAAC,CAAC,CAAC;IAElD,cAAc;IACd,OAAO,CAAC,IAAI,CAAC,eAAe,CAAC,UAAU,CAAC,CAAC,CAAC;IAE1C,6CAA6C;IAC7C,OAAO,CAAC,IAAI,CAAC,GAAG,qBAAqB,CAAC,UAAU,CAAC,CAAC,CAAC;IAEnD,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE,CAAC;QAC9B,WAAW,CAAC,MAAM,CAAC,CAAC;IACrB,CAAC;IAED,OAAO,CAAC,GAAG,EAAE,CAAC;IAEd,MAAM,SAAS,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC;IACzD,MAAM,SAAS,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC;IAE1D,IAAI,SAAS,KAAK,CAAC,EAAE,CAAC;QACrB,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC,KAAK,CAAC,EAAE,CAAC,IAAI,CAAC,OAAO,SAAS,iBAAiB,CAAC,CAAC,CAAC,CAAC;IACnE,CAAC;SAAM,CAAC;QACP,OAAO,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,KAAK,CAAC,GAAG,SAAS,SAAS,CAAC,KAAK,EAAE,CAAC,GAAG,CAAC,GAAG,SAAS,SAAS,CAAC,EAAE,CAAC,CAAC;QACpF,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IACjB,CAAC;AACF,CAAC"}
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
export interface DocsRefFinding {
|
|
2
|
+
file: string;
|
|
3
|
+
line: number;
|
|
4
|
+
token: string;
|
|
5
|
+
level: "ERROR" | "WARN";
|
|
6
|
+
reason: string;
|
|
7
|
+
}
|
|
8
|
+
export interface DocsRefResult {
|
|
9
|
+
scannedFiles: number;
|
|
10
|
+
findings: DocsRefFinding[];
|
|
11
|
+
errorCount: number;
|
|
12
|
+
warnCount: number;
|
|
13
|
+
}
|
|
14
|
+
interface AllowlistData {
|
|
15
|
+
allowed: string[];
|
|
16
|
+
reserved: string[];
|
|
17
|
+
}
|
|
18
|
+
/** Parse the Type-1 allowlist from docs-reference-contract.md. */
|
|
19
|
+
export declare function parseAllowlist(contractPath: string): AllowlistData;
|
|
20
|
+
export declare function checkDocsReferences(claudeDir: string): DocsRefResult;
|
|
21
|
+
export declare function formatReport(result: DocsRefResult): string;
|
|
22
|
+
export {};
|
|
23
|
+
//# sourceMappingURL=check-docs-references.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"check-docs-references.d.ts","sourceRoot":"","sources":["../../src/core/check-docs-references.ts"],"names":[],"mappings":"AAGA,MAAM,WAAW,cAAc;IAC9B,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,OAAO,GAAG,MAAM,CAAC;IACxB,MAAM,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,aAAa;IAC7B,YAAY,EAAE,MAAM,CAAC;IACrB,QAAQ,EAAE,cAAc,EAAE,CAAC;IAC3B,UAAU,EAAE,MAAM,CAAC;IACnB,SAAS,EAAE,MAAM,CAAC;CAClB;AA4BD,UAAU,aAAa;IACtB,OAAO,EAAE,MAAM,EAAE,CAAC;IAClB,QAAQ,EAAE,MAAM,EAAE,CAAC;CACnB;AAED,kEAAkE;AAClE,wBAAgB,cAAc,CAAC,YAAY,EAAE,MAAM,GAAG,aAAa,CAKlE;AAyED,wBAAgB,mBAAmB,CAAC,SAAS,EAAE,MAAM,GAAG,aAAa,CAkDpE;AAED,wBAAgB,YAAY,CAAC,MAAM,EAAE,aAAa,GAAG,MAAM,CAS1D"}
|
|
@@ -0,0 +1,159 @@
|
|
|
1
|
+
import fs from "node:fs";
|
|
2
|
+
import path from "node:path";
|
|
3
|
+
// Subdirectories under .claude/ that ship in the release zip.
|
|
4
|
+
// Adding more subdirs is safe — they only get scanned if present.
|
|
5
|
+
const SCAN_DIRS = [
|
|
6
|
+
"agents",
|
|
7
|
+
"skills",
|
|
8
|
+
"commands",
|
|
9
|
+
"memory",
|
|
10
|
+
"hooks",
|
|
11
|
+
"scripts",
|
|
12
|
+
"rules",
|
|
13
|
+
"rules-conditional",
|
|
14
|
+
"modes",
|
|
15
|
+
"benchmarks",
|
|
16
|
+
];
|
|
17
|
+
// Files allowed to mention banned paths (because they DEFINE the bans).
|
|
18
|
+
const FILE_WHITELIST = new Set([
|
|
19
|
+
"rules/docs-reference-contract.md",
|
|
20
|
+
"rules/skill-authoring-rules.md",
|
|
21
|
+
]);
|
|
22
|
+
// Skill dirs whose Grep-of-user-project semantics need an opt-out from path checks.
|
|
23
|
+
const SKILL_DIR_WHITELIST = new Set([
|
|
24
|
+
"skills/docs-finder",
|
|
25
|
+
]);
|
|
26
|
+
/** Parse the Type-1 allowlist from docs-reference-contract.md. */
|
|
27
|
+
export function parseAllowlist(contractPath) {
|
|
28
|
+
const content = fs.readFileSync(contractPath, "utf-8");
|
|
29
|
+
const allowed = extractFenced(content, "ALLOWLIST-START", "ALLOWLIST-END");
|
|
30
|
+
const reserved = extractFenced(content, "RESERVED-START", "RESERVED-END");
|
|
31
|
+
return { allowed, reserved };
|
|
32
|
+
}
|
|
33
|
+
function extractFenced(content, startMarker, endMarker) {
|
|
34
|
+
const startTag = `<!-- ${startMarker} -->`;
|
|
35
|
+
const endTag = `<!-- ${endMarker} -->`;
|
|
36
|
+
const startIdx = content.indexOf(startTag);
|
|
37
|
+
const endIdx = content.indexOf(endTag);
|
|
38
|
+
if (startIdx === -1 || endIdx === -1 || endIdx < startIdx)
|
|
39
|
+
return [];
|
|
40
|
+
const block = content.slice(startIdx + startTag.length, endIdx);
|
|
41
|
+
return block
|
|
42
|
+
.split("\n")
|
|
43
|
+
.map((l) => l.trim())
|
|
44
|
+
.filter((l) => l.length > 0 && !l.startsWith("#") && !l.startsWith("<!--"));
|
|
45
|
+
}
|
|
46
|
+
function isAllowed(token, allowed) {
|
|
47
|
+
for (const entry of allowed) {
|
|
48
|
+
if (entry.endsWith("/")) {
|
|
49
|
+
if (token.startsWith(entry))
|
|
50
|
+
return true;
|
|
51
|
+
}
|
|
52
|
+
else if (token === entry) {
|
|
53
|
+
return true;
|
|
54
|
+
}
|
|
55
|
+
}
|
|
56
|
+
return false;
|
|
57
|
+
}
|
|
58
|
+
/** Strip http/https URLs and angle-bracket-wrapped content (HTML tags, placeholders). */
|
|
59
|
+
function stripNoise(line) {
|
|
60
|
+
return line.replace(/https?:\/\/[^\s)\]\"'`,]+/g, "").replace(/<[^>]*>/g, "");
|
|
61
|
+
}
|
|
62
|
+
/** Extract docs/<path> tokens from a single line. Hyphen-safe regex. */
|
|
63
|
+
function extractTokens(line) {
|
|
64
|
+
const cleaned = stripNoise(line);
|
|
65
|
+
const matches = [];
|
|
66
|
+
const re = /docs\/[A-Za-z0-9_./\-]+/g;
|
|
67
|
+
let m;
|
|
68
|
+
while ((m = re.exec(cleaned)) !== null) {
|
|
69
|
+
const token = m[0].replace(/[.,)\]]+$/, "");
|
|
70
|
+
matches.push(token);
|
|
71
|
+
}
|
|
72
|
+
return matches;
|
|
73
|
+
}
|
|
74
|
+
function walkMd(dir, out = []) {
|
|
75
|
+
if (!fs.existsSync(dir))
|
|
76
|
+
return out;
|
|
77
|
+
for (const entry of fs.readdirSync(dir, { withFileTypes: true })) {
|
|
78
|
+
const full = path.join(dir, entry.name);
|
|
79
|
+
if (entry.isDirectory()) {
|
|
80
|
+
if (entry.name === "node_modules" ||
|
|
81
|
+
entry.name === ".venv" ||
|
|
82
|
+
entry.name === "tests" ||
|
|
83
|
+
entry.name === "__pycache__")
|
|
84
|
+
continue;
|
|
85
|
+
walkMd(full, out);
|
|
86
|
+
}
|
|
87
|
+
else if (entry.isFile() &&
|
|
88
|
+
(entry.name.endsWith(".md") || entry.name.endsWith(".sh") || entry.name.endsWith(".py") || entry.name.endsWith(".cjs") || entry.name.endsWith(".js"))) {
|
|
89
|
+
out.push(full);
|
|
90
|
+
}
|
|
91
|
+
}
|
|
92
|
+
return out;
|
|
93
|
+
}
|
|
94
|
+
function isInWhitelistedSkill(relPath) {
|
|
95
|
+
for (const prefix of SKILL_DIR_WHITELIST) {
|
|
96
|
+
if (relPath.startsWith(prefix + "/") || relPath.startsWith(prefix + path.sep))
|
|
97
|
+
return true;
|
|
98
|
+
}
|
|
99
|
+
return false;
|
|
100
|
+
}
|
|
101
|
+
export function checkDocsReferences(claudeDir) {
|
|
102
|
+
const contractPath = path.join(claudeDir, "rules", "docs-reference-contract.md");
|
|
103
|
+
if (!fs.existsSync(contractPath)) {
|
|
104
|
+
throw new Error(`Contract file missing: ${contractPath}`);
|
|
105
|
+
}
|
|
106
|
+
const { allowed, reserved } = parseAllowlist(contractPath);
|
|
107
|
+
const findings = [];
|
|
108
|
+
let scannedFiles = 0;
|
|
109
|
+
for (const sub of SCAN_DIRS) {
|
|
110
|
+
const dir = path.join(claudeDir, sub);
|
|
111
|
+
const files = walkMd(dir);
|
|
112
|
+
for (const file of files) {
|
|
113
|
+
scannedFiles++;
|
|
114
|
+
const relPath = path.relative(claudeDir, file);
|
|
115
|
+
if (FILE_WHITELIST.has(relPath.split(path.sep).join("/")))
|
|
116
|
+
continue;
|
|
117
|
+
if (isInWhitelistedSkill(relPath.split(path.sep).join("/")))
|
|
118
|
+
continue;
|
|
119
|
+
const content = fs.readFileSync(file, "utf-8");
|
|
120
|
+
const lines = content.split("\n");
|
|
121
|
+
for (let i = 0; i < lines.length; i++) {
|
|
122
|
+
const tokens = extractTokens(lines[i]);
|
|
123
|
+
for (const token of tokens) {
|
|
124
|
+
if (isAllowed(token, allowed))
|
|
125
|
+
continue;
|
|
126
|
+
if (isAllowed(token, reserved)) {
|
|
127
|
+
findings.push({
|
|
128
|
+
file: relPath,
|
|
129
|
+
line: i + 1,
|
|
130
|
+
token,
|
|
131
|
+
level: "WARN",
|
|
132
|
+
reason: "Reserved future path — not yet on allowlist",
|
|
133
|
+
});
|
|
134
|
+
continue;
|
|
135
|
+
}
|
|
136
|
+
findings.push({
|
|
137
|
+
file: relPath,
|
|
138
|
+
line: i + 1,
|
|
139
|
+
token,
|
|
140
|
+
level: "ERROR",
|
|
141
|
+
reason: "Not on Type-1 allowlist — internal-doc leak or unrecognized path",
|
|
142
|
+
});
|
|
143
|
+
}
|
|
144
|
+
}
|
|
145
|
+
}
|
|
146
|
+
}
|
|
147
|
+
const errorCount = findings.filter((f) => f.level === "ERROR").length;
|
|
148
|
+
const warnCount = findings.filter((f) => f.level === "WARN").length;
|
|
149
|
+
return { scannedFiles, findings, errorCount, warnCount };
|
|
150
|
+
}
|
|
151
|
+
export function formatReport(result) {
|
|
152
|
+
const lines = [];
|
|
153
|
+
for (const f of result.findings) {
|
|
154
|
+
lines.push(`${f.file}:${f.line}: ${f.level}: ${f.token} — ${f.reason}`);
|
|
155
|
+
}
|
|
156
|
+
lines.push(`\nScanned ${result.scannedFiles} files. ${result.errorCount} error(s), ${result.warnCount} warning(s).`);
|
|
157
|
+
return lines.join("\n");
|
|
158
|
+
}
|
|
159
|
+
//# sourceMappingURL=check-docs-references.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"check-docs-references.js","sourceRoot":"","sources":["../../src/core/check-docs-references.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,SAAS,CAAC;AACzB,OAAO,IAAI,MAAM,WAAW,CAAC;AAiB7B,8DAA8D;AAC9D,kEAAkE;AAClE,MAAM,SAAS,GAAG;IACjB,QAAQ;IACR,QAAQ;IACR,UAAU;IACV,QAAQ;IACR,OAAO;IACP,SAAS;IACT,OAAO;IACP,mBAAmB;IACnB,OAAO;IACP,YAAY;CACZ,CAAC;AAEF,wEAAwE;AACxE,MAAM,cAAc,GAAG,IAAI,GAAG,CAAC;IAC9B,kCAAkC;IAClC,gCAAgC;CAChC,CAAC,CAAC;AAEH,oFAAoF;AACpF,MAAM,mBAAmB,GAAG,IAAI,GAAG,CAAC;IACnC,oBAAoB;CACpB,CAAC,CAAC;AAOH,kEAAkE;AAClE,MAAM,UAAU,cAAc,CAAC,YAAoB;IAClD,MAAM,OAAO,GAAG,EAAE,CAAC,YAAY,CAAC,YAAY,EAAE,OAAO,CAAC,CAAC;IACvD,MAAM,OAAO,GAAG,aAAa,CAAC,OAAO,EAAE,iBAAiB,EAAE,eAAe,CAAC,CAAC;IAC3E,MAAM,QAAQ,GAAG,aAAa,CAAC,OAAO,EAAE,gBAAgB,EAAE,cAAc,CAAC,CAAC;IAC1E,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,CAAC;AAC9B,CAAC;AAED,SAAS,aAAa,CAAC,OAAe,EAAE,WAAmB,EAAE,SAAiB;IAC7E,MAAM,QAAQ,GAAG,QAAQ,WAAW,MAAM,CAAC;IAC3C,MAAM,MAAM,GAAG,QAAQ,SAAS,MAAM,CAAC;IACvC,MAAM,QAAQ,GAAG,OAAO,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;IAC3C,MAAM,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;IACvC,IAAI,QAAQ,KAAK,CAAC,CAAC,IAAI,MAAM,KAAK,CAAC,CAAC,IAAI,MAAM,GAAG,QAAQ;QAAE,OAAO,EAAE,CAAC;IACrE,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK,CAAC,QAAQ,GAAG,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAChE,OAAO,KAAK;SACV,KAAK,CAAC,IAAI,CAAC;SACX,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;SACpB,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC;AAC9E,CAAC;AAED,SAAS,SAAS,CAAC,KAAa,EAAE,OAAiB;IAClD,KAAK,MAAM,KAAK,IAAI,OAAO,EAAE,CAAC;QAC7B,IAAI,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;YACzB,IAAI,KAAK,CAAC,UAAU,CAAC,KAAK,CAAC;gBAAE,OAAO,IAAI,CAAC;QAC1C,CAAC;aAAM,IAAI,KAAK,KAAK,KAAK,EAAE,CAAC;YAC5B,OAAO,IAAI,CAAC;QACb,CAAC;IACF,CAAC;IACD,OAAO,KAAK,CAAC;AACd,CAAC;AAED,yFAAyF;AACzF,SAAS,UAAU,CAAC,IAAY;IAC/B,OAAO,IAAI,CAAC,OAAO,CAAC,4BAA4B,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,UAAU,EAAE,EAAE,CAAC,CAAC;AAC/E,CAAC;AAED,wEAAwE;AACxE,SAAS,aAAa,CAAC,IAAY;IAClC,MAAM,OAAO,GAAG,UAAU,CAAC,IAAI,CAAC,CAAC;IACjC,MAAM,OAAO,GAAa,EAAE,CAAC;IAC7B,MAAM,EAAE,GAAG,0BAA0B,CAAC;IACtC,IAAI,CAAyB,CAAC;IAC9B,OAAO,CAAC,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,KAAK,IAAI,EAAE,CAAC;QACxC,MAAM,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,WAAW,EAAE,EAAE,CAAC,CAAC;QAC5C,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IACrB,CAAC;IACD,OAAO,OAAO,CAAC;AAChB,CAAC;AAED,SAAS,MAAM,CAAC,GAAW,EAAE,MAAgB,EAAE;IAC9C,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,GAAG,CAAC;QAAE,OAAO,GAAG,CAAC;IACpC,KAAK,MAAM,KAAK,IAAI,EAAE,CAAC,WAAW,CAAC,GAAG,EAAE,EAAE,aAAa,EAAE,IAAI,EAAE,CAAC,EAAE,CAAC;QAClE,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC;QACxC,IAAI,KAAK,CAAC,WAAW,EAAE,EAAE,CAAC;YACzB,IACC,KAAK,CAAC,IAAI,KAAK,cAAc;gBAC7B,KAAK,CAAC,IAAI,KAAK,OAAO;gBACtB,KAAK,CAAC,IAAI,KAAK,OAAO;gBACtB,KAAK,CAAC,IAAI,KAAK,aAAa;gBAC3B,SAAS;YACX,MAAM,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;QACnB,CAAC;aAAM,IACN,KAAK,CAAC,MAAM,EAAE;YACd,CAAC,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,EACpJ,CAAC;YACF,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAChB,CAAC;IACF,CAAC;IACD,OAAO,GAAG,CAAC;AACZ,CAAC;AAED,SAAS,oBAAoB,CAAC,OAAe;IAC5C,KAAK,MAAM,MAAM,IAAI,mBAAmB,EAAE,CAAC;QAC1C,IAAI,OAAO,CAAC,UAAU,CAAC,MAAM,GAAG,GAAG,CAAC,IAAI,OAAO,CAAC,UAAU,CAAC,MAAM,GAAG,IAAI,CAAC,GAAG,CAAC;YAAE,OAAO,IAAI,CAAC;IAC5F,CAAC;IACD,OAAO,KAAK,CAAC;AACd,CAAC;AAED,MAAM,UAAU,mBAAmB,CAAC,SAAiB;IACpD,MAAM,YAAY,GAAG,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,OAAO,EAAE,4BAA4B,CAAC,CAAC;IACjF,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,YAAY,CAAC,EAAE,CAAC;QAClC,MAAM,IAAI,KAAK,CAAC,0BAA0B,YAAY,EAAE,CAAC,CAAC;IAC3D,CAAC;IACD,MAAM,EAAE,OAAO,EAAE,QAAQ,EAAE,GAAG,cAAc,CAAC,YAAY,CAAC,CAAC;IAE3D,MAAM,QAAQ,GAAqB,EAAE,CAAC;IACtC,IAAI,YAAY,GAAG,CAAC,CAAC;IAErB,KAAK,MAAM,GAAG,IAAI,SAAS,EAAE,CAAC;QAC7B,MAAM,GAAG,GAAG,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,GAAG,CAAC,CAAC;QACtC,MAAM,KAAK,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC;QAC1B,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;YAC1B,YAAY,EAAE,CAAC;YACf,MAAM,OAAO,GAAG,IAAI,CAAC,QAAQ,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC;YAC/C,IAAI,cAAc,CAAC,GAAG,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;gBAAE,SAAS;YACpE,IAAI,oBAAoB,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;gBAAE,SAAS;YAEtE,MAAM,OAAO,GAAG,EAAE,CAAC,YAAY,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;YAC/C,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;YAClC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;gBACvC,MAAM,MAAM,GAAG,aAAa,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;gBACvC,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE,CAAC;oBAC5B,IAAI,SAAS,CAAC,KAAK,EAAE,OAAO,CAAC;wBAAE,SAAS;oBACxC,IAAI,SAAS,CAAC,KAAK,EAAE,QAAQ,CAAC,EAAE,CAAC;wBAChC,QAAQ,CAAC,IAAI,CAAC;4BACb,IAAI,EAAE,OAAO;4BACb,IAAI,EAAE,CAAC,GAAG,CAAC;4BACX,KAAK;4BACL,KAAK,EAAE,MAAM;4BACb,MAAM,EAAE,6CAA6C;yBACrD,CAAC,CAAC;wBACH,SAAS;oBACV,CAAC;oBACD,QAAQ,CAAC,IAAI,CAAC;wBACb,IAAI,EAAE,OAAO;wBACb,IAAI,EAAE,CAAC,GAAG,CAAC;wBACX,KAAK;wBACL,KAAK,EAAE,OAAO;wBACd,MAAM,EAAE,kEAAkE;qBAC1E,CAAC,CAAC;gBACJ,CAAC;YACF,CAAC;QACF,CAAC;IACF,CAAC;IAED,MAAM,UAAU,GAAG,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,KAAK,OAAO,CAAC,CAAC,MAAM,CAAC;IACtE,MAAM,SAAS,GAAG,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,KAAK,MAAM,CAAC,CAAC,MAAM,CAAC;IACpE,OAAO,EAAE,YAAY,EAAE,QAAQ,EAAE,UAAU,EAAE,SAAS,EAAE,CAAC;AAC1D,CAAC;AAED,MAAM,UAAU,YAAY,CAAC,MAAqB;IACjD,MAAM,KAAK,GAAa,EAAE,CAAC;IAC3B,KAAK,MAAM,CAAC,IAAI,MAAM,CAAC,QAAQ,EAAE,CAAC;QACjC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,IAAI,IAAI,CAAC,CAAC,IAAI,KAAK,CAAC,CAAC,KAAK,KAAK,CAAC,CAAC,KAAK,MAAM,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC;IACzE,CAAC;IACD,KAAK,CAAC,IAAI,CACT,aAAa,MAAM,CAAC,YAAY,WAAW,MAAM,CAAC,UAAU,cAAc,MAAM,CAAC,SAAS,cAAc,CACxG,CAAC;IACF,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AACzB,CAAC"}
|