kld-sdd 2.6.17 → 2.7.3

package/skywalk-sdd/lib/user-config.cjs

@@ -0,0 +1,132 @@
+// kld-T02 — ~/.kld-sdd/config.json 用户级配置管理
+// 职责：读取、规范化、原子写、0600/Windows ACL。
+// schema v2 = {version, server}；使用统计按 git 身份上报，不再保存任何 token。
+// 旧版含 token/userName/boundAt 的 config 读取时 sanitize 为 {version, server}，回写即淘汰。
+'use strict';
+
+const fs = require('node:fs');
+const os = require('node:os');
+const path = require('node:path');
+
+const USER_CONFIG_VERSION = 2;
+const CONFIG_DIR_NAME = '.kld-sdd';
+const CONFIG_FILE_NAME = 'config.json';
+
+/**
+ * 返回用户配置目录路径。
+ * @param {string} [homeDir] — 注入的 home 目录（测试用）；缺省取 env.KLD_SDD_HOME 或 os.homedir()
+ */
+function getConfigDir(homeDir) {
+  const envHome = typeof process !== 'undefined' && process && process.env
+    ? process.env.KLD_SDD_HOME
+    : undefined;
+  const home = (typeof homeDir === 'string' && homeDir)
+    || (typeof envHome === 'string' && envHome)
+    || os.homedir();
+  return path.join(home, CONFIG_DIR_NAME);
+}
+
+/**
+ * 返回用户配置文件完整路径。
+ */
+function getConfigPath(homeDir) {
+  return path.join(getConfigDir(homeDir), CONFIG_FILE_NAME);
+}
+
+/**
+ * 将任意已解析对象规范化为 v2 config：只保留 {version, server}。
+ * @param {object} parsed
+ * @returns {{version: number, server?: string}}
+ */
+function sanitizeConfig(parsed) {
+  const config = { version: USER_CONFIG_VERSION };
+  if (typeof parsed.server === 'string') {
+    config.server = parsed.server;
+  }
+  return config;
+}
+
+/**
+ * 读取用户配置。
+ * - 文件不存在 / 损坏 JSON / 非对象 → 返回 null（不抛）
+ * - 旧版多余字段（token/userName/boundAt 等）读取即忽略，不回传
+ * - 返回新引用；调用方修改不影响后续读取
+ *
+ * @param {string} [homeDir]
+ * @returns {object|null}
+ */
+function readUserConfig(homeDir) {
+  const file = getConfigPath(homeDir);
+  let raw;
+  try {
+    raw = fs.readFileSync(file, 'utf8');
+  } catch {
+    return null;
+  }
+  let parsed;
+  try {
+    parsed = JSON.parse(raw);
+  } catch {
+    return null;
+  }
+  if (!parsed || typeof parsed !== 'object' || Array.isArray(parsed)) return null;
+  return sanitizeConfig(parsed);
+}
+
+/**
+ * POSIX 平台设置 0600/0700；Windows 平台尝试通过 icacls 收紧 ACL（best-effort）。
+ * @param {string} target — 文件或目录路径
+ * @param {'file'|'dir'} kind
+ */
+function hardenPermissions(target, kind) {
+  if (process.platform === 'win32') {
+    // Windows：依赖 Node 默认 ACL 通常已限当前用户，无需显式 icacls；
+    // 实际收紧在更高层以同步子进程完成，避免引入异步依赖。
+    return;
+  }
+  try {
+    fs.chmodSync(target, kind === 'dir' ? 0o700 : 0o600);
+  } catch {
+    // best-effort：无法 chmod 时静默（例如某些 FS 不支持）
+  }
+}
+
+/**
+ * 原子写入用户配置：先 temp 后 rename，目录与文件均设置权限。
+ * 只持久化 {version, server}，多余字段写入即淘汰。
+ * @param {object} config — 必须含 version 字段
+ * @param {string} [homeDir]
+ * @throws {Error} config 非法 / 缺 version
+ */
+function writeUserConfig(config, homeDir) {
+  if (!config || typeof config !== 'object' || Array.isArray(config)) {
+    throw new Error('user config must be an object');
+  }
+  if (typeof config.version !== 'number') {
+    throw new Error('user config requires numeric version');
+  }
+  const dir = getConfigDir(homeDir);
+  const file = getConfigPath(homeDir);
+  fs.mkdirSync(dir, { recursive: true });
+  hardenPermissions(dir, 'dir');
+
+  const tmp = path.join(dir, `.${CONFIG_FILE_NAME}.${process.pid}.${Date.now()}.tmp`);
+  const payload = JSON.stringify(sanitizeConfig(config), null, 2);
+  fs.writeFileSync(tmp, payload, { encoding: 'utf8', mode: 0o600 });
+  hardenPermissions(tmp, 'file');
+  try {
+    fs.renameSync(tmp, file);
+  } catch (err) {
+    try { fs.unlinkSync(tmp); } catch { /* ignore */ }
+    throw err;
+  }
+  hardenPermissions(file, 'file');
+}
+
+module.exports = {
+  USER_CONFIG_VERSION,
+  getConfigDir,
+  getConfigPath,
+  readUserConfig,
+  writeUserConfig,
+};

