pi-shepherd 0.1.2 → 0.2.0

package/shepherd/rules-tool-helpers.ts

@@ -1,120 +1,119 @@
-/**
- * Shepherd 规则工具辅助函数
- *
- * scope 路径推导、合并列表、跨 scope 去重检测。
- */
-
-import * as path from "node:path";
-import * as fs from "node:fs";
-import { listRules } from "./rules-editor";
-import { findDuplicateBySignature } from "./rules-editor";
-
-/** 项目级规则文件名 */
-const PROJECT_RULES_FILE = "shepherd-rules.json";
-
-export type Scope = "global" | "project";
-
-/** 根据 scope 推导规则文件路径 */
-export function getRulesFilePath(
-	scope: Scope | undefined,
-	globalDir: string,
-	cwd: string,
-): string {
-	if (scope === "project") {
-		return path.join(cwd, ".pi", "extensions", PROJECT_RULES_FILE);
-	}
-	// 默认 global
-	return path.join(globalDir, "rules.json");
-}
-
-export interface ListRuleItem {
-	index: number;
-	comment: string;
-	scope: Scope;
-	enabled?: boolean;
-	action?: string;
-	tool?: string;
-	hook?: string;
-	[key: string]: unknown;
-}
-
-/**
- * 按_scope 列出规则。scope 不传时返回全局+项目合并列表。
- */
-export function listRulesByScope(
-	globalDir: string,
-	cwd: string,
-	scope?: Scope,
-): ListRuleItem[] {
-	const results: ListRuleItem[] = [];
-
-	if (!scope || scope === "global") {
-		const globalPath = path.join(globalDir, "rules.json");
-		if (fs.existsSync(globalPath)) {
-			const r = listRules(globalPath);
-			if (!r.error && r.rules) {
-				for (const rule of r.rules) {
-					results.push({ ...rule, scope: "global" });
-				}
-			}
-		}
-	}
-
-	if (!scope || scope === "project") {
-		const projectPath = path.join(cwd, ".pi", "extensions", PROJECT_RULES_FILE);
-		if (fs.existsSync(projectPath)) {
-			const r = listRules(projectPath);
-			if (!r.error && r.rules) {
-				for (const rule of r.rules) {
-					results.push({ ...rule, scope: "project" });
-				}
-			}
-		}
-	}
-
-	return results;
-}
-
-/**
- * 跨 scope 去重检测：写入 A scope 时检查 B scope 是否有签名相同的规则。
- * 返回 warning 字符串或 null。
- */
-export function checkCrossScopeDuplicate(
-	targetScope: Scope,
-	globalDir: string,
-	cwd: string,
-	newRule: Record<string, unknown>,
-): string | null {
-	const otherScope: Scope = targetScope === "global" ? "project" : "global";
-	const otherPath = getRulesFilePath(otherScope, globalDir, cwd);
-
-	if (!fs.existsSync(otherPath)) return null;
-
-	const content = fs.readFileSync(otherPath, "utf-8");
-	let rules: Record<string, unknown>[];
-	try {
-		const parsed = JSON.parse(content);
-		if (!Array.isArray(parsed)) return null;
-		rules = parsed;
-	} catch {
-		return null;
-	}
-
-	const dupIdx = findDuplicateBySignature(rules, newRule);
-	if (dupIdx !== null) {
-		const scopeLabel = otherScope === "global" ? "全局" : "项目级";
-		return `⚠ ${scopeLabel}已有相似规则 [${otherScope}:${dupIdx}]`;
-	}
-
-	return null;
-}
-
-/**
- * 确保项目级规则文件的目录存在
- */
-export function ensureProjectDir(cwd: string): void {
-	const dir = path.join(cwd, ".pi", "extensions");
-	if (!fs.existsSync(dir)) {
-		fs.mkdirSync(dir, { recursive: true });
-	}
-}
+/**
+ * Shepherd 规则工具辅助函数
+ *
+ * scope 路径推导、合并列表、跨 scope 去重检测。
+ */
+
+import * as fs from "node:fs";
+import * as path from "node:path";
+import { findDuplicateBySignature, listRules } from "./rules-editor";
+
+/** 项目级规则文件名 */
+const PROJECT_RULES_FILE = "shepherd-rules.json";
+
+export type Scope = "global" | "project";
+
+/** 根据 scope 推导规则文件路径 */
+export function getRulesFilePath(
+	scope: Scope | undefined,
+	globalDir: string,
+	cwd: string,
+): string {
+	if (scope === "project") {
+		return path.join(cwd, ".pi", "extensions", PROJECT_RULES_FILE);
+	}
+	// 默认 global
+	return path.join(globalDir, "rules.json");
+}
+
+export interface ListRuleItem {
+	index: number;
+	comment: string;
+	scope: Scope;
+	enabled?: boolean;
+	action?: string;
+	tool?: string;
+	hook?: string;
+	[key: string]: unknown;
+}
+
+/**
+ * 按_scope 列出规则。scope 不传时返回全局+项目合并列表。
+ */
+export function listRulesByScope(
+	globalDir: string,
+	cwd: string,
+	scope?: Scope,
+): ListRuleItem[] {
+	const results: ListRuleItem[] = [];
+
+	if (!scope || scope === "global") {
+		const globalPath = path.join(globalDir, "rules.json");
+		if (fs.existsSync(globalPath)) {
+			const r = listRules(globalPath);
+			if (!r.error && r.rules) {
+				for (const rule of r.rules) {
+					results.push({ ...rule, scope: "global" });
+				}
+			}
+		}
+	}
+
+	if (!scope || scope === "project") {
+		const projectPath = path.join(cwd, ".pi", "extensions", PROJECT_RULES_FILE);
+		if (fs.existsSync(projectPath)) {
+			const r = listRules(projectPath);
+			if (!r.error && r.rules) {
+				for (const rule of r.rules) {
+					results.push({ ...rule, scope: "project" });
+				}
+			}
+		}
+	}
+
+	return results;
+}
+
+/**
+ * 跨 scope 去重检测：写入 A scope 时检查 B scope 是否有签名相同的规则。
+ * 返回 warning 字符串或 null。
+ */
+export function checkCrossScopeDuplicate(
+	targetScope: Scope,
+	globalDir: string,
+	cwd: string,
+	newRule: Record<string, unknown>,
+): string | null {
+	const otherScope: Scope = targetScope === "global" ? "project" : "global";
+	const otherPath = getRulesFilePath(otherScope, globalDir, cwd);
+
+	if (!fs.existsSync(otherPath)) return null;
+
+	const content = fs.readFileSync(otherPath, "utf-8");
+	let rules: Record<string, unknown>[];
+	try {
+		const parsed = JSON.parse(content);
+		if (!Array.isArray(parsed)) return null;
+		rules = parsed;
+	} catch {
+		return null;
+	}
+
+	const dupIdx = findDuplicateBySignature(rules, newRule);
+	if (dupIdx !== null) {
+		const scopeLabel = otherScope === "global" ? "全局" : "项目级";
+		return `⚠ ${scopeLabel}已有相似规则 [${otherScope}:${dupIdx}]`;
+	}
+
+	return null;
+}
+
+/**
+ * 确保项目级规则文件的目录存在
+ */
+export function ensureProjectDir(cwd: string): void {
+	const dir = path.join(cwd, ".pi", "extensions");
+	if (!fs.existsSync(dir)) {
+		fs.mkdirSync(dir, { recursive: true });
+	}
+}

