clawt 2.12.1 → 2.14.0

package/src/utils/config-strategy.ts

@@ -0,0 +1,196 @@
+import chalk from 'chalk';
+import Enquirer from 'enquirer';
+import { DEFAULT_CONFIG, CONFIG_DEFINITIONS, MESSAGES } from '../constants/index.js';
+import type { ClawtConfig } from '../types/index.js';
+
+/**
+ * 校验 key 是否为有效的配置项名称
+ * @param {string} key - 待校验的配置项名称
+ * @returns {boolean} 是否有效
+ */
+export function isValidConfigKey(key: string): key is keyof ClawtConfig {
+  return key in DEFAULT_CONFIG;
+}
+
+/**
+ * 获取所有有效配置项名称列表
+ * @returns {string[]} 配置项名称数组
+ */
+export function getValidConfigKeys(): string[] {
+  return Object.keys(DEFAULT_CONFIG);
+}
+
+/**
+ * 将字符串值解析并校验为目标配置项的正确类型
+ *
+ * 策略分发规则：
+ * - boolean → 解析 'true'/'false'
+ * - number → Number() 解析
+ * - string + 有 allowedValues → 枚举校验
+ * - string + 无 allowedValues → 无额外校验
+ *
+ * @param {keyof ClawtConfig} key - 配置项名称
+ * @param {string} rawValue - 原始字符串值
+ * @returns {{ success: true; value: ClawtConfig[keyof ClawtConfig] } | { success: false; error: string }} 解析结果
+ */
+export function parseConfigValue(
+  key: keyof ClawtConfig,
+  rawValue: string,
+): { success: true; value: ClawtConfig[keyof ClawtConfig] } | { success: false; error: string } {
+  const expectedType = typeof DEFAULT_CONFIG[key];
+
+  // 布尔类型策略
+  if (expectedType === 'boolean') {
+    if (rawValue === 'true') return { success: true, value: true };
+    if (rawValue === 'false') return { success: true, value: false };
+    return { success: false, error: MESSAGES.CONFIG_INVALID_BOOLEAN(key) };
+  }
+
+  // 数字类型策略
+  if (expectedType === 'number') {
+    const num = Number(rawValue);
+    if (Number.isNaN(num)) {
+      return { success: false, error: MESSAGES.CONFIG_INVALID_NUMBER(key) };
+    }
+    return { success: true, value: num };
+  }
+
+  // 字符串类型：根据 allowedValues 自动选择校验策略
+  const definition = CONFIG_DEFINITIONS[key];
+  if (definition.allowedValues && !definition.allowedValues.includes(rawValue)) {
+    return { success: false, error: MESSAGES.CONFIG_INVALID_ENUM(key, definition.allowedValues) };
+  }
+
+  return { success: true, value: rawValue };
+}
+
+/**
+ * 交互式提示用户输入配置值
+ *
+ * 策略分发规则：
+ * - boolean → Select(true, false)
+ * - number → Input(带数字校验)
+ * - string + 有 allowedValues → Select(枚举列表)
+ * - string + 无 allowedValues → Input(自由输入)
+ *
+ * @param {keyof ClawtConfig} key - 配置项名称
+ * @param {ClawtConfig[keyof ClawtConfig]} currentValue - 当前值
+ * @returns {Promise<ClawtConfig[keyof ClawtConfig]>} 用户输入/选择的新值
+ */
+export async function promptConfigValue(
+  key: keyof ClawtConfig,
+  currentValue: ClawtConfig[keyof ClawtConfig],
+): Promise<ClawtConfig[keyof ClawtConfig]> {
+  const expectedType = typeof currentValue;
+
+  // 布尔类型策略
+  if (expectedType === 'boolean') {
+    return promptBooleanValue(key, currentValue as boolean);
+  }
+
+  // 数字类型策略
+  if (expectedType === 'number') {
+    return promptNumberValue(key, currentValue as number);
+  }
+
+  // 字符串类型：根据 allowedValues 自动选择提示策略
+  const definition = CONFIG_DEFINITIONS[key];
+  if (definition.allowedValues) {
+    return promptEnumValue(key, currentValue as string, definition.allowedValues);
+  }
+
+  return promptStringValue(key, currentValue as string);
+}
+
+/**
+ * 格式化配置值的显示样式
+ * @param {ClawtConfig[keyof ClawtConfig]} value - 配置值
+ * @returns {string} 格式化后的字符串
+ */
+export function formatConfigValue(value: ClawtConfig[keyof ClawtConfig]): string {
+  if (typeof value === 'boolean') {
+    return value ? chalk.green('true') : chalk.yellow('false');
+  }
+  return chalk.cyan(String(value));
+}
+
+/**
+ * 交互式布尔值选择（内部辅助函数）
+ * @param {keyof ClawtConfig} key - 配置项名称
+ * @param {boolean} currentValue - 当前值
+ * @returns {Promise<boolean>} 用户选择的布尔值
+ */
+async function promptBooleanValue(key: keyof ClawtConfig, currentValue: boolean): Promise<boolean> {
+  const choices = [
+    { name: 'true', message: 'true' },
+    { name: 'false', message: 'false' },
+  ];
+
+  // @ts-expect-error enquirer 类型声明未导出 Select 类，但运行时存在
+  const selected: string = await new Enquirer.Select({
+    message: MESSAGES.CONFIG_INPUT_PROMPT(key),
+    choices,
+    initial: currentValue ? 0 : 1,
+  }).run();
+
+  return selected === 'true';
+}
+
+/**
+ * 交互式数字输入（内部辅助函数）
+ * @param {keyof ClawtConfig} key - 配置项名称
+ * @param {number} currentValue - 当前值
+ * @returns {Promise<number>} 用户输入的数字值
+ */
+async function promptNumberValue(key: keyof ClawtConfig, currentValue: number): Promise<number> {
+  // @ts-expect-error enquirer 类型声明未导出 Input 类，但运行时存在
+  const input: string = await new Enquirer.Input({
+    message: MESSAGES.CONFIG_INPUT_PROMPT(key),
+    initial: String(currentValue),
+    validate: (val: string) => {
+      if (Number.isNaN(Number(val))) return '请输入有效的数字';
+      return true;
+    },
+  }).run();
+
+  return Number(input);
+}
+
+/**
+ * 交互式枚举值选择（内部辅助函数，用于有 allowedValues 的 string 配置项）
+ * @param {keyof ClawtConfig} key - 配置项名称
+ * @param {string} currentValue - 当前值
+ * @param {readonly string[]} allowedValues - 允许的枚举值列表
+ * @returns {Promise<string>} 用户选择的枚举值
+ */
+async function promptEnumValue(
+  key: keyof ClawtConfig,
+  currentValue: string,
+  allowedValues: readonly string[],
+): Promise<string> {
+  const choices = allowedValues.map((v) => ({
+    name: v,
+    message: v,
+  }));
+
+  // @ts-expect-error enquirer 类型声明未导出 Select 类，但运行时存在
+  return await new Enquirer.Select({
+    message: MESSAGES.CONFIG_INPUT_PROMPT(key),
+    choices,
+    initial: allowedValues.indexOf(currentValue),
+  }).run();
+}
+
+/**
+ * 交互式字符串自由输入（内部辅助函数，用于无 allowedValues 的 string 配置项）
+ * @param {keyof ClawtConfig} key - 配置项名称
+ * @param {string} currentValue - 当前值
+ * @returns {Promise<string>} 用户输入的字符串值
+ */
+async function promptStringValue(key: keyof ClawtConfig, currentValue: string): Promise<string> {
+  // @ts-expect-error enquirer 类型声明未导出 Input 类，但运行时存在
+  return await new Enquirer.Input({
+    message: MESSAGES.CONFIG_INPUT_PROMPT(key),
+    initial: currentValue,
+  }).run();
+}

