@yivan-lab/pretty-please 1.3.1 → 1.5.0

package/src/upgrade.ts

@@ -370,6 +370,11 @@ pause
 
     console2.muted('━'.repeat(40))
     console2.success(`升级成功: ${currentVersion} → ${latestVersion}`)
+
+    // 升级成功后，重装 shell hook（如果已启用）
+    const { reinstallShellHook } = await import('./shell-hook.js')
+    await reinstallShellHook({ reason: '版本升级，更新 Shell Hook 脚本' })
+
     console.log('')
 
     return true

package/src/user-preferences.ts

@@ -0,0 +1,178 @@
+/**
+ * 用户命令偏好统计模块
+ *
+ * 功能：
+ * - 读取和分析 ~/.please/command_stats.txt
+ * - 获取用户最常用的命令
+ * - 格式化为 AI 可理解的字符串
+ * - 智能过滤非偏好命令（Shell 内置、系统通用命令等）
+ */
+
+import fs from 'fs'
+import path from 'path'
+import { CONFIG_DIR, getConfig } from './config.js'
+
+const STATS_FILE = path.join(CONFIG_DIR, 'command_stats.txt')
+
+/**
+ * 命令黑名单：这些命令不算"用户偏好"
+ * - Shell 内置命令：cd、export、source 等（必须用的，不是偏好）
+ * - 系统基础命令：ls、cat、grep 等（太基础，不反映偏好）
+ * - 系统通用命令：clear、exit、history 等（通用命令，不是偏好）
+ * - 查询命令：man、which、type 等（查询用途，不是偏好）
+ * - 权限命令：sudo、doas 等（权限提升，不是偏好）
+ * - pls 自身：pls-dev、pls、please（自引用）
+ */
+const COMMAND_BLACKLIST = new Set([
+  // Shell 内置命令
+  'cd', 'pushd', 'popd', 'dirs',
+  'export', 'set', 'unset', 'declare', 'local', 'readonly',
+  'alias', 'unalias',
+  'source', '.',
+  'history', 'fc',
+  'jobs', 'fg', 'bg', 'disown',
+  'eval', 'exec', 'builtin', 'command',
+  'true', 'false', ':', 'test', '[',
+
+  // 系统基础命令（太基础，不反映偏好）
+  'ls', 'cat', 'grep', 'find', 'head', 'tail',
+  'cp', 'mv', 'rm', 'mkdir', 'rmdir', 'touch',
+  'chmod', 'chown', 'ln',
+  'wc', 'sort', 'uniq', 'cut', 'tr', 'sed', 'awk',
+
+  // 系统通用命令（不算偏好）
+  'clear', 'reset',
+  'exit', 'logout',
+  'pwd',
+  'echo', 'printf',
+  'sleep', 'wait',
+  'kill', 'killall', 'pkill',
+
+  // 查询命令
+  'man', 'which', 'type', 'whereis', 'whatis', 'apropos',
+  'help', 'info',
+
+  // 权限命令
+  'sudo', 'doas', 'su',
+
+  // pls 自身
+  'pls', 'pls-dev', 'please',
+])
+
+/**
+ * 命令统计接口
+ */
+export interface CommandStat {
+  command: string
+  count: number
+}
+
+/**
+ * 确保统计文件存在
+ */
+function ensureStatsFile(): void {
+  if (!fs.existsSync(CONFIG_DIR)) {
+    fs.mkdirSync(CONFIG_DIR, { recursive: true })
+  }
+  if (!fs.existsSync(STATS_FILE)) {
+    fs.writeFileSync(STATS_FILE, '', 'utf-8')
+  }
+}
+
+/**
+ * 获取所有命令统计数据
+ */
+export function getCommandStats(): Record<string, number> {
+  ensureStatsFile()
+
+  const content = fs.readFileSync(STATS_FILE, 'utf-8')
+  const stats: Record<string, number> = {}
+
+  for (const line of content.split('\n')) {
+    if (!line.trim()) continue
+    const [cmd, count] = line.split('=')
+    if (cmd && count) {
+      stats[cmd] = parseInt(count, 10)
+    }
+  }
+
+  return stats
+}
+
+/**
+ * 获取使用频率最高的命令（智能过滤版）
+ * @param limit 可选的数量限制，不传则使用配置中的 userPreferencesTopK
+ */
+export function getTopCommands(limit?: number): CommandStat[] {
+  const config = getConfig()
+  const topK = limit !== undefined ? limit : config.userPreferencesTopK
+
+  const stats = getCommandStats()
+  return Object.entries(stats)
+    .filter(([command]) => !COMMAND_BLACKLIST.has(command))  // 过滤黑名单
+    .map(([command, count]) => ({ command, count }))
+    .sort((a, b) => b.count - a.count)
+    .slice(0, topK)
+}
+
+/**
+ * 格式化用户偏好为 AI 可理解的字符串
+ *
+ * 示例输出：
+ * "用户偏好: git(234), eza(156), vim(89), docker(67), pnpm(45)"
+ */
+export function formatUserPreferences(): string {
+  const top = getTopCommands()  // 使用配置中的 topK
+  if (top.length === 0) return ''
+
+  const lines = top.map(({ command, count }) => `${command}(${count})`)
+  return `用户偏好: ${lines.join(', ')}`
+}
+
+/**
+ * 清空统计数据
+ */
+export function clearCommandStats(): void {
+  ensureStatsFile()
+  fs.writeFileSync(STATS_FILE, '', 'utf-8')
+}
+
+/**
+ * 获取统计文件路径（用于 CLI 展示）
+ */
+export function getStatsFilePath(): string {
+  return STATS_FILE
+}
+
+/**
+ * 显示统计信息（用于 CLI）
+ */
+export function displayCommandStats(): void {
+  const config = getConfig()
+  const stats = getCommandStats()
+  const totalCommands = Object.keys(stats).length
+  const totalExecutions = Object.values(stats).reduce((sum, count) => sum + count, 0)
+
+  if (totalCommands === 0) {
+    console.log('\n暂无命令统计数据')
+    console.log('提示: 安装并启用 Shell Hook 后会自动开始统计\n')
+    return
+  }
+
+  const displayLimit = config.userPreferencesTopK  // 使用配置项
+  const top = getTopCommands(displayLimit)
+
+  console.log('\n━━━━━━━━━━━━━━━━━━━━━━━━━━━━')
+  console.log(`📊 命令使用统计`)
+  console.log(`总命令数: ${totalCommands}, 总执行次数: ${totalExecutions}`)
+  console.log('━━━━━━━━━━━━━━━━━━━━━━━━━━━━')
+  console.log(`\nTop ${displayLimit} 常用命令（已过滤非偏好命令）:\n`)
+
+  top.forEach(({ command, count }, index) => {
+    const percentage = ((count / totalExecutions) * 100).toFixed(1)
+    const bar = '█'.repeat(Math.floor(count / top[0].count * 20))
+    console.log(`${String(index + 1).padStart(2)}. ${command.padEnd(15)} ${bar} ${count} (${percentage}%)`)
+  })
+
+  console.log(`\n统计文件: ${STATS_FILE}\n`)
+}

