@yivan-lab/pretty-please 1.4.0 → 1.5.0

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

@@ -0,0 +1,278 @@
+/**
+ * 命令执行配置专项测试
+ * 测试不同 Shell 的命令执行配置构建
+ */
+
+import { describe, it, expect, beforeEach, afterEach, vi } from 'vitest'
+import { buildShellExecConfig, type ShellType } from '../platform'
+
+describe('Shell Exec Config - Bash', () => {
+  const originalEnv = { ...process.env }
+
+  beforeEach(() => {
+    delete process.env.SHELL
+  })
+
+  afterEach(() => {
+    process.env = { ...originalEnv }
+  })
+
+  it('应该为 Bash 添加 pipefail', () => {
+    const config = buildShellExecConfig('ls -la', 'bash')
+
+    expect(config.shell).toBe('/bin/bash')
+    expect(config.args).toEqual(['-c', 'set -o pipefail; ls -la'])
+    expect(config.command).toBe('set -o pipefail; ls -la')
+  })
+
+  it('应该使用 $SHELL 环境变量', () => {
+    process.env.SHELL = '/usr/local/bin/bash'
+    const config = buildShellExecConfig('ls -la', 'bash')
+
+    expect(config.shell).toBe('/usr/local/bin/bash')
+  })
+
+  it('应该处理多行命令', () => {
+    const command = 'echo "hello"\necho "world"'
+    const config = buildShellExecConfig(command, 'bash')
+
+    expect(config.command).toBe(`set -o pipefail; ${command}`)
+  })
+
+  it('应该处理包含特殊字符的命令', () => {
+    const command = 'echo "test$VAR"; cat file | grep "pattern"'
+    const config = buildShellExecConfig(command, 'bash')
+
+    expect(config.command).toBe(`set -o pipefail; ${command}`)
+  })
+})
+
+describe('Shell Exec Config - Zsh', () => {
+  const originalEnv = { ...process.env }
+
+  beforeEach(() => {
+    delete process.env.SHELL
+  })
+
+  afterEach(() => {
+    process.env = { ...originalEnv }
+  })
+
+  it('应该为 Zsh 添加 pipefail', () => {
+    const config = buildShellExecConfig('ls -la', 'zsh')
+
+    expect(config.shell).toBe('/bin/zsh')
+    expect(config.args).toEqual(['-c', 'setopt pipefail; ls -la'])
+    expect(config.command).toBe('setopt pipefail; ls -la')
+  })
+
+  it('应该使用 $SHELL 环境变量', () => {
+    process.env.SHELL = '/opt/homebrew/bin/zsh'
+    const config = buildShellExecConfig('ls -la', 'zsh')
+
+    expect(config.shell).toBe('/opt/homebrew/bin/zsh')
+  })
+})
+
+describe('Shell Exec Config - Fish', () => {
+  const originalEnv = { ...process.env }
+
+  beforeEach(() => {
+    delete process.env.SHELL
+  })
+
+  afterEach(() => {
+    process.env = { ...originalEnv }
+  })
+
+  it('Fish 不应该添加 pipefail', () => {
+    delete process.env.SHELL // 确保使用默认路径
+    const config = buildShellExecConfig('ls -la', 'fish')
+
+    expect(config.shell).toBe('/usr/bin/fish')
+    expect(config.args).toEqual(['-c', 'ls -la'])
+    expect(config.command).toBe('ls -la') // 注意：Fish 不需要 pipefail
+  })
+
+  it('应该使用 $SHELL 环境变量', () => {
+    process.env.SHELL = '/usr/local/bin/fish'
+    const config = buildShellExecConfig('ls -la', 'fish')
+
+    expect(config.shell).toBe('/usr/local/bin/fish')
+  })
+})
+
+describe('Shell Exec Config - PowerShell', () => {
+  it('PowerShell 5 应该使用 -NoProfile -Command', () => {
+    const config = buildShellExecConfig('Get-Process', 'powershell5')
+
+    expect(config.shell).toBe('powershell.exe')
+    expect(config.args).toEqual(['-NoProfile', '-Command', 'Get-Process'])
+    expect(config.command).toBe('Get-Process')
+  })
+
+  it('PowerShell 7 应该使用 -NoProfile -Command', () => {
+    const config = buildShellExecConfig('Get-Process', 'powershell7')
+
+    expect(config.shell).toBe('pwsh.exe')
+    expect(config.args).toEqual(['-NoProfile', '-Command', 'Get-Process'])
+    expect(config.command).toBe('Get-Process')
+  })
+
+  it('应该处理多行 PowerShell 脚本', () => {
+    const command = 'Get-Process | Where-Object {$_.CPU -gt 10}'
+    const config = buildShellExecConfig(command, 'powershell7')
+
+    expect(config.command).toBe(command)
+    expect(config.args).toEqual(['-NoProfile', '-Command', command])
+  })
+})
+
+describe('Shell Exec Config - CMD', () => {
+  const originalEnv = { ...process.env }
+
+  beforeEach(() => {
+    // 清除 COMSPEC 以确保使用默认值
+    delete process.env.COMSPEC
+  })
+
+  afterEach(() => {
+    process.env = { ...originalEnv }
+  })
+
+  it('CMD 应该使用 /c 参数', () => {
+    const config = buildShellExecConfig('dir', 'cmd')
+
+    expect(config.shell).toContain('cmd.exe')
+    expect(config.args).toEqual(['/c', 'dir'])
+    expect(config.command).toBe('dir')
+  })
+
+  it('应该使用 $COMSPEC 环境变量', () => {
+    process.env.COMSPEC = 'C:\\Windows\\System32\\cmd.exe'
+    const config = buildShellExecConfig('dir', 'cmd')
+
+    expect(config.shell).toBe('C:\\Windows\\System32\\cmd.exe')
+  })
+
+  it('应该处理 CMD 批处理命令', () => {
+    const command = 'echo hello && dir && cd ..'
+    const config = buildShellExecConfig(command, 'cmd')
+
+    expect(config.command).toBe(command)
+  })
+})
+
+describe('Shell Exec Config - Unknown/Default', () => {
+  const originalPlatform = process.platform
+
+  afterEach(() => {
+    Object.defineProperty(process, 'platform', {
+      value: originalPlatform,
+    })
+  })
+
+  it('Unix 平台未知 Shell 应该降级到 /bin/sh', () => {
+    Object.defineProperty(process, 'platform', { value: 'linux', writable: true })
+    const config = buildShellExecConfig('ls', 'unknown')
+
+    expect(config.shell).toBe('/bin/sh')
+    expect(config.args).toEqual(['-c', 'ls'])
+  })
+
+  it('Windows 平台未知 Shell 应该降级到 powershell.exe', () => {
+    Object.defineProperty(process, 'platform', { value: 'win32', writable: true })
+    const config = buildShellExecConfig('dir', 'unknown')
+
+    expect(config.shell).toBe('powershell.exe')
+    expect(config.args).toEqual(['-Command', 'dir'])
+  })
+})
+
+describe('Shell Exec Config - 自动检测 Shell', () => {
+  const originalPlatform = process.platform
+  const originalEnv = { ...process.env }
+
+  beforeEach(() => {
+    vi.stubGlobal('process', {
+      ...process,
+      platform: 'darwin',
+      env: {
+        SHELL: '/bin/zsh',
+      },
+    })
+  })
+
+  afterEach(() => {
+    vi.unstubAllGlobals()
+    Object.defineProperty(process, 'platform', {
+      value: originalPlatform,
+    })
+    process.env = { ...originalEnv }
+  })
+
+  it('不指定 Shell 时应该自动检测', () => {
+    vi.stubGlobal('process', {
+      ...process,
+      platform: 'darwin',
+      env: {
+        SHELL: '/bin/zsh',
+      },
+    })
+
+    const config = buildShellExecConfig('ls -la')
+
+    expect(config.shell).toBe('/bin/zsh')
+    expect(config.command).toBe('setopt pipefail; ls -la')
+  })
+
+  it('Windows 环境不指定 Shell 时应该自动检测', () => {
+    vi.stubGlobal('process', {
+      ...process,
+      platform: 'win32',
+      env: {
+        PSModulePath: 'C:\\Program Files\\PowerShell\\7\\Modules',
+      },
+    })
+
+    const config = buildShellExecConfig('Get-Process')
+
+    expect(config.shell).toBe('pwsh.exe')
+    expect(config.args).toEqual(['-NoProfile', '-Command', 'Get-Process'])
+  })
+})
+
+describe('Shell Exec Config - 边界情况', () => {
+  it('应该处理空命令', () => {
+    const config = buildShellExecConfig('', 'bash')
+
+    expect(config.command).toBe('set -o pipefail; ')
+  })
+
+  it('应该处理只有空格的命令', () => {
+    const config = buildShellExecConfig('   ', 'bash')
+
+    expect(config.command).toBe('set -o pipefail;    ')
+  })
+
+  it('应该处理包含引号的命令', () => {
+    const command = 'echo "hello \'world\'"'
+    const config = buildShellExecConfig(command, 'bash')
+
+    expect(config.command).toContain(command)
+  })
+
+  it('应该处理包含管道的命令', () => {
+    const command = 'cat file.txt | grep pattern | wc -l'
+    const config = buildShellExecConfig(command, 'bash')
+
+    expect(config.command).toBe(`set -o pipefail; ${command}`)
+  })
+
+  it('应该处理包含重定向的命令', () => {
+    const command = 'echo "test" > file.txt 2>&1'
+    const config = buildShellExecConfig(command, 'bash')
+
+    expect(config.command).toContain(command)
+  })
+})

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

