@fission-ai/openspec
Version:
AI-native system for spec-driven development
318 lines • 12.2 kB
JavaScript
import { promises as fs } from 'fs';
import path from 'path';
import os from 'os';
import { FileSystemUtils } from '../../../utils/file-system.js';
/**
* Installer for Bash completion scripts.
* Supports bash-completion package and standalone installations.
*/
export class BashInstaller {
homeDir;
/**
* Markers for .bashrc configuration management
*/
BASHRC_MARKERS = {
start: '# OPENSPEC:START',
end: '# OPENSPEC:END',
};
constructor(homeDir = os.homedir()) {
this.homeDir = homeDir;
}
/**
* Check if bash-completion is installed
*
* @returns true if bash-completion directories exist
*/
async isBashCompletionInstalled() {
const paths = [
'/usr/share/bash-completion', // Linux system-wide
'/usr/local/share/bash-completion', // Homebrew Intel (main)
'/opt/homebrew/etc/bash_completion.d', // Homebrew Apple Silicon
'/usr/local/etc/bash_completion.d', // Homebrew Intel (alt path)
'/etc/bash_completion.d', // Legacy fallback
];
for (const p of paths) {
try {
const stat = await fs.stat(p);
if (stat.isDirectory()) {
return true;
}
}
catch {
// Continue checking other paths
}
}
return false;
}
/**
* Get the appropriate installation path for the completion script
*
* @returns Installation path
*/
async getInstallationPath() {
// Try user-local bash-completion directory first
const localCompletionDir = path.join(this.homeDir, '.local', 'share', 'bash-completion', 'completions');
// For user installation, use local directory
return path.join(localCompletionDir, 'openspec');
}
/**
* Backup an existing completion file if it exists
*
* @param targetPath - Path to the file to backup
* @returns Path to the backup file, or undefined if no backup was needed
*/
async backupExistingFile(targetPath) {
try {
await fs.access(targetPath);
// File exists, create a backup
const timestamp = new Date().toISOString().replace(/[:.]/g, '-');
const backupPath = `${targetPath}.backup-${timestamp}`;
await fs.copyFile(targetPath, backupPath);
return backupPath;
}
catch {
// File doesn't exist, no backup needed
return undefined;
}
}
/**
* Get the path to .bashrc file
*
* @returns Path to .bashrc
*/
getBashrcPath() {
return path.join(this.homeDir, '.bashrc');
}
/**
* Generate .bashrc configuration content
*
* @param completionsDir - Directory containing completion scripts
* @returns Configuration content
*/
generateBashrcConfig(completionsDir) {
return [
'# OpenSpec shell completions configuration',
`if [ -d "${completionsDir}" ]; then`,
` for f in "${completionsDir}"/*; do`,
' [ -f "$f" ] && . "$f"',
' done',
'fi',
].join('\n');
}
/**
* Configure .bashrc to enable completions
*
* @param completionsDir - Directory containing completion scripts
* @returns true if configured successfully, false otherwise
*/
async configureBashrc(completionsDir) {
// Check if auto-configuration is disabled
if (process.env.OPENSPEC_NO_AUTO_CONFIG === '1') {
return false;
}
try {
const bashrcPath = this.getBashrcPath();
const config = this.generateBashrcConfig(completionsDir);
// Check write permissions
const canWrite = await FileSystemUtils.canWriteFile(bashrcPath);
if (!canWrite) {
return false;
}
// Use marker-based update
await FileSystemUtils.updateFileWithMarkers(bashrcPath, config, this.BASHRC_MARKERS.start, this.BASHRC_MARKERS.end);
return true;
}
catch (error) {
// Fail gracefully - don't break installation
console.debug(`Unable to configure .bashrc for completions: ${error.message}`);
return false;
}
}
/**
* Remove .bashrc configuration
* Used during uninstallation
*
* @returns true if removed successfully, false otherwise
*/
async removeBashrcConfig() {
try {
const bashrcPath = this.getBashrcPath();
// Check if file exists
try {
await fs.access(bashrcPath);
}
catch {
// File doesn't exist, nothing to remove
return true;
}
// Read file content
const content = await fs.readFile(bashrcPath, 'utf-8');
// Check if markers exist
if (!content.includes(this.BASHRC_MARKERS.start) || !content.includes(this.BASHRC_MARKERS.end)) {
// Markers don't exist, nothing to remove
return true;
}
// Remove content between markers (including markers)
const lines = content.split('\n');
const startIndex = lines.findIndex((line) => line.trim() === this.BASHRC_MARKERS.start);
const endIndex = lines.findIndex((line) => line.trim() === this.BASHRC_MARKERS.end);
if (startIndex === -1 || endIndex === -1 || endIndex < startIndex) {
// Invalid marker placement
return false;
}
// Remove lines between markers (inclusive)
lines.splice(startIndex, endIndex - startIndex + 1);
// Remove trailing empty lines
while (lines.length > 0 && lines[lines.length - 1].trim() === '') {
lines.pop();
}
// Write back
await fs.writeFile(bashrcPath, lines.join('\n'), 'utf-8');
return true;
}
catch (error) {
// Fail gracefully
console.debug(`Unable to remove .bashrc configuration: ${error.message}`);
return false;
}
}
/**
* Install the completion script
*
* @param completionScript - The completion script content to install
* @returns Installation result with status and instructions
*/
async install(completionScript) {
try {
const targetPath = await this.getInstallationPath();
// Check for bash-completion package
const hasBashCompletion = await this.isBashCompletionInstalled();
// Check if already installed with same content
let isUpdate = false;
try {
const existingContent = await fs.readFile(targetPath, 'utf-8');
if (existingContent === completionScript) {
// Already installed and up to date
return {
success: true,
installedPath: targetPath,
message: 'Completion script is already installed (up to date)',
instructions: [
'The completion script is already installed and up to date.',
'If completions are not working, try: exec bash',
],
};
}
// File exists but content is different - this is an update
isUpdate = true;
}
catch (error) {
// File doesn't exist or can't be read, proceed with installation
console.debug(`Unable to read existing completion file at ${targetPath}: ${error.message}`);
}
// Ensure the directory exists
const targetDir = path.dirname(targetPath);
await fs.mkdir(targetDir, { recursive: true });
// Backup existing file if updating
const backupPath = isUpdate ? await this.backupExistingFile(targetPath) : undefined;
// Write the completion script
await fs.writeFile(targetPath, completionScript, 'utf-8');
// Auto-configure .bashrc
const bashrcConfigured = await this.configureBashrc(targetDir);
// Generate instructions if .bashrc wasn't auto-configured
const instructions = bashrcConfigured ? undefined : this.generateInstructions(targetPath);
// Collect warnings
const warnings = [];
if (!hasBashCompletion) {
warnings.push('⚠️ Warning: bash-completion package not detected', '', 'The completion script requires bash-completion to function.', 'Install it with:', ' brew install bash-completion@2', '', 'Then add to your ~/.bash_profile:', ' [[ -r "/opt/homebrew/etc/profile.d/bash_completion.sh" ]] && . "/opt/homebrew/etc/profile.d/bash_completion.sh"');
}
// Determine appropriate message
let message;
if (isUpdate) {
message = backupPath
? 'Completion script updated successfully (previous version backed up)'
: 'Completion script updated successfully';
}
else {
message = bashrcConfigured
? 'Completion script installed and .bashrc configured successfully'
: 'Completion script installed successfully for Bash';
}
return {
success: true,
installedPath: targetPath,
backupPath,
bashrcConfigured,
message,
instructions,
warnings: warnings.length > 0 ? warnings : undefined,
};
}
catch (error) {
return {
success: false,
message: `Failed to install completion script: ${error instanceof Error ? error.message : String(error)}`,
};
}
}
/**
* Generate user instructions for enabling completions
*
* @param installedPath - Path where the script was installed
* @returns Array of instruction strings
*/
generateInstructions(installedPath) {
const completionsDir = path.dirname(installedPath);
return [
'Completion script installed successfully.',
'',
'To enable completions, add the following to your ~/.bashrc file:',
'',
` # Source OpenSpec completions`,
` if [ -d "${completionsDir}" ]; then`,
` for f in "${completionsDir}"/*; do`,
' [ -f "$f" ] && . "$f"',
' done',
' fi',
'',
'Then restart your shell or run: exec bash',
];
}
/**
* Uninstall the completion script
*
* @param options - Optional uninstall options
* @param options.yes - Skip confirmation prompt (handled by command layer)
* @returns Uninstallation result
*/
async uninstall(options) {
try {
const targetPath = await this.getInstallationPath();
// Check if installed
try {
await fs.access(targetPath);
}
catch {
return {
success: false,
message: 'Completion script is not installed',
};
}
// Remove the completion script
await fs.unlink(targetPath);
// Remove .bashrc configuration
await this.removeBashrcConfig();
return {
success: true,
message: 'Completion script uninstalled successfully',
};
}
catch (error) {
return {
success: false,
message: `Failed to uninstall completion script: ${error instanceof Error ? error.message : String(error)}`,
};
}
}
}
//# sourceMappingURL=bash-installer.js.map