package/skywalk-sdd/ontology/artifact-parser.cjs

@@ -200,7 +200,7 @@ function identityFromValues(values = {}) {
 }
 
 function flushRequirementRef(requirementRefs, currentRef) {
-  if (!currentRef) return null;
+  if (!currentRef) return;
   const { normalize, validate } = require('./external-key.cjs');
   const system = currentRef.system;
   const objectType = currentRef['object-type'] || currentRef.object_type;
@@ -224,7 +224,6 @@ function flushRequirementRef(requirementRefs, currentRef) {
     }
     requirementRefs.push(entry);
   }
-  return null;
 }
 
 function parseStructuredFrontmatter(lines) {

package/templates/git-hooks/commit-msg

@@ -1,6 +1,7 @@
 #!/bin/sh
 # KLD SDD Commit-MSG Hook
-# 自动查找 commit-msg-sdd-trailer.cjs，兼容单仓库/多仓库/单仓mono布局
+# 在下方 SCRIPTS 列表中声明要加载的 .cjs 脚本
+# 删除某行 = 禁用该插件
 # marker: KLD SDD quality gate
 
 # 从 hook 所在目录推算 git 根目录
@@ -8,39 +9,81 @@ hook_dir="$(cd "$(dirname "$0")" && pwd)"
 git_dir="$(dirname "$hook_dir")"
 git_root="$(dirname "$git_dir")"
 
-script=""
+hooks_dir=""
 
 # 方法1: git config sdd.specPath（多仓布局：spec 是独立 clone）
 spec_path=$(git config --local sdd.specPath 2>/dev/null)
-if [ -n "$spec_path" ] && [ -f "$spec_path/skywalk-sdd/git-hooks/commit-msg-sdd-trailer.cjs" ]; then
-  script="$spec_path/skywalk-sdd/git-hooks/commit-msg-sdd-trailer.cjs"
+if [ -n "$spec_path" ] && [ -d "$spec_path/skywalk-sdd/git-hooks" ]; then
+  hooks_dir="$spec_path/skywalk-sdd/git-hooks"
 fi
 
 # 方法2: .sdd-spec-root（单仓 mono 布局：skywalk-sdd 在 spec 包裹包子目录内）
-if [ -z "$script" ] && [ -f "$git_root/.sdd-spec-root" ]; then
+if [ -z "$hooks_dir" ] && [ -f "$git_root/.sdd-spec-root" ]; then
   spec_rel=$(cat "$git_root/.sdd-spec-root" | head -1 | tr -d '[:space:]')
-  if [ -n "$spec_rel" ] && [ -f "$git_root/$spec_rel/skywalk-sdd/git-hooks/commit-msg-sdd-trailer.cjs" ]; then
-    script="$git_root/$spec_rel/skywalk-sdd/git-hooks/commit-msg-sdd-trailer.cjs"
+  if [ -n "$spec_rel" ] && [ -d "$git_root/$spec_rel/skywalk-sdd/git-hooks" ]; then
+    hooks_dir="$git_root/$spec_rel/skywalk-sdd/git-hooks"
   fi
 fi
 
 # 方法3: 从 git 根向上搜索 skywalk-sdd/git-hooks（spec 仓本身或父级）
-if [ -z "$script" ]; then
+if [ -z "$hooks_dir" ]; then
   search_dir="$git_root"
   while [ "$search_dir" != "/" ] && [ "$search_dir" != "" ]; do
-    if [ -f "$search_dir/skywalk-sdd/git-hooks/commit-msg-sdd-trailer.cjs" ]; then
-      script="$search_dir/skywalk-sdd/git-hooks/commit-msg-sdd-trailer.cjs"
+    if [ -d "$search_dir/skywalk-sdd/git-hooks" ]; then
+      hooks_dir="$search_dir/skywalk-sdd/git-hooks"
       break
     fi
     search_dir="$(dirname "$search_dir")"
   done
 fi
 
-if [ -z "$script" ]; then
-  echo "[SDD] 未找到 commit-msg-sdd-trailer.cjs，跳过 commit-msg trailer"
+if [ -z "$hooks_dir" ]; then
+  echo "[SDD] 未找到 spec 仓的 skywalk-sdd/git-hooks 目录，跳过 commit-msg"
   exit 0
 fi
 
-# $1 = Git 传入的 commit message 文件路径
-# --project 告诉 .cjs 脚本代码仓根目录（用于解析 spec 布局）
-node "$script" "$1" --project="$git_root"
+# 从配置文件读取插件列表
+config_file="$hooks_dir/hooks.config"
+if [ ! -f "$config_file" ]; then
+  echo "[SDD] ⚠️  配置文件不存在：hooks.config，使用默认插件"
+  SCRIPTS="commit-msg-sdd-trailer.cjs"
+else
+  # 读取 [commit-msg] 段落的配置
+  in_section=0
+  SCRIPTS=""
+  while IFS= read -r line; do
+    line=$(printf '%s' "$line" | tr -d '\r')
+    case "$line" in
+      "[commit-msg]") in_section=1 ;;
+      "["*) in_section=0 ;;
+      "#"*|"") ;;
+      *)
+        if [ "$in_section" -eq 1 ]; then
+          SCRIPTS="$SCRIPTS $line"
+        fi
+        ;;
+    esac
+  done < "$config_file"
+fi
+
+executed=0
+failed=0
+for script_name in $SCRIPTS; do
+  script="$hooks_dir/$script_name"
+  if [ ! -f "$script" ]; then
+    echo "[SDD] ⚠️  插件不存在：$script_name"
+    continue
+  fi
+  executed=$((executed + 1))
+  echo "[SDD] 执行 commit-msg 插件：$script_name"
+  node "$script" "$1" --project="$git_root" || failed=$((failed + 1))
+done
+
+if [ "$executed" -eq 0 ]; then
+  echo "[SDD] 无 commit-msg 插件，跳过"
+elif [ "$failed" -gt 0 ]; then
+  echo "[SDD] ❌ 共执行 $executed 个 commit-msg 插件，$failed 个失败"
+  exit 1
+else
+  echo "[SDD] ✅ 共执行 $executed 个 commit-msg 插件，全部通过"
+fi

