@yivan-lab/pretty-please 1.4.0 → 1.5.0

package/dist/src/utils/__tests__/platform-shell.test.js

@@ -0,0 +1,300 @@
+/**
+ * Shell 检测专项测试
+ * 测试各种平台和环境下的 Shell 类型检测
+ */
+import { describe, it, expect, beforeEach, afterEach, vi } from 'vitest';
+import { detectShell } 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');
+    });
+});

package/dist/src/utils/__tests__/platform.test.d.ts

@@ -0,0 +1,5 @@
+/**
+ * 平台检测和通用函数测试
+ * 测试基础的平台判断函数和其他通用工具
+ */
+export {};

package/dist/src/utils/__tests__/platform.test.js

@@ -0,0 +1,137 @@
+/**
+ * 平台检测和通用函数测试
+ * 测试基础的平台判断函数和其他通用工具
+ */
+import { describe, it, expect, afterEach } from 'vitest';
+import { isWindows, isMacOS, isLinux, getDefaultShell, getConfigDir, getPowerShellConfigDir } from '../platform';
+describe('Platform Detection', () => {
+    const originalPlatform = process.platform;
+    afterEach(() => {
+        Object.defineProperty(process, 'platform', {
+            value: originalPlatform,
+            writable: true,
+        });
+    });
+    it('isWindows() 在 Windows 平台应该返回 true', () => {
+        Object.defineProperty(process, 'platform', { value: 'win32', writable: true });
+        expect(isWindows()).toBe(true);
+        expect(isMacOS()).toBe(false);
+        expect(isLinux()).toBe(false);
+    });
+    it('isMacOS() 在 macOS 平台应该返回 true', () => {
+        Object.defineProperty(process, 'platform', { value: 'darwin', writable: true });
+        expect(isWindows()).toBe(false);
+        expect(isMacOS()).toBe(true);
+        expect(isLinux()).toBe(false);
+    });
+    it('isLinux() 在 Linux 平台应该返回 true', () => {
+        Object.defineProperty(process, 'platform', { value: 'linux', writable: true });
+        expect(isWindows()).toBe(false);
+        expect(isMacOS()).toBe(false);
+        expect(isLinux()).toBe(true);
+    });
+    it('应该只有一个平台为 true', () => {
+        // 无论在哪个平台，三个函数应该只有一个返回 true
+        const results = [isWindows(), isMacOS(), isLinux()];
+        const trueCount = results.filter(r => r === true).length;
+        expect(trueCount).toBe(1);
+    });
+});
+describe('getDefaultShell', () => {
+    const originalPlatform = process.platform;
+    const originalEnv = { ...process.env };
+    afterEach(() => {
+        Object.defineProperty(process, 'platform', {
+            value: originalPlatform,
+        });
+        process.env = { ...originalEnv };
+    });
+    it('Unix 平台应该返回 $SHELL', () => {
+        Object.defineProperty(process, 'platform', { value: 'linux', writable: true });
+        process.env.SHELL = '/bin/zsh';
+        const shell = getDefaultShell();
+        expect(shell).toBe('/bin/zsh');
+    });
+    it('Unix 平台无 $SHELL 应该降级到 /bin/bash', () => {
+        Object.defineProperty(process, 'platform', { value: 'linux', writable: true });
+        delete process.env.SHELL;
+        const shell = getDefaultShell();
+        expect(shell).toBe('/bin/bash');
+    });
+    it('Windows 平台 PowerShell 7 应该返回 pwsh.exe', () => {
+        Object.defineProperty(process, 'platform', { value: 'win32', writable: true });
+        process.env.PSModulePath = 'C:\\Program Files\\PowerShell\\7\\Modules';
+        const shell = getDefaultShell();
+        expect(shell).toBe('pwsh.exe');
+    });
+    it('Windows 平台 PowerShell 5 应该返回 powershell.exe', () => {
+        Object.defineProperty(process, 'platform', { value: 'win32', writable: true });
+        process.env.PSModulePath = 'C:\\Windows\\System32\\WindowsPowerShell\\v1.0\\Modules';
+        delete process.env.PROMPT;
+        const shell = getDefaultShell();
+        expect(shell).toBe('powershell.exe');
+    });
+    it('Windows 平台 CMD 应该返回 cmd.exe 或 $COMSPEC', () => {
+        Object.defineProperty(process, 'platform', { value: 'win32', writable: true });
+        process.env.PROMPT = '$P$G';
+        delete process.env.PSModulePath;
+        delete process.env.COMSPEC;
+        const shell = getDefaultShell();
+        expect(shell).toBe('cmd.exe');
+    });
+});
+describe('getConfigDir', () => {
+    it('应该返回 ~/.please 目录', () => {
+        const configDir = getConfigDir();
+        expect(configDir).toContain('.please');
+        expect(configDir).toMatch(/[\/\\]\.please$/);
+    });
+    it('应该使用用户 home 目录', () => {
+        const os = require('os');
+        const home = os.homedir();
+        const configDir = getConfigDir();
+        expect(configDir).toContain(home);
+    });
+});
+describe('getPowerShellConfigDir', () => {
+    it('应该返回 PowerShell 变量格式', () => {
+        const psDir = getPowerShellConfigDir();
+        expect(psDir).toBe('$env:USERPROFILE\\.please');
+    });
+    it('返回值应该是 PowerShell 可识别的路径', () => {
+        const psDir = getPowerShellConfigDir();
+        // PowerShell 路径应该：
+        // 1. 使用 $env:USERPROFILE 而不是硬编码路径
+        // 2. 使用反斜杠（Windows 风格）
+        expect(psDir).toMatch(/^\$env:USERPROFILE/);
+        expect(psDir).toContain('\\');
+    });
+});
+describe('Integration - Platform 和 Shell 检测配合', () => {
+    const originalPlatform = process.platform;
+    const originalEnv = { ...process.env };
+    afterEach(() => {
+        Object.defineProperty(process, 'platform', {
+            value: originalPlatform,
+        });
+        process.env = { ...originalEnv };
+    });
+    it('macOS + Zsh 应该正常工作', () => {
+        Object.defineProperty(process, 'platform', { value: 'darwin', writable: true });
+        process.env.SHELL = '/bin/zsh';
+        expect(isMacOS()).toBe(true);
+        expect(getDefaultShell()).toBe('/bin/zsh');
+    });
+    it('Linux + Bash 应该正常工作', () => {
+        Object.defineProperty(process, 'platform', { value: 'linux', writable: true });
+        process.env.SHELL = '/bin/bash';
+        expect(isLinux()).toBe(true);
+        expect(getDefaultShell()).toBe('/bin/bash');
+    });
+    it('Windows + PowerShell 7 应该正常工作', () => {
+        Object.defineProperty(process, 'platform', { value: 'win32', writable: true });
+        process.env.PSModulePath = 'C:\\Program Files\\PowerShell\\7\\Modules';
+        expect(isWindows()).toBe(true);
+        expect(getDefaultShell()).toBe('pwsh.exe');
+    });
+});