@@ -0,0 +1,353 @@
+/**
+ * Shell 检测专项测试
+ * 测试各种平台和环境下的 Shell 类型检测
+ */
+
+import { describe, it, expect, beforeEach, afterEach, vi } from 'vitest'
+import { detectShell, type ShellType } from '../platform'
+import { execSync } from 'child_process'
+
+// Mock child_process 用于控制 commandExists 的行为
+vi.mock('child_process', () => ({
+  execSync: vi.fn(),
+  exec: vi.fn(),
+  spawn: vi.fn(),
+}))
+
+const mockExecSync = vi.mocked(execSync)
+
+describe('Shell Detection - Windows', () => {
+  // 保存原始环境
+  const originalPlatform = process.platform
+  const originalEnv = { ...process.env }
+
+  beforeEach(() => {
+    vi.clearAllMocks()
+    // 默认让 commandExists 返回 false（execSync 抛出错误）
+    mockExecSync.mockImplementation(() => {
+      throw new Error('Command not found')
+    })
+    // 清空环境变量
+    vi.stubGlobal('process', {
+      ...process,
+      platform: 'win32',
+      env: {},
+    })
+  })
+
+  afterEach(() => {
+    // 恢复原始环境
+    vi.unstubAllGlobals()
+    Object.defineProperty(process, 'platform', {
+      value: originalPlatform,
+    })
+    process.env = { ...originalEnv }
+  })
+
+  it('应该检测到 PowerShell 7+ (路径包含 PowerShell\\7)', () => {
+    vi.stubGlobal('process', {
+      ...process,
+      platform: 'win32',
+      env: {
+        PSModulePath: 'C:\\Program Files\\PowerShell\\7\\Modules',
+      },
+    })
+
+    const result = detectShell()
+    expect(result).toBe('powershell7')
+  })
+
+  it('应该检测到 PowerShell 7+ (路径包含 PowerShell/7)', () => {
+    vi.stubGlobal('process', {
+      ...process,
+      platform: 'win32',
+      env: {
+        PSModulePath: 'C:/Program Files/PowerShell/7/Modules',
+      },
+    })
+
+    const result = detectShell()
+    expect(result).toBe('powershell7')
+  })
+
+  it('应该检测到 PowerShell 7+ (大小写不敏感)', () => {
+    vi.stubGlobal('process', {
+      ...process,
+      platform: 'win32',
+      env: {
+        PSModulePath: 'C:\\PROGRAM FILES\\powershell\\7\\modules',
+      },
+    })
+
+    const result = detectShell()
+    expect(result).toBe('powershell7')
+  })
+
+  it('应该检测到 PowerShell 5.x (路径包含 WindowsPowerShell)', () => {
+    vi.stubGlobal('process', {
+      ...process,
+      platform: 'win32',
+      env: {
+        PSModulePath: 'C:\\Windows\\System32\\WindowsPowerShell\\v1.0\\Modules',
+      },
+    })
+
+    const result = detectShell()
+    expect(result).toBe('powershell5')
+  })
+
+  it('应该检测到 PowerShell 5.x (大小写不敏感)', () => {
+    vi.stubGlobal('process', {
+      ...process,
+      platform: 'win32',
+      env: {
+        PSModulePath: 'C:\\Windows\\System32\\WINDOWSPOWERSHELL\\v1.0\\Modules',
+      },
+    })
+
+    const result = detectShell()
+    expect(result).toBe('powershell5')
+  })
+
+  it('应该检测到 CMD (PROMPT 存在且无 PSModulePath)', () => {
+    vi.stubGlobal('process', {
+      ...process,
+      platform: 'win32',
+      env: {
+        PROMPT: '$P$G',
+      },
+    })
+
+    const result = detectShell()
+    expect(result).toBe('cmd')
+  })
+
+  it('应该忽略 PROMPT 如果 PSModulePath 存在 (避免 PowerShell 中运行 CMD 的误判)', () => {
+    vi.stubGlobal('process', {
+      ...process,
+      platform: 'win32',
+      env: {
+        PROMPT: '$P$G',
+        PSModulePath: 'C:\\Windows\\System32\\WindowsPowerShell\\v1.0\\Modules',
+      },
+    })
+
+    const result = detectShell()
+    expect(result).toBe('powershell5') // 应该是 PowerShell，不是 CMD
+  })
+
+  it('应该默认降级到 PowerShell 5 (Windows 环境无明确特征)', () => {
+    vi.stubGlobal('process', {
+      ...process,
+      platform: 'win32',
+      env: {},
+    })
+
+    const result = detectShell()
+    expect(result).toBe('powershell5')
+  })
+
+  it('应该处理空的 PSModulePath', () => {
+    vi.stubGlobal('process', {
+      ...process,
+      platform: 'win32',
+      env: {
+        PSModulePath: '',
+      },
+    })
+
+    const result = detectShell()
+    expect(result).toBe('powershell5')
+  })
+})
+
+describe('Shell Detection - Unix', () => {
+  const originalPlatform = process.platform
+  const originalEnv = { ...process.env }
+
+  beforeEach(() => {
+    vi.stubGlobal('process', {
+      ...process,
+      platform: 'darwin',
+      env: {},
+    })
+  })
+
+  afterEach(() => {
+    vi.unstubAllGlobals()
+    Object.defineProperty(process, 'platform', {
+      value: originalPlatform,
+    })
+    process.env = { ...originalEnv }
+  })
+
+  it('应该检测到 Zsh', () => {
+    vi.stubGlobal('process', {
+      ...process,
+      platform: 'darwin',
+      env: {
+        SHELL: '/bin/zsh',
+      },
+    })
+
+    const result = detectShell()
+    expect(result).toBe('zsh')
+  })
+
+  it('应该检测到 Bash', () => {
+    vi.stubGlobal('process', {
+      ...process,
+      platform: 'linux',
+      env: {
+        SHELL: '/bin/bash',
+      },
+    })
+
+    const result = detectShell()
+    expect(result).toBe('bash')
+  })
+
+  it('应该检测到 Fish', () => {
+    vi.stubGlobal('process', {
+      ...process,
+      platform: 'linux',
+      env: {
+        SHELL: '/usr/bin/fish',
+      },
+    })
+
+    const result = detectShell()
+    expect(result).toBe('fish')
+  })
+
+  it('应该处理 SHELL 路径的多种格式 (Zsh)', () => {
+    const testCases = [
+      '/usr/local/bin/zsh',
+      '/opt/homebrew/bin/zsh',
+      'zsh',
+    ]
+
+    for (const shellPath of testCases) {
+      vi.stubGlobal('process', {
+        ...process,
+        platform: 'darwin',
+        env: {
+          SHELL: shellPath,
+        },
+      })
+
+      const result = detectShell()
+      expect(result).toBe('zsh')
+    }
+  })
+
+  it('应该处理 SHELL 路径的多种格式 (Bash)', () => {
+    const testCases = [
+      '/usr/local/bin/bash',
+      '/opt/homebrew/bin/bash',
+      'bash',
+    ]
+
+    for (const shellPath of testCases) {
+      vi.stubGlobal('process', {
+        ...process,
+        platform: 'linux',
+        env: {
+          SHELL: shellPath,
+        },
+      })
+
+      const result = detectShell()
+      expect(result).toBe('bash')
+    }
+  })
+
+  it('应该降级到 unknown (SHELL 为空)', () => {
+    vi.stubGlobal('process', {
+      ...process,
+      platform: 'linux',
+      env: {
+        SHELL: '',
+      },
+    })
+
+    const result = detectShell()
+    expect(result).toBe('unknown')
+  })
+
+  it('应该降级到 unknown (SHELL 不匹配)', () => {
+    vi.stubGlobal('process', {
+      ...process,
+      platform: 'linux',
+      env: {
+        SHELL: '/usr/bin/tcsh',
+      },
+    })
+
+    const result = detectShell()
+    expect(result).toBe('unknown')
+  })
+
+  it('应该降级到 unknown (无 SHELL 环境变量)', () => {
+    vi.stubGlobal('process', {
+      ...process,
+      platform: 'linux',
+      env: {},
+    })
+
+    const result = detectShell()
+    expect(result).toBe('unknown')
+  })
+})
+
+describe('Shell Detection - Edge Cases', () => {
+  const originalPlatform = process.platform
+  const originalEnv = { ...process.env }
+
+  afterEach(() => {
+    vi.unstubAllGlobals()
+    Object.defineProperty(process, 'platform', {
+      value: originalPlatform,
+    })
+    process.env = { ...originalEnv }
+  })
+
+  it('应该正确处理 macOS 平台', () => {
+    vi.stubGlobal('process', {
+      ...process,
+      platform: 'darwin',
+      env: {
+        SHELL: '/bin/zsh',
+      },
+    })
+
+    const result = detectShell()
+    expect(result).toBe('zsh')
+  })
+
+  it('应该正确处理 Linux 平台', () => {
+    vi.stubGlobal('process', {
+      ...process,
+      platform: 'linux',
+      env: {
+        SHELL: '/bin/bash',
+      },
+    })
+
+    const result = detectShell()
+    expect(result).toBe('bash')
+  })
+
+  it('应该正确处理 Windows 平台', () => {
+    vi.stubGlobal('process', {
+      ...process,
+      platform: 'win32',
+      env: {
+        PSModulePath: 'C:\\Program Files\\PowerShell\\7\\Modules',
+      },
+    })
+
+    const result = detectShell()
+    expect(result).toBe('powershell7')
+  })
+})