package/shepherd/rules-tool-list.ts

@@ -1,126 +1,124 @@
-/**
- * Shepherd 规则工具 — list 输出格式化
- *
- * 处理 list 的两种输出模式：摘要模式和 verbose（完整 JSON）模式。
- */
-
-import {
-	getRuleDetail,
-	listRules,
-	listRulesDetail,
-} from "./rules-editor";
-import {
-	type Scope,
-	getRulesFilePath,
-	listRulesByScope,
-} from "./rules-tool-helpers";
-
-/** 构造 pi 工具 execute 的标准返回格式 */
-export function textResult(text: string) {
-	return { content: [{ type: "text" as const, text }] };
-}
-
-export const scopeLabel = (s: Scope) => (s === "global" ? "全局" : "项目级");
-
-/** 按编号查看单条规则的完整 JSON */
-export function handleListByIndex(
-	scope: Scope | undefined,
-	index: number,
-	rulesDir: string,
-	effectiveCwd: string,
-) {
-	const effectiveScope = scope || "global";
-	const filePath = getRulesFilePath(effectiveScope, rulesDir, effectiveCwd);
-	const detail = getRuleDetail(filePath, index);
-	if ("error" in detail) return textResult(`❌ ${detail.error}`);
-	const { index: _, ...ruleData } = detail;
-	return textResult(
-		`📋 规则 [${effectiveScope}:${index}] 完整内容:\n${JSON.stringify(ruleData, null, "\t")}`,
-	);
-}
-
-/** verbose 模式：显示每条规则的完整 JSON */
-export function handleListVerbose(
-	scope: Scope | undefined,
-	rulesDir: string,
-	effectiveCwd: string,
-) {
-	if (!scope) {
-		// 全部 scope
-		const parts: string[] = [];
-		const globalPath = getRulesFilePath("global", rulesDir, effectiveCwd);
-		const projectPath = getRulesFilePath("project", rulesDir, effectiveCwd);
-
-		const gResult = listRulesDetail(globalPath);
-		if (gResult.rules.length > 0) {
-			parts.push("── 全局规则 ──");
-			for (const r of gResult.rules) {
-				const { index: _, ...data } = r;
-				parts.push(`[global:${r.index}] ${JSON.stringify(data, null, "\t")}`);
-			}
-		}
-		const pResult = listRulesDetail(projectPath);
-		if (pResult.rules.length > 0) {
-			parts.push("── 项目级规则 ──");
-			for (const r of pResult.rules) {
-				const { index: _, ...data } = r;
-				parts.push(`[project:${r.index}] ${JSON.stringify(data, null, "\t")}`);
-			}
-		}
-		if (parts.length === 0) return textResult("暂无规则（全局和项目级均为空）。");
-		return textResult(parts.join("\n\n"));
-	}
-	// 指定 scope
-	const filePath = getRulesFilePath(scope, rulesDir, effectiveCwd);
-	const result = listRulesDetail(filePath);
-	if (result.error) return textResult(`❌ ${result.error}`);
-	if (result.count === 0) return textResult(`暂无${scopeLabel(scope)}规则。`);
-	return textResult(
-		result.rules
-			.map((r) => {
-				const { index: _, ...data } = r;
-				return `[${scope}:${r.index}] ${JSON.stringify(data, null, "\t")}`;
-			})
-			.join("\n\n"),
-	);
-}
-
-/** 摘要模式：一行一条，只显示 comment + action + tool + hook */
-export function handleListSummary(
-	scope: Scope | undefined,
-	rulesDir: string,
-	effectiveCwd: string,
-) {
-	if (!scope) {
-		const items = listRulesByScope(rulesDir, effectiveCwd);
-		if (items.length === 0) return textResult("暂无规则（全局和项目级均为空）。");
-		return textResult(
-			items
-				.map(
-					(r) =>
-						`[${r.scope}:${r.index}] ${r.comment}` +
-						(r.enabled === false ? " (disabled)" : "") +
-						(r.action ? ` — ${r.action}` : "") +
-						(r.tool ? ` on ${r.tool}` : "") +
-						(r.hook ? ` @ ${r.hook}` : ""),
-				)
-				.join("\n"),
-		);
-	}
-	const filePath = getRulesFilePath(scope, rulesDir, effectiveCwd);
-	const result = listRules(filePath);
-	if (result.error) return textResult(`❌ ${result.error}`);
-	if (result.count === 0) return textResult(`暂无${scopeLabel(scope)}规则。`);
-	return textResult(
-		result.rules
-			.map(
-				(r) =>
-					`[${scope}:${r.index}] ${r.comment}` +
-					(r.enabled === false ? " (disabled)" : "") +
-					(r.action ? ` — ${r.action}` : "") +
-					(r.tool ? ` on ${r.tool}` : "") +
-					(r.hook ? ` @ ${r.hook}` : ""),
-			)
-			.join("\n"),
-	);
-}
+/**
+ * Shepherd 规则工具 — list 输出格式化
+ *
+ * 处理 list 的两种输出模式：摘要模式和 verbose（完整 JSON）模式。
+ */
+
+import { getRuleDetail, listRules, listRulesDetail } from "./rules-editor";
+import {
+	getRulesFilePath,
+	listRulesByScope,
+	type Scope,
+} from "./rules-tool-helpers";
+
+/** 构造 pi 工具 execute 的标准返回格式 */
+export function textResult(text: string) {
+	return { content: [{ type: "text" as const, text }] };
+}
+
+export const scopeLabel = (s: Scope) => (s === "global" ? "全局" : "项目级");
+
+/** 按编号查看单条规则的完整 JSON */
+export function handleListByIndex(
+	scope: Scope | undefined,
+	index: number,
+	rulesDir: string,
+	effectiveCwd: string,
+) {
+	const effectiveScope = scope || "global";
+	const filePath = getRulesFilePath(effectiveScope, rulesDir, effectiveCwd);
+	const detail = getRuleDetail(filePath, index);
+	if ("error" in detail) return textResult(`❌ ${detail.error}`);
+	const { index: _, ...ruleData } = detail;
+	return textResult(
+		`📋 规则 [${effectiveScope}:${index}] 完整内容:\n${JSON.stringify(ruleData, null, "\t")}`,
+	);
+}
+
+/** verbose 模式：显示每条规则的完整 JSON */
+export function handleListVerbose(
+	scope: Scope | undefined,
+	rulesDir: string,
+	effectiveCwd: string,
+) {
+	if (!scope) {
+		// 全部 scope
+		const parts: string[] = [];
+		const globalPath = getRulesFilePath("global", rulesDir, effectiveCwd);
+		const projectPath = getRulesFilePath("project", rulesDir, effectiveCwd);
+
+		const gResult = listRulesDetail(globalPath);
+		if (gResult.rules.length > 0) {
+			parts.push("── 全局规则 ──");
+			for (const r of gResult.rules) {
+				const { index: _, ...data } = r;
+				parts.push(`[global:${r.index}] ${JSON.stringify(data, null, "\t")}`);
+			}
+		}
+		const pResult = listRulesDetail(projectPath);
+		if (pResult.rules.length > 0) {
+			parts.push("── 项目级规则 ──");
+			for (const r of pResult.rules) {
+				const { index: _, ...data } = r;
+				parts.push(`[project:${r.index}] ${JSON.stringify(data, null, "\t")}`);
+			}
+		}
+		if (parts.length === 0)
+			return textResult("暂无规则（全局和项目级均为空）。");
+		return textResult(parts.join("\n\n"));
+	}
+	// 指定 scope
+	const filePath = getRulesFilePath(scope, rulesDir, effectiveCwd);
+	const result = listRulesDetail(filePath);
+	if (result.error) return textResult(`❌ ${result.error}`);
+	if (result.count === 0) return textResult(`暂无${scopeLabel(scope)}规则。`);
+	return textResult(
+		result.rules
+			.map((r) => {
+				const { index: _, ...data } = r;
+				return `[${scope}:${r.index}] ${JSON.stringify(data, null, "\t")}`;
+			})
+			.join("\n\n"),
+	);
+}
+
+/** 摘要模式：一行一条，只显示 comment + action + tool + hook */
+export function handleListSummary(
+	scope: Scope | undefined,
+	rulesDir: string,
+	effectiveCwd: string,
+) {
+	if (!scope) {
+		const items = listRulesByScope(rulesDir, effectiveCwd);
+		if (items.length === 0)
+			return textResult("暂无规则（全局和项目级均为空）。");
+		return textResult(
+			items
+				.map(
+					(r) =>
+						`[${r.scope}:${r.index}] ${r.comment}` +
+						(r.enabled === false ? " (disabled)" : "") +
+						(r.action ? ` — ${r.action}` : "") +
+						(r.tool ? ` on ${r.tool}` : "") +
+						(r.hook ? ` @ ${r.hook}` : ""),
+				)
+				.join("\n"),
+		);
+	}
+	const filePath = getRulesFilePath(scope, rulesDir, effectiveCwd);
+	const result = listRules(filePath);
+	if (result.error) return textResult(`❌ ${result.error}`);
+	if (result.count === 0) return textResult(`暂无${scopeLabel(scope)}规则。`);
+	return textResult(
+		result.rules
+			.map(
+				(r) =>
+					`[${scope}:${r.index}] ${r.comment}` +
+					(r.enabled === false ? " (disabled)" : "") +
+					(r.action ? ` — ${r.action}` : "") +
+					(r.tool ? ` on ${r.tool}` : "") +
+					(r.hook ? ` @ ${r.hook}` : ""),
+			)
+			.join("\n"),
+	);
+}