package/dist/src/utils/platform.d.ts

@@ -0,0 +1,88 @@
+/**
+ * 跨平台工具函数
+ * 封装所有平台相关的逻辑，优先支持 macOS/Linux，兼容 Windows
+ */
+/**
+ * Shell 类型
+ */
+export type ShellType = 'zsh' | 'bash' | 'fish' | 'cmd' | 'powershell5' | 'powershell7' | 'unknown';
+/**
+ * Shell 能力
+ */
+export interface ShellCapabilities {
+    /** 是否支持 Hook（修改配置文件） */
+    supportsHook: boolean;
+    /** 是否支持历史读取 */
+    supportsHistory: boolean;
+    /** 配置文件路径 */
+    configPath: string | null;
+    /** 历史文件路径 */
+    historyPath: string | null;
+    /** 用于执行命令的 Shell 可执行文件 */
+    executable: string;
+    /** Shell 名称（用于显示） */
+    displayName: string;
+}
+/**
+ * 是否为 Windows 平台
+ */
+export declare function isWindows(): boolean;
+/**
+ * 是否为 macOS 平台
+ */
+export declare function isMacOS(): boolean;
+/**
+ * 是否为 Linux 平台
+ */
+export declare function isLinux(): boolean;
+/**
+ * 检测当前 Shell 类型
+ */
+export declare function detectShell(): ShellType;
+/**
+ * 获取 Shell 能力信息
+ */
+export declare function getShellCapabilities(shell: ShellType): ShellCapabilities;
+/**
+ * 检测命令是否存在（跨平台）
+ */
+export declare function commandExists(command: string): boolean;
+/**
+ * 批量检测命令是否存在（优化性能）
+ * @returns 返回存在的命令列表
+ */
+export declare function batchCommandExists(commands: string[]): string[];
+/**
+ * 命令执行配置
+ */
+export interface ShellExecConfig {
+    /** Shell 可执行文件 */
+    shell: string;
+    /** Shell 参数 */
+    args: string[];
+    /** 完整的命令字符串（已包含错误处理） */
+    command: string;
+}
+/**
+ * 构建命令执行配置
+ * 处理不同 Shell 的语法差异
+ */
+export declare function buildShellExecConfig(command: string, shell?: ShellType): ShellExecConfig;
+/**
+ * 获取默认 Shell（用于交互式执行）
+ */
+export declare function getDefaultShell(): string;
+/**
+ * 获取 pls 配置目录
+ * 统一使用 ~/.please
+ */
+export declare function getConfigDir(): string;
+/**
+ * 将路径转换为当前平台格式
+ */
+export declare function normalizePath(p: string): string;
+/**
+ * 获取用于 PowerShell 脚本中的路径
+ * 使用 $env:USERPROFILE 而不是硬编码路径
+ */
+export declare function getPowerShellConfigDir(): string;