kld-sdd 2.6.13 → 2.6.15

package/skywalk-sdd/reporting/change-report-markdown.cjs

@@ -0,0 +1,294 @@
+'use strict';
+
+const { buildChangeReportViewModel } = require('./change-report-view-model.cjs');
+
+function formatValue(value) {
+  if (value == null || value === '') return '暂无数据';
+  return String(value);
+}
+
+function formatRatioToPercent(ratio) {
+  if (ratio == null || !Number.isFinite(Number(ratio))) return '暂无数据';
+  return `${(Number(ratio) * 100).toFixed(1)}%`;
+}
+
+function renderSectionOverview(section, report) {
+  const minSet = report.minimum_metric_set || {};
+  const lines = [
+    '## 一句话结论',
+    '',
+    `> ${section.summary}`,
+    '',
+    `## ${section.title}`,
+    '',
+    '### 摘要卡片',
+  ];
+  for (const card of section.cards || []) {
+    lines.push(`- ${card.label}：${formatValue(card.value)}`);
+  }
+  if (report.scheme_compliance?.counts) {
+    lines.push(
+      `- 方案覆盖：${report.scheme_compliance.counts.implemented ?? 0}/${report.scheme_compliance.items?.length ?? 0} 项已完整实现`,
+    );
+  }
+  lines.push(
+    '',
+    '### 关键指标可信覆盖',
+    `- 数值覆盖：${formatRatioToPercent(minSet.numeric_coverage_rate)}（${minSet.numeric_available ?? 0}/${minSet.numeric_total ?? 5}）`,
+    `- 可信覆盖：${formatRatioToPercent(minSet.trusted_coverage_rate)}（${minSet.trusted_available ?? 0}/${minSet.numeric_total ?? 5}；临时 ${minSet.provisional ?? 0} 项）`,
+    '',
+    '## 核心指标',
+    `- 每个场景平均用时（E1）：见「指标与阶段」`,
+    `- 规约检查得分（Q3）：见「指标与阶段」`,
+    `- 编码前是否先检查（P4）：见「指标与阶段」`,
+  );
+  return lines;
+}
+
+function renderSectionMetrics(section, report) {
+  const tdd = section.tdd_pairs || {};
+  const reasons = report.metrics?.process?.rework_summary?.reasons;
+  const lines = [
+    `## ${section.title}`,
+    '',
+    section.summary,
+    '',
+    '### 关键指标',
+  ];
+  for (const metric of section.metric_cards || []) {
+    lines.push(`- ${metric.name}（${metric.code}）：${metric.value} · ${metric.state}`);
+  }
+  if (reasons?.by_category) {
+    const parts = Object.entries(reasons.by_category)
+      .map(([k, v]) => `${k}=${v}`)
+      .join(', ');
+    lines.push(`- 重复执行原因分布：${parts || '无'}`);
+  }
+  lines.push(
+    '',
+    '### TDD 对',
+    `- 完整度：${tdd.complete == null || tdd.required == null ? '暂无数据' : `${tdd.complete}/${tdd.required}`}`,
+  );
+  const incomplete = (tdd.pairs || []).filter(pair => pair.status && pair.status !== 'complete');
+  if (incomplete.length > 0) {
+    lines.push('- 缺口：');
+    for (const pair of incomplete) {
+      lines.push(`  - ${pair.pair_id}：${pair.status}`);
+    }
+  }
+  const stages = section.stages || [];
+  lines.push('', '### 阶段时间线');
+  if (stages.length === 0) {
+    lines.push('- 无阶段节点');
+  } else {
+    for (const node of stages.slice(0, 40)) {
+      lines.push(
+        `- ${node.display_stage} R${node.display_round}：${node.display_result}`
+          + `（${node.display_duration}）`,
+      );
+    }
+  }
+  return lines;
+}
+
+function renderSectionIssues(section, report) {
+  const lines = [
+    `## ${section.title}`,
+    '',
+    section.summary,
+    '',
+  ];
+  const audit = section.task_evidence_audit || {};
+  if (audit.direct_test_backlink || audit.strict_test_coverage) {
+    lines.push('### 任务证据四口径');
+    lines.push(
+      `- 文档完成：${formatValue(audit.document_completion?.completed)}/${formatValue(audit.document_completion?.total)}`,
+    );
+    lines.push(
+      `- 直接回链：${formatValue(audit.direct_test_backlink?.verified)}/${formatValue(audit.direct_test_backlink?.total)}`,
+    );
+    lines.push(
+      `- 严格覆盖：${formatValue(audit.strict_test_coverage?.verified)}/${formatValue(audit.strict_test_coverage?.total)}`,
+    );
+    lines.push('');
+  }
+  lines.push('### 问题类别');
+  const categories = section.categories || [];
+  if (categories.length === 0) {
+    lines.push('- 当前没有归并后的问题类别。');
+  } else {
+    for (const group of categories) {
+      lines.push(
+        `- ${group.label || group.code}：命中 ${group.occurrence_count || 0} 次，关联任务 ${(group.affected_tasks || []).length} 个`,
+      );
+    }
+  }
+  const findings = section.apply_findings || [];
+  const issues = section.issues || [];
+  if (issues.length > 0) {
+    lines.push('', '### 问题明细');
+    for (const issue of issues) {
+      lines.push(
+        `- [${issue.code}] ${issue.subject || '本次变更'} · 状态：${issue.status} · 判定：${issue.verdict}`,
+        `  - 根因：${issue.root_cause}`,
+        `  - 预期：${issue.expected}`,
+        `  - 实际：${issue.actual}`,
+        `  - 影响：${issue.impact}`,
+        `  - 修复建议：${issue.remediation}`,
+        `  - 证据事件：${(issue.evidence_event_ids || []).join(', ') || '暂无可定位事件'}`,
+      );
+    }
+  } else if (findings.length > 0) {
+    lines.push('', '### 审计发现');
+    for (const finding of findings) {
+      lines.push(`- [${finding.code}] ${finding.task_id || '变更'}：${finding.message || ''}`);
+    }
+  }
+  const dispositions = section.warning_dispositions
+    || section.report_warning_dispositions
+    || [];
+  if (dispositions.length > 0) {
+    lines.push('', '### 告警处置');
+    for (const item of dispositions) {
+      lines.push(`- [告警处置] ${item.warning || item.code || 'UNKNOWN'}：${item.disposition || 'open'}`);
+    }
+  }
+
+  const known = report.known_risks || {};
+  lines.push('', '### 已知风险');
+  lines.push(`- 数据可用：${known._available ? '是' : '否'}`);
+  lines.push(
+    `- 严重问题数：${known._available ? (known.severe_issues?.length ?? 0) : '无数据'}`,
+  );
+  if (Array.isArray(known.warnings) && known.warnings.length > 0) {
+    for (const warning of known.warnings) {
+      const items = Array.isArray(warning.items) ? warning.items : null;
+      const count = items ? items.length : (warning.warnings || 0);
+      const statusLabel = warning.resolved === true ? '✅已修复' : '⏳待确认';
+      lines.push(`- 警告：${warning.command || 'check'} 阶段 ${count} 个${statusLabel}`);
+      if (items && items.length > 0) {
+        for (const item of items) {
+          lines.push(
+            `  - ${item.description || '待确认项'}${item.target ? `（${item.target}）` : ''}`,
+          );
+        }
+      }
+    }
+  } else {
+    lines.push('- 无警告（无需修复）');
+  }
+
+  const notes = report.process_notes || {};
+  lines.push('', '## 过程记录');
+  lines.push(`- 数据可用：${notes._available ? '是' : '否'}`);
+  lines.push(`- 过程事件总数：${notes.total ?? 'null'}`);
+  if (notes.by_kind) {
+    lines.push(`- 按 kind 分布：${JSON.stringify(notes.by_kind)}`);
+  }
+  if (Array.isArray(notes.notes) && notes.notes.length > 0) {
+    for (const note of notes.notes) {
+      lines.push(
+        `- [${note.stage || 'unknown'}] ${note.kind || 'note'}${note.round ? ` R${note.round}` : ''}：${note.summary || ''}${note.target ? ` → ${note.target}` : ''}`,
+      );
+    }
+  } else {
+    lines.push('- 无过程事件');
+  }
+  return lines;
+}
+
+function renderSectionArtifacts(section, report) {
+  const changed = section.changed_files || {};
+  const rawChanged = report.changed_files || {};
+  const archive = report.archive_result || null;
+  const taskCompletion = archive?.task_completion || null;
+  const lines = [
+    `## ${section.title}`,
+    '',
+    section.summary,
+    '',
+    '### 变更文件',
+    `- 数据可用：${rawChanged._available ? '是' : '否'}`,
+    `- 最终变更文件数：${formatValue(changed.files_changed)}`,
+    `- 新增行数：${formatValue(changed.added_lines)}`,
+    `- 对账状态：${formatValue(changed.reconciliation_status)}`,
+  ];
+  if ((changed.only_in_task_events || []).length > 0) {
+    lines.push(`- 仅任务事件：${changed.only_in_task_events.join(', ')}`);
+  }
+  if ((changed.only_in_final_output || []).length > 0) {
+    lines.push(`- 仅最终输出：${changed.only_in_final_output.join(', ')}`);
+  }
+  lines.push('', '### 产物清单');
+  const artifacts = section.artifacts || [];
+  if (artifacts.length === 0) {
+    lines.push('- 暂无产物条目');
+  } else {
+    for (const item of artifacts) {
+      const size = item.size_display
+        || '—';
+      lines.push(
+        `- ${item.name}：${item.exists ? '已生成' : '未生成'} · ${item.path || '—'} · ${size}`,
+      );
+    }
+  }
+  const copied = report.artifacts?.copied_specs;
+  lines.push(
+    `- 迁移文件数：${Array.isArray(copied) ? copied.length : 'null'}`,
+  );
+  lines.push(
+    '',
+    '### 归因审计',
+    `- 显式关联历史事件：${section.attribution_summary?.linked_source_event_count ?? 0}`,
+    `- 有效关联：${section.attribution_summary?.active_link_count ?? 0}`,
+    `- 未归属候选：${section.attribution_summary?.unassigned_candidate_count ?? 0}`,
+    `- 被拒绝的跨变更碰撞：${section.attribution_summary?.rejected_collision_count ?? 0}`,
+    '',
+    '### 归档结果',
+    `- 归档原因：${archive?.reason || 'null'}`,
+    `- 归档方式：${archive?.method || 'null'}`,
+    `- 归档目录：${archive?.archive_path || report.artifacts?.archive_path || 'null'}`,
+    `- 归档清单：${archive?.manifest_path || report.artifacts?.manifest_path || 'null'}`,
+    `- 最终报告：${archive?.report_path || 'null'}`,
+    `- 主任务完成：${taskCompletion?.primary_tasks
+      ? `${taskCompletion.primary_tasks.completed}/${taskCompletion.primary_tasks.total}`
+      : 'null'}`,
+    `- 全部 checkbox 完成：${taskCompletion?.completed ?? 'null'}/${taskCompletion?.total ?? 'null'}（含验收子项；分母≠主任务数）`,
+    `- 未勾选 checkbox：${taskCompletion?.incomplete ?? 'null'}`,
+    `- 未勾选任务项：${taskCompletion?.incomplete ?? 'null'}`,
+  );
+  return lines;
+}
+
+function renderChangeReportMarkdown(report) {
+  const view = buildChangeReportViewModel(report);
+  const projectLabel = report.project_root
+    ? String(report.project_root).replace(/[\\/]+$/, '').split(/[\\/]/).pop()
+    : null;
+  const lines = [
+    `# SDD 效果度量报告${view.change ? ` - ${view.change}` : ''}`,
+    '',
+    `- 生成时间：${report.generated_at || '未知'}`,
+    ...(projectLabel ? [`- 项目路径：${projectLabel}`] : []),
+    `- 统计范围：change/${view.change || 'unknown'}`,
+    `- 报告 Schema：${view.schema_version || 'unknown'}（指标契约 ${view.metrics_contract || 'unknown'}）`,
+    `<!-- sdd-semantic-digest:${view.semantic_digest} -->`,
+    '',
+  ];
+
+  for (const sectionId of view.section_order) {
+    const section = view.sections[sectionId];
+    if (!section) continue;
+    if (sectionId === 'overview') lines.push(...renderSectionOverview(section, report));
+    else if (sectionId === 'metrics-stages') lines.push(...renderSectionMetrics(section, report));
+    else if (sectionId === 'issues-evidence') lines.push(...renderSectionIssues(section, report));
+    else if (sectionId === 'artifacts-trace') lines.push(...renderSectionArtifacts(section, report));
+    lines.push('');
+  }
+
+  return lines.join('\n');
+}
+
+module.exports = {
+  renderChangeReportMarkdown,
+};