sdtk-wiki-kit 0.1.1 → 0.1.3

package/src/lib/wiki-lint.js

@@ -27,6 +27,21 @@ const REQUIRED_PAGE_FIELDS = [
   "role",
 ];
 
+const REQUIRED_PERSONAL_BRAIN_FIELDS = [
+  "id",
+  "title",
+  "type",
+  "status",
+  "created_at",
+  "updated_at",
+  "aliases",
+  "tags",
+  "related_pages",
+  "source_refs",
+  "confidence",
+  "review_status",
+];
+
 const CATEGORY_DEFS = [
   ["schema", "Frontmatter and schema"],
   ["duplicates", "Duplicate page IDs"],
@@ -40,8 +55,21 @@ const CATEGORY_DEFS = [
   ["markers", "TODO/Open Questions/Gaps"],
   ["contradictions", "Candidate contradictions"],
   ["sourceQuality", "Source quality"],
+  ["personalBrainQuality", "Personal-brain quality gate"],
 ];
 
+const REQUIRED_PERSONAL_BRAIN_SECTIONS = {
+  source: ["Summary", "Source Metadata", "Source Quality", "Provenance"],
+  tool_entity: ["Summary", "Key Facts", "Discovery Source", "Extracted Snippet", "Topic Labels", "Why It Matters", "When To Use", "Related Repos", "Overlaps / Differences", "Open Questions", "Provenance"],
+  concept: ["Summary", "Key Axes", "Implementations / Examples", "Patterns", "Recommendations / Caveats", "Open Questions", "Related Pages", "Source References"],
+  comparison: ["Summary", "Decision Axes", "Comparison Matrix", "Candidate Tools / Repos", "Recommendations", "Caveats", "Source Confidence", "Open Questions", "Source References"],
+  synthesis: ["Summary", "Landscape Snapshot", "Key Patterns", "Decision Axes", "Recommended Review Path", "Caveats", "Source Confidence", "Related Comparisons", "Open Questions", "Source References"],
+  maintenance: ["Source Quality Findings", "Unsupported Items"],
+};
+
+const PERSONAL_BRAIN_STUB_CHAR_LIMIT = 600;
+const PERSONAL_BRAIN_GIANT_PAGE_BYTES = 50000;
+
 function toPosix(value) {
   return String(value || "").replace(/\\/g, "/");
 }
@@ -148,6 +176,20 @@ function extractMarkdownLinks(body) {
   return links;
 }
 
+function hasHeading(body, heading) {
+  const escaped = String(heading).replace(/[.*+?^${}()|[\]\\]/g, "\\$&");
+  return new RegExp(`^##\\s+${escaped}\\s*$`, "im").test(String(body || ""));
+}
+
+function hasSourceRefs(fields) {
+  const raw = String(fields.source_refs || "").trim();
+  return Boolean(raw && raw !== "[]" && raw !== "[\"\"]");
+}
+
+function formatPercent(value) {
+  return `${Math.round(value * 100)}%`;
+}
+
 function createFindings() {
   return Object.fromEntries(CATEGORY_DEFS.map(([key]) => [key, []]));
 }
@@ -550,7 +592,154 @@ function analyzePages(projectPath) {
 
   analyzeSourceQuality(projectPath, inputs, findings);
 
-  return { findings, pageCount: pages.length };
+  const personalBrainAnalysis = analyzePersonalBrainPages(projectPath, findings);
+
+  return {
+    findings,
+    pageCount: pages.length + personalBrainAnalysis.count,
+    personalBrainMetrics: personalBrainAnalysis.metrics,
+  };
+}
+
+function analyzePersonalBrainPages(projectPath, findings) {
+  const personalBrainRoot = path.join(getWikiWorkspacePath(projectPath), "personal-brain");
+  const pageFiles = listMarkdownPages(personalBrainRoot);
+  const pages = [];
+  const metrics = {
+    pageCount: pageFiles.length,
+    byType: {},
+    frontmatterCoverage: 0,
+    requiredSectionCoverage: 0,
+    sourceRefsCoverage: 0,
+    stubRatio: 0,
+    giantPageCount: 0,
+    brokenInternalLinks: 0,
+    conceptCount: 0,
+    entityCount: 0,
+    comparisonCount: 0,
+    synthesisCount: 0,
+    sourceEvidenceCoverage: 0,
+  };
+  let frontmatterCount = 0;
+  let sectionRequiredTotal = 0;
+  let sectionPresentTotal = 0;
+  let sourceRefsEligible = 0;
+  let sourceRefsPresent = 0;
+  let sourceEvidenceEligible = 0;
+  let sourceEvidencePresent = 0;
+  let stubCount = 0;
+
+  for (const filePath of pageFiles) {
+    const relPath = toPosix(path.relative(personalBrainRoot, filePath));
+    const parsed = parseFrontmatter(fs.readFileSync(filePath, "utf-8"));
+    const fields = parsed.fields;
+    const type = String(fields.type || "unknown");
+    pages.push({ filePath, relPath, fields, body: parsed.body, hasFrontmatter: parsed.hasFrontmatter, type });
+    metrics.byType[type] = (metrics.byType[type] || 0) + 1;
+    if (type === "concept") metrics.conceptCount += 1;
+    if (type === "tool_entity") metrics.entityCount += 1;
+    if (type === "comparison") metrics.comparisonCount += 1;
+    if (type === "synthesis") metrics.synthesisCount += 1;
+
+    if (!parsed.hasFrontmatter) {
+      appendFinding(findings, "schema", `personal-brain/${relPath} is missing parseable frontmatter.`);
+      continue;
+    }
+    frontmatterCount += 1;
+
+    const missingFields = REQUIRED_PERSONAL_BRAIN_FIELDS.filter((field) => !fields[field]);
+    if (missingFields.length > 0) {
+      appendFinding(
+        findings,
+        "schema",
+        `personal-brain/${relPath} is missing required personal-brain fields: ${missingFields.join(", ")}.`
+      );
+    }
+
+    const requiredSections = REQUIRED_PERSONAL_BRAIN_SECTIONS[type] || [];
+    sectionRequiredTotal += requiredSections.length;
+    const missingSections = requiredSections.filter((section) => !hasHeading(parsed.body, section));
+    sectionPresentTotal += requiredSections.length - missingSections.length;
+    if (missingSections.length > 0) {
+      appendFinding(
+        findings,
+        "personalBrainQuality",
+        `personal-brain/${relPath} is missing required sections for ${type}: ${missingSections.join(", ")}.`
+      );
+    }
+
+    if (!["root"].includes(type)) {
+      sourceRefsEligible += 1;
+      if (hasSourceRefs(fields)) sourceRefsPresent += 1;
+      else appendFinding(findings, "personalBrainQuality", `personal-brain/${relPath} has no source_refs coverage.`);
+    }
+
+    if (["tool_entity", "concept", "comparison", "synthesis"].includes(type)) {
+      sourceEvidenceEligible += 1;
+      if (hasSourceRefs(fields) && /(?:source|provenance|evidence)/i.test(parsed.body)) {
+        sourceEvidencePresent += 1;
+      } else {
+        appendFinding(findings, "personalBrainQuality", `personal-brain/${relPath} lacks source evidence coverage in body/frontmatter.`);
+      }
+    }
+
+    const compactBody = parsed.body.replace(/\s+/g, " ").trim();
+    if (compactBody.length < PERSONAL_BRAIN_STUB_CHAR_LIMIT && !["root"].includes(type)) {
+      stubCount += 1;
+      appendFinding(findings, "personalBrainQuality", `personal-brain/${relPath} appears stub-like (${compactBody.length} normalized characters).`);
+    }
+
+    const byteSize = fs.statSync(filePath).size;
+    if (byteSize > PERSONAL_BRAIN_GIANT_PAGE_BYTES) {
+      metrics.giantPageCount += 1;
+      appendFinding(findings, "personalBrainQuality", `personal-brain/${relPath} is very large (${byteSize} bytes) and may need splitting.`);
+    }
+  }
+
+  for (const page of pages) {
+    for (const link of extractMarkdownLinks(page.body)) {
+      const rawPath = link.split("#")[0].trim();
+      if (!rawPath) continue;
+      const resolved = path.resolve(path.dirname(page.filePath), rawPath);
+      if (!isPathInsideOrEqual(resolved, personalBrainRoot) || !fs.existsSync(resolved)) {
+        appendFinding(findings, "brokenLinks", `personal-brain/${page.relPath} links to missing ${link}.`);
+        metrics.brokenInternalLinks += 1;
+      }
+    }
+  }
+
+  metrics.frontmatterCoverage = pageFiles.length > 0 ? frontmatterCount / pageFiles.length : 1;
+  metrics.requiredSectionCoverage = sectionRequiredTotal > 0 ? sectionPresentTotal / sectionRequiredTotal : 1;
+  metrics.sourceRefsCoverage = sourceRefsEligible > 0 ? sourceRefsPresent / sourceRefsEligible : 1;
+  metrics.stubRatio = pageFiles.length > 0 ? stubCount / pageFiles.length : 0;
+  metrics.sourceEvidenceCoverage = sourceEvidenceEligible > 0 ? sourceEvidencePresent / sourceEvidenceEligible : 1;
+
+  if (pageFiles.length === 0) {
+    appendFinding(findings, "personalBrainQuality", "No personal-brain pages were found under .sdtk/wiki/personal-brain.");
+  }
+  if (metrics.frontmatterCoverage < 1) {
+    appendFinding(findings, "personalBrainQuality", `Frontmatter coverage is ${formatPercent(metrics.frontmatterCoverage)}; expected 100%.`);
+  }
+  if (metrics.requiredSectionCoverage < 0.95) {
+    appendFinding(findings, "personalBrainQuality", `Required section coverage is ${formatPercent(metrics.requiredSectionCoverage)}; expected at least 95%.`);
+  }
+  if (metrics.sourceRefsCoverage < 0.9) {
+    appendFinding(findings, "personalBrainQuality", `Source refs coverage is ${formatPercent(metrics.sourceRefsCoverage)}; expected at least 90%.`);
+  }
+  if (metrics.stubRatio > 0.1) {
+    appendFinding(findings, "personalBrainQuality", `Stub ratio is ${formatPercent(metrics.stubRatio)}; expected at most 10%.`);
+  }
+  if (metrics.entityCount > 0 && metrics.conceptCount === 0) {
+    appendFinding(findings, "personalBrainQuality", "Tool/entity pages exist but no concept pages were generated.");
+  }
+  if (metrics.conceptCount > 0 && metrics.comparisonCount === 0) {
+    appendFinding(findings, "personalBrainQuality", "Concept pages exist but no comparison pages were generated.");
+  }
+  if (metrics.comparisonCount > 0 && metrics.synthesisCount === 0) {
+    appendFinding(findings, "personalBrainQuality", "Comparison pages exist but no synthesis pages were generated.");
+  }
+
+  return { count: pageFiles.length, metrics };
 }
 
 function todayStamp() {
@@ -561,7 +750,35 @@ function totalFindings(findings) {
   return CATEGORY_DEFS.reduce((sum, [key]) => sum + findings[key].length, 0);
 }
 
-function renderReport({ projectPath, workspaceRoot, findings, pageCount }) {
+function renderPersonalBrainMetrics(metrics) {
+  if (!metrics) return ["## Personal-Brain Quality Metrics", "", "- No personal-brain metrics available.", ""];
+  const typeRows = Object.entries(metrics.byType || {})
+    .sort(([a], [b]) => a.localeCompare(b))
+    .map(([type, count]) => `| ${type} | ${count} |`);
+  return [
+    "## Personal-Brain Quality Metrics",
+    "",
+    `- personal-brain pages: ${metrics.pageCount}`,
+    `- frontmatter coverage: ${formatPercent(metrics.frontmatterCoverage)}`,
+    `- required section coverage: ${formatPercent(metrics.requiredSectionCoverage)}`,
+    `- source refs coverage: ${formatPercent(metrics.sourceRefsCoverage)}`,
+    `- source evidence coverage: ${formatPercent(metrics.sourceEvidenceCoverage)}`,
+    `- stub ratio: ${formatPercent(metrics.stubRatio)}`,
+    `- giant page warnings: ${metrics.giantPageCount}`,
+    `- broken personal-brain internal links: ${metrics.brokenInternalLinks}`,
+    `- entity pages: ${metrics.entityCount}`,
+    `- concept pages: ${metrics.conceptCount}`,
+    `- comparison pages: ${metrics.comparisonCount}`,
+    `- synthesis pages: ${metrics.synthesisCount}`,
+    "",
+    "| Page type | Count |",
+    "|---|---:|",
+    ...(typeRows.length > 0 ? typeRows : ["| none | 0 |"]),
+    "",
+  ];
+}
+
+function renderReport({ projectPath, workspaceRoot, findings, pageCount, personalBrainMetrics }) {
   const summaryRows = CATEGORY_DEFS.map(
     ([key, label]) => `| ${label} | ${findings[key].length} |`
   );
@@ -593,6 +810,7 @@ function renderReport({ projectPath, workspaceRoot, findings, pageCount }) {
     "|---|---:|",
     ...summaryRows,
     "",
+    ...renderPersonalBrainMetrics(personalBrainMetrics),
     ...detailSections,
   ].join("\n");
 }
@@ -622,12 +840,14 @@ function runWikiLint(options = {}) {
       workspaceRoot,
       findings: analysis.findings,
       pageCount: analysis.pageCount,
+      personalBrainMetrics: analysis.personalBrainMetrics,
     });
     fs.writeFileSync(reportPath, report + "\n", "utf-8");
     return {
       reportPath,
       totalFindings: totalFindings(analysis.findings),
       findings: analysis.findings,
+      personalBrainMetrics: analysis.personalBrainMetrics,
     };
   } catch (error) {
     if (error instanceof CliError) throw error;
@@ -637,6 +857,7 @@ function runWikiLint(options = {}) {
 
 module.exports = {
   CATEGORY_DEFS,
+  REQUIRED_PERSONAL_BRAIN_FIELDS,
   REQUIRED_PAGE_FIELDS,
   analyzePages,
   parseFrontmatter,

package/src/lib/wiki-search.js

@@ -126,7 +126,7 @@ function runWikiSearch({ projectPath, query, limit = DEFAULT_LIMIT }) {
   }
   if (!fs.existsSync(personalBrainPath) || !fs.statSync(personalBrainPath).isDirectory()) {
     throw new ValidationError(
-      `No SDTK-WIKI personal brain found at ${personalBrainPath}. Run extract, compile dry-run, and compile --apply --yes from the generated JSON sidecar first.`
+      `No SDTK-WIKI personal brain found at ${personalBrainPath}. Run "sdtk-wiki ingest <source-root>" and "sdtk-wiki compile --mode safe --apply" first. Advanced users can still use wiki extract/compile sidecar commands.`
     );
   }