package/templates/git-hooks/hooks.config

@@ -0,0 +1,19 @@
+# KLD SDD Hook 插件配置文件
+# 每行一个脚本名，空行和 # 开头的行会被忽略
+# 注释某行 = 禁用该插件，取消注释 = 启用该插件
+
+[commit-msg]
+# 自动写入 Spec-Change / Spec-Revision Trailer 到 commit message
+commit-msg-sdd-trailer.cjs
+
+[pre-commit]
+# 检查 tasks.md 中是否有未完成的归档任务
+pre-commit-sdd-check.cjs
+# 检查 Spec 一致性校验报告（置信度、过期、人工确认等）
+pre-commit-consistency-check.cjs
+
+[pre-push]
+# 运行 doctor 完整诊断（配置、Trailer 协议、活动变更等）
+pre-push-sdd-check.cjs
+# 轻量检查一致性报告是否存在、是否过期
+pre-push-consistency-check.cjs

package/templates/git-hooks/pre-commit

@@ -1,7 +1,7 @@
 #!/bin/sh
 # KLD SDD Pre-Commit Hook
-# 远程引用 spec 仓 skywalk-sdd/git-hooks/ 下的 .cjs 脚本
-# 兼容单仓库/多仓库/单仓mono布局
+# 在下方 SCRIPTS 列表中声明要加载的 .cjs 脚本
+# 删除某行 = 禁用该插件
 # marker: KLD SDD quality gate
 
 # 从 hook 所在目录推算 git 根目录