package/src/utils/config.ts

@@ -24,11 +24,27 @@ export function loadConfig(): ClawtConfig {
   }
 }
 
+/**
+ * 将指定配置对象写入配置文件
+ * @param {ClawtConfig} config - 要写入的完整配置对象
+ */
+export function writeConfig(config: ClawtConfig): void {
+  writeFileSync(CONFIG_PATH, JSON.stringify(config, null, 2), 'utf-8');
+}
+
 /**
  * 将默认配置写入配置文件
  */
 export function writeDefaultConfig(): void {
-  writeFileSync(CONFIG_PATH, JSON.stringify(DEFAULT_CONFIG, null, 2), 'utf-8');
+  writeConfig(DEFAULT_CONFIG);
+}
+
+/**
+ * 将配置对象完整写入配置文件
+ * @param {ClawtConfig} config - 要持久化的配置对象
+ */
+export function saveConfig(config: ClawtConfig): void {
+  writeFileSync(CONFIG_PATH, JSON.stringify(config, null, 2), 'utf-8');
 }
 
 /**

package/src/utils/index.ts

@@ -48,7 +48,7 @@ export {
 export { sanitizeBranchName, generateBranchNames, validateBranchesNotExist } from './branch.js';
 export { validateMainWorktree, validateGitInstalled, validateClaudeCodeInstalled } from './validation.js';
 export { createWorktrees, getProjectWorktrees, getProjectWorktreeDir, cleanupWorktrees, getWorktreeStatus, createWorktreesByBranches } from './worktree.js';
-export { loadConfig, writeDefaultConfig, getConfigValue, ensureClawtDirs } from './config.js';
+export { loadConfig, writeDefaultConfig, writeConfig, saveConfig, getConfigValue, ensureClawtDirs } from './config.js';
 export { printSuccess, printError, printWarning, printInfo, printSeparator, printDoubleSeparator, confirmAction, confirmDestructiveAction, formatWorktreeStatus, isWorktreeIdle, formatDuration } from './formatter.js';
 export { ensureDir, removeEmptyDir } from './fs.js';
 export { multilineInput } from './prompt.js';
@@ -60,4 +60,6 @@ export { ProgressRenderer } from './progress.js';
 export { parseTaskFile, loadTaskFile } from './task-file.js';
 export { executeBatchTasks } from './task-executor.js';
 export { detectTerminalApp, openCommandInNewTerminalTab } from './terminal.js';
+export { applyAliases } from './alias.js';
+export { isValidConfigKey, getValidConfigKeys, parseConfigValue, promptConfigValue, formatConfigValue } from './config-strategy.js';
 

package/tests/unit/commands/alias.test.ts

@@ -0,0 +1,184 @@
+import { describe, it, expect, vi, beforeEach } from 'vitest';
+import { Command } from 'commander';
+
+// mock 依赖模块
+vi.mock('../../../src/logger/index.js', () => ({
+  logger: { debug: vi.fn(), info: vi.fn(), warn: vi.fn(), error: vi.fn() },
+}));
+
+vi.mock('../../../src/utils/index.js', () => ({
+  loadConfig: vi.fn(),
+  writeConfig: vi.fn(),
+  printInfo: vi.fn(),
+  printSuccess: vi.fn(),
+  printError: vi.fn(),
+  printSeparator: vi.fn(),
+}));
+
+vi.mock('../../../src/constants/index.js', () => ({
+  MESSAGES: {
+    ALIAS_LIST_EMPTY: '(无别名)',
+    ALIAS_LIST_TITLE: '当前别名列表：',
+    ALIAS_SET_SUCCESS: (a: string, c: string) => `✓ 已设置别名: ${a} → ${c}`,
+    ALIAS_REMOVE_SUCCESS: (a: string) => `✓ 已移除别名: ${a}`,
+    ALIAS_NOT_FOUND: (a: string) => `别名 "${a}" 不存在`,
+    ALIAS_CONFLICTS_BUILTIN: (a: string) => `别名 "${a}" 与内置命令冲突，不允许覆盖内置命令`,
+    ALIAS_TARGET_NOT_FOUND: (c: string) => `目标命令 "${c}" 不存在，请指定已注册的内置命令名`,
+  },
+}));
+
+import { registerAliasCommand } from '../../../src/commands/alias.js';
+import { loadConfig, writeConfig, printInfo, printSuccess, printError } from '../../../src/utils/index.js';
+
+const mockedLoadConfig = vi.mocked(loadConfig);
+const mockedWriteConfig = vi.mocked(writeConfig);
+const mockedPrintInfo = vi.mocked(printInfo);
+const mockedPrintSuccess = vi.mocked(printSuccess);
+const mockedPrintError = vi.mocked(printError);
+
+beforeEach(() => {
+  vi.clearAllMocks();
+});
+
+/** 构造默认配置 mock 数据 */
+function mockDefaultConfig(aliases: Record<string, string> = {}) {
+  return {
+    autoDeleteBranch: false,
+    claudeCodeCommand: 'claude',
+    autoPullPush: false,
+    confirmDestructiveOps: true,
+    maxConcurrency: 0,
+    terminalApp: 'auto',
+    aliases,
+  };
+}
+
+describe('registerAliasCommand', () => {
+  it('注册 alias 命令及 list/set/remove 子命令', () => {
+    const program = new Command();
+    registerAliasCommand(program);
+    const aliasCmd = program.commands.find((c) => c.name() === 'alias');
+    expect(aliasCmd).toBeDefined();
+    expect(aliasCmd!.commands.find((c) => c.name() === 'list')).toBeDefined();
+    expect(aliasCmd!.commands.find((c) => c.name() === 'set')).toBeDefined();
+    expect(aliasCmd!.commands.find((c) => c.name() === 'remove')).toBeDefined();
+  });
+});
+
+describe('alias list（通过 action 间接测试）', () => {
+  it('无别名时展示空提示', () => {
+    mockedLoadConfig.mockReturnValue(mockDefaultConfig());
+
+    const program = new Command();
+    program.exitOverride();
+    registerAliasCommand(program);
+    program.parse(['alias'], { from: 'user' });
+
+    expect(mockedPrintInfo).toHaveBeenCalledWith('(无别名)');
+  });
+
+  it('通过 alias list 子命令展示别名列表', () => {
+    mockedLoadConfig.mockReturnValue(mockDefaultConfig({ ls: 'list', rm: 'remove' }));
+
+    const program = new Command();
+    program.exitOverride();
+    registerAliasCommand(program);
+    program.parse(['alias', 'list'], { from: 'user' });
+
+    // 应展示列表标题
+    expect(mockedPrintInfo).toHaveBeenCalled();
+    const calls = mockedPrintInfo.mock.calls.map((c) => c[0]);
+    // 至少有一个调用包含别名信息
+    expect(calls.some((c) => typeof c === 'string' && c.includes('ls'))).toBe(true);
+  });
+});
+
+describe('alias set（通过 action 间接测试）', () => {
+  it('别名与内置命令冲突时报错', () => {
+    const program = new Command();
+    program.exitOverride();
+    program.command('list').action(() => {});
+    registerAliasCommand(program);
+    program.parse(['alias', 'set', 'list', 'create'], { from: 'user' });
+
+    expect(mockedPrintError).toHaveBeenCalled();
+    expect(mockedWriteConfig).not.toHaveBeenCalled();
+  });
+
+  it('目标命令不存在时报错', () => {
+    mockedLoadConfig.mockReturnValue(mockDefaultConfig());
+
+    const program = new Command();
+    program.exitOverride();
+    registerAliasCommand(program);
+    program.parse(['alias', 'set', 'ls', 'nonexistent'], { from: 'user' });
+
+    expect(mockedPrintError).toHaveBeenCalled();
+    expect(mockedWriteConfig).not.toHaveBeenCalled();
+  });
+
+  it('正常设置别名', () => {
+    mockedLoadConfig.mockReturnValue(mockDefaultConfig());
+
+    const program = new Command();
+    program.exitOverride();
+    program.command('list').action(() => {});
+    registerAliasCommand(program);
+    program.parse(['alias', 'set', 'ls', 'list'], { from: 'user' });
+
+    expect(mockedWriteConfig).toHaveBeenCalledWith(
+      expect.objectContaining({
+        aliases: { ls: 'list' },
+      }),
+    );
+    expect(mockedPrintSuccess).toHaveBeenCalled();
+  });
+
+  it('覆盖已有别名', () => {
+    mockedLoadConfig.mockReturnValue(mockDefaultConfig({ ls: 'list' }));
+
+    const program = new Command();
+    program.exitOverride();
+    program.command('list').action(() => {});
+    program.command('status').action(() => {});
+    registerAliasCommand(program);
+    program.parse(['alias', 'set', 'ls', 'status'], { from: 'user' });
+
+    expect(mockedWriteConfig).toHaveBeenCalledWith(
+      expect.objectContaining({
+        aliases: { ls: 'status' },
+      }),
+    );
+    expect(mockedPrintSuccess).toHaveBeenCalled();
+  });
+});
+
+describe('alias remove（通过 action 间接测试）', () => {
+  it('别名不存在时报错', () => {
+    mockedLoadConfig.mockReturnValue(mockDefaultConfig());
+
+    const program = new Command();
+    program.exitOverride();
+    registerAliasCommand(program);
+    program.parse(['alias', 'remove', 'nonexistent'], { from: 'user' });
+
+    expect(mockedPrintError).toHaveBeenCalled();
+    expect(mockedWriteConfig).not.toHaveBeenCalled();
+  });
+
+  it('正常移除别名', () => {
+    mockedLoadConfig.mockReturnValue(mockDefaultConfig({ ls: 'list' }));
+
+    const program = new Command();
+    program.exitOverride();
+    registerAliasCommand(program);
+    program.parse(['alias', 'remove', 'ls'], { from: 'user' });
+
+    expect(mockedWriteConfig).toHaveBeenCalledWith(
+      expect.objectContaining({
+        aliases: {},
+      }),
+    );
+    expect(mockedPrintSuccess).toHaveBeenCalled();
+  });
+});