mirror of
https://github.com/Fission-AI/OpenSpec.git
synced 2026-09-14 20:16:53 +08:00
1adf3cea88
* shell completions for zsh * after code review changes * expose only postinstall.js script * Replace _openspec "$@" with compdef in zsh-generator.ts to prevent execution during load * Update test/commands/completion.test.ts Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> * - Fix dispatcher to use $words instead of $line for subcommand routing - Add __complete endpoint with tab-separated output for safe parsing - Replace brittle awk parsing with __complete in completion helpers - Add uninstall confirmation prompt with --yes flag to skip - Prefer $ZSH env var for Oh My Zsh detection before dir check - Add fpath verification guidance for OMZ installations - Update cli-completion spec to document generate subcommand * improve shell detection and installation handling - Return structured result from detectShell() with shell and detected name - Detect already-installed completions and skip reinstall - Add update detection with automatic backup of previous version - Add debug logging to silent catch blocks for diagnostics - Quote fpath directories to handle paths with spaces - Verify Oh My Zsh fpath configuration and add to .zshrc if needed - Show helpful error for detected but unsupported shells - Update all tests for new detection API --------- Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> Co-authored-by: Tabish Bidiwale <30385142+TabishB@users.noreply.github.com>
270 lines
9.1 KiB
TypeScript
270 lines
9.1 KiB
TypeScript
import { describe, it, expect, beforeEach, vi, afterEach } from 'vitest';
|
|
import { CompletionCommand } from '../../src/commands/completion.js';
|
|
import * as shellDetection from '../../src/utils/shell-detection.js';
|
|
|
|
// Mock the shell detection module
|
|
vi.mock('../../src/utils/shell-detection.js', () => ({
|
|
detectShell: vi.fn(),
|
|
}));
|
|
|
|
// Mock the ZshInstaller
|
|
vi.mock('../../src/core/completions/installers/zsh-installer.js', () => ({
|
|
ZshInstaller: vi.fn().mockImplementation(() => ({
|
|
install: vi.fn().mockResolvedValue({
|
|
success: true,
|
|
installedPath: '/home/user/.oh-my-zsh/completions/_openspec',
|
|
isOhMyZsh: true,
|
|
message: 'Completion script installed successfully for Oh My Zsh',
|
|
instructions: [
|
|
'Completion script installed to Oh My Zsh completions directory.',
|
|
'Restart your shell or run: exec zsh',
|
|
'Completions should activate automatically.',
|
|
],
|
|
}),
|
|
uninstall: vi.fn().mockResolvedValue({
|
|
success: true,
|
|
message: 'Completion script removed from /home/user/.oh-my-zsh/completions/_openspec',
|
|
}),
|
|
})),
|
|
}));
|
|
|
|
describe('CompletionCommand', () => {
|
|
let command: CompletionCommand;
|
|
let consoleLogSpy: any;
|
|
let consoleErrorSpy: any;
|
|
|
|
beforeEach(() => {
|
|
command = new CompletionCommand();
|
|
consoleLogSpy = vi.spyOn(console, 'log').mockImplementation(() => {});
|
|
consoleErrorSpy = vi.spyOn(console, 'error').mockImplementation(() => {});
|
|
process.exitCode = 0;
|
|
});
|
|
|
|
afterEach(() => {
|
|
consoleLogSpy.mockRestore();
|
|
consoleErrorSpy.mockRestore();
|
|
vi.clearAllMocks();
|
|
});
|
|
|
|
describe('generate subcommand', () => {
|
|
it('should generate Zsh completion script to stdout', async () => {
|
|
await command.generate({ shell: 'zsh' });
|
|
|
|
expect(consoleLogSpy).toHaveBeenCalled();
|
|
const output = consoleLogSpy.mock.calls[0][0];
|
|
expect(output).toContain('#compdef openspec');
|
|
expect(output).toContain('_openspec() {');
|
|
});
|
|
|
|
it('should auto-detect Zsh shell when no shell specified', async () => {
|
|
vi.mocked(shellDetection.detectShell).mockReturnValue({ shell: 'zsh', detected: 'zsh' });
|
|
|
|
await command.generate({});
|
|
|
|
expect(consoleLogSpy).toHaveBeenCalled();
|
|
const output = consoleLogSpy.mock.calls[0][0];
|
|
expect(output).toContain('#compdef openspec');
|
|
});
|
|
|
|
it('should show error when shell cannot be auto-detected', async () => {
|
|
vi.mocked(shellDetection.detectShell).mockReturnValue({ shell: undefined, detected: undefined });
|
|
|
|
await command.generate({});
|
|
|
|
expect(consoleErrorSpy).toHaveBeenCalledWith(
|
|
'Error: Could not auto-detect shell. Please specify shell explicitly.'
|
|
);
|
|
expect(process.exitCode).toBe(1);
|
|
});
|
|
|
|
it('should show error for unsupported shell', async () => {
|
|
await command.generate({ shell: 'bash' });
|
|
|
|
expect(consoleErrorSpy).toHaveBeenCalledWith(
|
|
"Error: Shell 'bash' is not supported yet. Currently supported: zsh"
|
|
);
|
|
expect(process.exitCode).toBe(1);
|
|
});
|
|
|
|
it('should handle shell parameter case-insensitively', async () => {
|
|
await command.generate({ shell: 'ZSH' });
|
|
|
|
expect(consoleLogSpy).toHaveBeenCalled();
|
|
const output = consoleLogSpy.mock.calls[0][0];
|
|
expect(output).toContain('#compdef openspec');
|
|
});
|
|
});
|
|
|
|
describe('install subcommand', () => {
|
|
it('should install Zsh completion script', async () => {
|
|
await command.install({ shell: 'zsh' });
|
|
|
|
expect(consoleLogSpy).toHaveBeenCalledWith(
|
|
expect.stringContaining('Completion script installed successfully')
|
|
);
|
|
expect(process.exitCode).toBe(0);
|
|
});
|
|
|
|
it('should show verbose output when --verbose flag is provided', async () => {
|
|
await command.install({ shell: 'zsh', verbose: true });
|
|
|
|
expect(consoleLogSpy).toHaveBeenCalledWith(
|
|
expect.stringContaining('Installed to:')
|
|
);
|
|
});
|
|
|
|
it('should auto-detect Zsh shell when no shell specified', async () => {
|
|
vi.mocked(shellDetection.detectShell).mockReturnValue({ shell: 'zsh', detected: 'zsh' });
|
|
|
|
await command.install({});
|
|
|
|
expect(consoleLogSpy).toHaveBeenCalledWith(
|
|
expect.stringContaining('Completion script installed successfully')
|
|
);
|
|
});
|
|
|
|
it('should show error when shell cannot be auto-detected', async () => {
|
|
vi.mocked(shellDetection.detectShell).mockReturnValue({ shell: undefined, detected: undefined });
|
|
|
|
await command.install({});
|
|
|
|
expect(consoleErrorSpy).toHaveBeenCalledWith(
|
|
'Error: Could not auto-detect shell. Please specify shell explicitly.'
|
|
);
|
|
expect(process.exitCode).toBe(1);
|
|
});
|
|
|
|
it('should show error for unsupported shell', async () => {
|
|
await command.install({ shell: 'fish' });
|
|
|
|
expect(consoleErrorSpy).toHaveBeenCalledWith(
|
|
"Error: Shell 'fish' is not supported yet. Currently supported: zsh"
|
|
);
|
|
expect(process.exitCode).toBe(1);
|
|
});
|
|
|
|
it('should display installation instructions', async () => {
|
|
await command.install({ shell: 'zsh' });
|
|
|
|
expect(consoleLogSpy).toHaveBeenCalledWith(
|
|
expect.stringContaining('Restart your shell or run: exec zsh')
|
|
);
|
|
});
|
|
});
|
|
|
|
describe('uninstall subcommand', () => {
|
|
it('should uninstall Zsh completion script', async () => {
|
|
await command.uninstall({ shell: 'zsh', yes: true });
|
|
|
|
expect(consoleLogSpy).toHaveBeenCalledWith(
|
|
expect.stringContaining('Completion script removed')
|
|
);
|
|
expect(process.exitCode).toBe(0);
|
|
});
|
|
|
|
it('should auto-detect Zsh shell when no shell specified', async () => {
|
|
vi.mocked(shellDetection.detectShell).mockReturnValue({ shell: 'zsh', detected: 'zsh' });
|
|
|
|
await command.uninstall({ yes: true });
|
|
|
|
expect(consoleLogSpy).toHaveBeenCalledWith(
|
|
expect.stringContaining('Completion script removed')
|
|
);
|
|
});
|
|
|
|
it('should show error when shell cannot be auto-detected', async () => {
|
|
vi.mocked(shellDetection.detectShell).mockReturnValue({ shell: undefined, detected: undefined });
|
|
|
|
await command.uninstall({ yes: true });
|
|
|
|
expect(consoleErrorSpy).toHaveBeenCalledWith(
|
|
'Error: Could not auto-detect shell. Please specify shell explicitly.'
|
|
);
|
|
expect(process.exitCode).toBe(1);
|
|
});
|
|
|
|
it('should show error for unsupported shell', async () => {
|
|
await command.uninstall({ shell: 'powershell', yes: true });
|
|
|
|
expect(consoleErrorSpy).toHaveBeenCalledWith(
|
|
"Error: Shell 'powershell' is not supported yet. Currently supported: zsh"
|
|
);
|
|
expect(process.exitCode).toBe(1);
|
|
});
|
|
});
|
|
|
|
describe('error handling', () => {
|
|
it('should handle installation failures gracefully', async () => {
|
|
const { ZshInstaller } = await import('../../src/core/completions/installers/zsh-installer.js');
|
|
vi.mocked(ZshInstaller).mockImplementationOnce(() => ({
|
|
install: vi.fn().mockResolvedValue({
|
|
success: false,
|
|
isOhMyZsh: false,
|
|
message: 'Permission denied',
|
|
}),
|
|
uninstall: vi.fn(),
|
|
isInstalled: vi.fn(),
|
|
getInstallationInfo: vi.fn(),
|
|
isOhMyZshInstalled: vi.fn(),
|
|
getInstallationPath: vi.fn(),
|
|
backupExistingFile: vi.fn(),
|
|
} as any));
|
|
|
|
const cmd = new CompletionCommand();
|
|
await cmd.install({ shell: 'zsh' });
|
|
|
|
expect(consoleErrorSpy).toHaveBeenCalledWith(
|
|
expect.stringContaining('Permission denied')
|
|
);
|
|
expect(process.exitCode).toBe(1);
|
|
});
|
|
|
|
it('should handle uninstallation failures gracefully', async () => {
|
|
const { ZshInstaller } = await import('../../src/core/completions/installers/zsh-installer.js');
|
|
vi.mocked(ZshInstaller).mockImplementationOnce(() => ({
|
|
install: vi.fn(),
|
|
uninstall: vi.fn().mockResolvedValue({
|
|
success: false,
|
|
message: 'Completion script is not installed',
|
|
}),
|
|
isInstalled: vi.fn(),
|
|
getInstallationInfo: vi.fn(),
|
|
isOhMyZshInstalled: vi.fn(),
|
|
getInstallationPath: vi.fn(),
|
|
backupExistingFile: vi.fn(),
|
|
} as any));
|
|
|
|
const cmd = new CompletionCommand();
|
|
await cmd.uninstall({ shell: 'zsh', yes: true });
|
|
|
|
expect(consoleErrorSpy).toHaveBeenCalledWith(
|
|
expect.stringContaining('Completion script is not installed')
|
|
);
|
|
expect(process.exitCode).toBe(1);
|
|
});
|
|
});
|
|
|
|
describe('shell detection integration', () => {
|
|
it('should show appropriate error when detected shell is unsupported', async () => {
|
|
vi.mocked(shellDetection.detectShell).mockReturnValue({ shell: undefined, detected: 'bash' });
|
|
|
|
await command.generate({});
|
|
|
|
expect(consoleErrorSpy).toHaveBeenCalledWith(
|
|
"Error: Shell 'bash' is not supported yet. Currently supported: zsh"
|
|
);
|
|
expect(process.exitCode).toBe(1);
|
|
});
|
|
|
|
it('should respect explicit shell parameter over auto-detection', async () => {
|
|
vi.mocked(shellDetection.detectShell).mockReturnValue({ shell: undefined, detected: 'bash' });
|
|
|
|
await command.generate({ shell: 'zsh' });
|
|
|
|
expect(consoleLogSpy).toHaveBeenCalled();
|
|
const output = consoleLogSpy.mock.calls[0][0];
|
|
expect(output).toContain('#compdef openspec');
|
|
});
|
|
});
|
|
});
|