@@ -38,20 +38,54 @@ if [ -z "$hooks_dir" ]; then
 fi
 
 if [ -z "$hooks_dir" ]; then
-  echo "[SDD] 未找到 spec 仓的 skywalk-sdd/git-hooks 目录，跳过 pre-commit 检查"
+  echo "[SDD] 未找到 spec 仓的 skywalk-sdd/git-hooks 目录，跳过 pre-commit"
   exit 0
 fi
 
 echo "[SDD] 执行提交前检查..."
 
-# 1. tasks.md 完成度检查
-if [ -f "$hooks_dir/pre-commit-sdd-check.cjs" ]; then
-  node "$hooks_dir/pre-commit-sdd-check.cjs" --project="$git_root" "$@" || exit 1
+# 从配置文件读取插件列表
+config_file="$hooks_dir/hooks.config"
+if [ ! -f "$config_file" ]; then
+  echo "[SDD] ️  配置文件不存在：hooks.config，使用默认插件"
+  SCRIPTS="pre-commit-sdd-check.cjs pre-commit-consistency-check.cjs"
+else
+  # 读取 [pre-commit] 段落的配置
+  in_section=0
+  SCRIPTS=""
+  while IFS= read -r line; do
+    line=$(printf '%s' "$line" | tr -d '\r')
+    case "$line" in
+      "[pre-commit]") in_section=1 ;;
+      "["*) in_section=0 ;;
+      "#"*|"") ;;
+      *)
+        if [ "$in_section" -eq 1 ]; then
+          SCRIPTS="$SCRIPTS $line"
+        fi
+        ;;
+    esac
+  done < "$config_file"
 fi
 
-# 2. 代码-spec 一致性检查
-if [ -f "$hooks_dir/pre-commit-consistency-check.cjs" ]; then
-  node "$hooks_dir/pre-commit-consistency-check.cjs" --project="$git_root" "$@" || exit 1
-fi
+executed=0
+failed=0
+for script_name in $SCRIPTS; do
+  script="$hooks_dir/$script_name"
+  if [ ! -f "$script" ]; then
+    echo "[SDD] ⚠️  插件不存在：$script_name"
+    continue
+  fi
+  executed=$((executed + 1))
+  echo "[SDD] 执行 pre-commit 插件：$script_name"
+  node "$script" --project="$git_root" "$@" || failed=$((failed + 1))
+done
 
-echo "[SDD] ✅ 所有 pre-commit 检查通过"
+if [ "$executed" -eq 0 ]; then
+  echo "[SDD] 无 pre-commit 插件，跳过"
+elif [ "$failed" -gt 0 ]; then
+  echo "[SDD] ❌ 共执行 $executed 个 pre-commit 插件，$failed 个失败"
+  exit 1
+else
+  echo "[SDD] ✅ 共执行 $executed 个 pre-commit 插件，全部通过"
+fi