package/src/utils/__tests__/platform-capabilities.test.ts

@@ -0,0 +1,265 @@
+/**
+ * Shell 能力专项测试
+ * 测试各 Shell 的配置文件、历史文件、能力矩阵等
+ */
+
+import { describe, it, expect, beforeEach, afterEach, vi } from 'vitest'
+import { getShellCapabilities, type ShellType } from '../platform'
+import os from 'os'
+import path from 'path'
+
+describe('Shell Capabilities - 配置文件路径', () => {
+  const originalPlatform = process.platform
+  const home = os.homedir()
+
+  afterEach(() => {
+    Object.defineProperty(process, 'platform', {
+      value: originalPlatform,
+    })
+  })
+
+  it('Zsh 应该返回 ~/.zshrc', () => {
+    const caps = getShellCapabilities('zsh')
+    expect(caps.configPath).toBe(path.join(home, '.zshrc'))
+  })
+
+  it('Bash 在 macOS 应该返回 ~/.bash_profile', () => {
+    Object.defineProperty(process, 'platform', { value: 'darwin', writable: true })
+    const caps = getShellCapabilities('bash')
+    expect(caps.configPath).toBe(path.join(home, '.bash_profile'))
+  })
+
+  it('Bash 在 Linux 应该返回 ~/.bashrc', () => {
+    Object.defineProperty(process, 'platform', { value: 'linux', writable: true })
+    const caps = getShellCapabilities('bash')
+    expect(caps.configPath).toBe(path.join(home, '.bashrc'))
+  })
+
+  it('Fish 应该返回 ~/.config/fish/config.fish', () => {
+    const caps = getShellCapabilities('fish')
+    expect(caps.configPath).toBe(path.join(home, '.config', 'fish', 'config.fish'))
+  })
+
+  it('PowerShell 5 应该返回正确的 profile 路径', () => {
+    const caps = getShellCapabilities('powershell5')
+    expect(caps.configPath).toBe(
+      path.join(home, 'Documents', 'WindowsPowerShell', 'Microsoft.PowerShell_profile.ps1')
+    )
+  })
+
+  it('PowerShell 7 应该返回正确的 profile 路径', () => {
+    const caps = getShellCapabilities('powershell7')
+    expect(caps.configPath).toBe(
+      path.join(home, 'Documents', 'PowerShell', 'Microsoft.PowerShell_profile.ps1')
+    )
+  })
+
+  it('CMD 应该返回 null (不支持配置文件)', () => {
+    const caps = getShellCapabilities('cmd')
+    expect(caps.configPath).toBeNull()
+  })
+
+  it('Unknown 应该返回 null', () => {
+    const caps = getShellCapabilities('unknown')
+    expect(caps.configPath).toBeNull()
+  })
+})
+
+describe('Shell Capabilities - 历史文件路径', () => {
+  const originalEnv = { ...process.env }
+  const home = os.homedir()
+
+  beforeEach(() => {
+    // 清空 HISTFILE 环境变量
+    delete process.env.HISTFILE
+  })
+
+  afterEach(() => {
+    process.env = { ...originalEnv }
+  })
+
+  it('Zsh 应该返回 ~/.zsh_history (默认)', () => {
+    const caps = getShellCapabilities('zsh')
+    expect(caps.historyPath).toBe(path.join(home, '.zsh_history'))
+  })
+
+  it('Zsh 应该使用 HISTFILE 环境变量覆盖', () => {
+    process.env.HISTFILE = '/custom/path/.zsh_history'
+    const caps = getShellCapabilities('zsh')
+    expect(caps.historyPath).toBe('/custom/path/.zsh_history')
+  })
+
+  it('Bash 应该返回 ~/.bash_history (默认)', () => {
+    const caps = getShellCapabilities('bash')
+    expect(caps.historyPath).toBe(path.join(home, '.bash_history'))
+  })
+
+  it('Bash 应该使用 HISTFILE 环境变量覆盖', () => {
+    process.env.HISTFILE = '/custom/path/.bash_history'
+    const caps = getShellCapabilities('bash')
+    expect(caps.historyPath).toBe('/custom/path/.bash_history')
+  })
+
+  it('Fish 应该返回 ~/.local/share/fish/fish_history', () => {
+    const caps = getShellCapabilities('fish')
+    expect(caps.historyPath).toBe(path.join(home, '.local', 'share', 'fish', 'fish_history'))
+  })
+
+  it('PowerShell 应该返回 PSReadLine 历史文件路径', () => {
+    const caps = getShellCapabilities('powershell5')
+    const appData = process.env.APPDATA || path.join(home, 'AppData', 'Roaming')
+    expect(caps.historyPath).toBe(
+      path.join(appData, 'Microsoft', 'Windows', 'PowerShell', 'PSReadLine', 'ConsoleHost_history.txt')
+    )
+  })
+
+  it('PowerShell 5 和 7 应该使用相同的历史文件', () => {
+    const caps5 = getShellCapabilities('powershell5')
+    const caps7 = getShellCapabilities('powershell7')
+    expect(caps5.historyPath).toBe(caps7.historyPath)
+  })
+
+  it('CMD 应该返回 null (不持久化历史)', () => {
+    const caps = getShellCapabilities('cmd')
+    expect(caps.historyPath).toBeNull()
+  })
+
+  it('Unknown 应该返回 null', () => {
+    const caps = getShellCapabilities('unknown')
+    expect(caps.historyPath).toBeNull()
+  })
+})
+
+describe('Shell Capabilities - 能力矩阵', () => {
+  it('Zsh 应该支持 Hook 和历史', () => {
+    const caps = getShellCapabilities('zsh')
+    expect(caps.supportsHook).toBe(true)
+    expect(caps.supportsHistory).toBe(true)
+  })
+
+  it('Bash 应该支持 Hook 和历史', () => {
+    const caps = getShellCapabilities('bash')
+    expect(caps.supportsHook).toBe(true)
+    expect(caps.supportsHistory).toBe(true)
+  })
+
+  it('Fish 应该支持 Hook 和历史', () => {
+    const caps = getShellCapabilities('fish')
+    expect(caps.supportsHook).toBe(true)
+    expect(caps.supportsHistory).toBe(true)
+  })
+
+  it('PowerShell 5 应该支持 Hook 和历史', () => {
+    const caps = getShellCapabilities('powershell5')
+    expect(caps.supportsHook).toBe(true)
+    expect(caps.supportsHistory).toBe(true)
+  })
+
+  it('PowerShell 7 应该支持 Hook 和历史', () => {
+    const caps = getShellCapabilities('powershell7')
+    expect(caps.supportsHook).toBe(true)
+    expect(caps.supportsHistory).toBe(true)
+  })
+
+  it('CMD 不应该支持 Hook 和历史', () => {
+    const caps = getShellCapabilities('cmd')
+    expect(caps.supportsHook).toBe(false)
+    expect(caps.supportsHistory).toBe(false)
+  })
+
+  it('Unknown 不应该支持 Hook 和历史', () => {
+    const caps = getShellCapabilities('unknown')
+    expect(caps.supportsHook).toBe(false)
+    expect(caps.supportsHistory).toBe(false)
+  })
+})
+
+describe('Shell Capabilities - 可执行文件', () => {
+  const originalEnv = { ...process.env }
+
+  afterEach(() => {
+    process.env = { ...originalEnv }
+  })
+
+  it('Zsh 应该返回 $SHELL 或默认路径', () => {
+    delete process.env.SHELL
+    const caps = getShellCapabilities('zsh')
+    expect(caps.executable).toBe('/bin/zsh')
+  })
+
+  it('Zsh 应该使用 $SHELL 环境变量', () => {
+    process.env.SHELL = '/usr/local/bin/zsh'
+    const caps = getShellCapabilities('zsh')
+    expect(caps.executable).toBe('/usr/local/bin/zsh')
+  })
+
+  it('Bash 应该返回 $SHELL 或默认路径', () => {
+    delete process.env.SHELL
+    const caps = getShellCapabilities('bash')
+    expect(caps.executable).toBe('/bin/bash')
+  })
+
+  it('Fish 应该返回 $SHELL 或默认路径', () => {
+    delete process.env.SHELL
+    const caps = getShellCapabilities('fish')
+    expect(caps.executable).toBe('/usr/bin/fish')
+  })
+
+  it('PowerShell 5 应该返回 powershell.exe', () => {
+    const caps = getShellCapabilities('powershell5')
+    expect(caps.executable).toBe('powershell.exe')
+  })
+
+  it('PowerShell 7 应该返回 pwsh.exe', () => {
+    const caps = getShellCapabilities('powershell7')
+    expect(caps.executable).toBe('pwsh.exe')
+  })
+
+  it('CMD 应该返回 $COMSPEC 或 cmd.exe', () => {
+    delete process.env.COMSPEC
+    const caps = getShellCapabilities('cmd')
+    expect(caps.executable).toBe('cmd.exe')
+  })
+
+  it('CMD 应该使用 $COMSPEC 环境变量', () => {
+    process.env.COMSPEC = 'C:\\Windows\\System32\\cmd.exe'
+    const caps = getShellCapabilities('cmd')
+    expect(caps.executable).toBe('C:\\Windows\\System32\\cmd.exe')
+  })
+})
+
+describe('Shell Capabilities - 显示名称', () => {
+  it('应该返回正确的显示名称', () => {
+    expect(getShellCapabilities('zsh').displayName).toBe('Zsh')
+    expect(getShellCapabilities('bash').displayName).toBe('Bash')
+    expect(getShellCapabilities('fish').displayName).toBe('Fish')
+    expect(getShellCapabilities('cmd').displayName).toBe('CMD')
+    expect(getShellCapabilities('powershell5').displayName).toBe('PowerShell 5.x')
+    expect(getShellCapabilities('powershell7').displayName).toBe('PowerShell 7+')
+    expect(getShellCapabilities('unknown').displayName).toBe('Unknown')
+  })
+})
+
+describe('Shell Capabilities - 完整性检查', () => {
+  it('每个 Shell 类型都应该返回完整的能力信息', () => {
+    const shells: ShellType[] = ['zsh', 'bash', 'fish', 'cmd', 'powershell5', 'powershell7', 'unknown']
+
+    shells.forEach((shell) => {
+      const caps = getShellCapabilities(shell)
+
+      expect(caps).toHaveProperty('supportsHook')
+      expect(caps).toHaveProperty('supportsHistory')
+      expect(caps).toHaveProperty('configPath')
+      expect(caps).toHaveProperty('historyPath')
+      expect(caps).toHaveProperty('executable')
+      expect(caps).toHaveProperty('displayName')
+
+      expect(typeof caps.supportsHook).toBe('boolean')
+      expect(typeof caps.supportsHistory).toBe('boolean')
+      expect(typeof caps.executable).toBe('string')
+      expect(typeof caps.displayName).toBe('string')
+      expect(caps.executable).toBeTruthy()
+      expect(caps.displayName).toBeTruthy()
+    })
+  })
+})