@fission-ai/openspec
Version:
AI-native system for spec-driven development
327 lines • 12.9 kB
JavaScript
import { promises as fs } from 'fs';
import path from 'path';
import os from 'os';
/**
* Installer for PowerShell completion scripts.
* Works with both Windows PowerShell 5.1 and PowerShell Core 7+
*/
export class PowerShellInstaller {
homeDir;
/**
* Markers for PowerShell profile configuration management
*/
PROFILE_MARKERS = {
start: '# OPENSPEC:START',
end: '# OPENSPEC:END',
};
constructor(homeDir = os.homedir()) {
this.homeDir = homeDir;
}
/**
* Get PowerShell profile path
* Prefers $PROFILE environment variable, falls back to platform defaults
*
* @returns Profile path
*/
getProfilePath() {
// Check $PROFILE environment variable (set when running in PowerShell)
if (process.env.PROFILE) {
return process.env.PROFILE;
}
// Fall back to platform-specific defaults
if (process.platform === 'win32') {
// Windows: Documents/PowerShell/Microsoft.PowerShell_profile.ps1
return path.join(this.homeDir, 'Documents', 'PowerShell', 'Microsoft.PowerShell_profile.ps1');
}
else {
// macOS/Linux: .config/powershell/Microsoft.PowerShell_profile.ps1
return path.join(this.homeDir, '.config', 'powershell', 'Microsoft.PowerShell_profile.ps1');
}
}
/**
* Get all PowerShell profile paths to configure.
* On Windows, returns both PowerShell Core and Windows PowerShell 5.1 paths.
* On Unix, returns PowerShell Core path only.
*/
getAllProfilePaths() {
// If PROFILE env var is set, use only that path
if (process.env.PROFILE) {
return [process.env.PROFILE];
}
if (process.platform === 'win32') {
return [
// PowerShell Core 6+ (cross-platform)
path.join(this.homeDir, 'Documents', 'PowerShell', 'Microsoft.PowerShell_profile.ps1'),
// Windows PowerShell 5.1 (Windows-only)
path.join(this.homeDir, 'Documents', 'WindowsPowerShell', 'Microsoft.PowerShell_profile.ps1'),
];
}
else {
// Unix systems: PowerShell Core only
return [path.join(this.homeDir, '.config', 'powershell', 'Microsoft.PowerShell_profile.ps1')];
}
}
/**
* Get the installation path for the completion script
*
* @returns Installation path
*/
getInstallationPath() {
const profilePath = this.getProfilePath();
const profileDir = path.dirname(profilePath);
return path.join(profileDir, 'OpenSpecCompletion.ps1');
}
/**
* 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;
}
}
/**
* Generate PowerShell profile configuration content
*
* @param scriptPath - Path to the completion script
* @returns Configuration content
*/
generateProfileConfig(scriptPath) {
return [
'# OpenSpec shell completions configuration',
`if (Test-Path "${scriptPath}") {`,
` . "${scriptPath}"`,
'}',
].join('\n');
}
/**
* Configure PowerShell profile to source the completion script
*
* @param scriptPath - Path to the completion script
* @returns true if configured successfully, false otherwise
*/
async configureProfile(scriptPath) {
const profilePaths = this.getAllProfilePaths();
let anyConfigured = false;
for (const profilePath of profilePaths) {
try {
// Create profile file if it doesn't exist
const profileDir = path.dirname(profilePath);
await fs.mkdir(profileDir, { recursive: true });
let profileContent = '';
try {
profileContent = await fs.readFile(profilePath, 'utf-8');
}
catch {
// Profile doesn't exist yet, that's fine
}
// Check if already configured
const scriptLine = `. "${scriptPath}"`;
if (profileContent.includes(scriptLine)) {
continue; // Already configured, skip
}
// Add OpenSpec completion configuration with markers
const openspecBlock = [
'',
'# OPENSPEC:START - OpenSpec completion (managed block, do not edit manually)',
scriptLine,
'# OPENSPEC:END',
'',
].join('\n');
const newContent = profileContent + openspecBlock;
await fs.writeFile(profilePath, newContent, 'utf-8');
anyConfigured = true;
}
catch (error) {
// Continue to next profile if this one fails
console.warn(`Warning: Could not configure ${profilePath}: ${error}`);
}
}
return anyConfigured;
}
/**
* Remove PowerShell profile configuration
* Used during uninstallation
*
* @returns true if removed successfully, false otherwise
*/
async removeProfileConfig() {
const profilePaths = this.getAllProfilePaths();
let anyRemoved = false;
for (const profilePath of profilePaths) {
try {
// Read profile content
let profileContent;
try {
profileContent = await fs.readFile(profilePath, 'utf-8');
}
catch {
continue; // Profile doesn't exist, nothing to remove
}
// Remove OPENSPEC:START -> OPENSPEC:END block
const startMarker = '# OPENSPEC:START';
const endMarker = '# OPENSPEC:END';
const startIndex = profileContent.indexOf(startMarker);
if (startIndex === -1) {
continue; // No OpenSpec block found
}
const endIndex = profileContent.indexOf(endMarker, startIndex);
if (endIndex === -1) {
console.warn(`Warning: Found start marker but no end marker in ${profilePath}`);
continue;
}
// Remove the block (including markers and surrounding newlines)
const beforeBlock = profileContent.substring(0, startIndex);
const afterBlock = profileContent.substring(endIndex + endMarker.length);
// Clean up extra newlines
const newContent = (beforeBlock.trimEnd() + '\n' + afterBlock.trimStart()).trim() + '\n';
await fs.writeFile(profilePath, newContent, 'utf-8');
anyRemoved = true;
}
catch (error) {
console.warn(`Warning: Could not clean ${profilePath}: ${error}`);
}
}
return anyRemoved;
}
/**
* 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 = this.getInstallationPath();
// 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 restarting PowerShell or run: . $PROFILE',
],
};
}
// 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 PowerShell profile
const profileConfigured = await this.configureProfile(targetPath);
// Generate instructions if profile wasn't auto-configured
const instructions = profileConfigured ? undefined : this.generateInstructions(targetPath);
// Determine appropriate message
let message;
if (isUpdate) {
message = backupPath
? 'Completion script updated successfully (previous version backed up)'
: 'Completion script updated successfully';
}
else {
message = profileConfigured
? 'Completion script installed and PowerShell profile configured successfully'
: 'Completion script installed successfully for PowerShell';
}
return {
success: true,
installedPath: targetPath,
backupPath,
profileConfigured,
message,
instructions,
};
}
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 profilePath = this.getProfilePath();
return [
'Completion script installed successfully.',
'',
`To enable completions, add the following to your PowerShell profile (${profilePath}):`,
'',
' # Source OpenSpec completions',
` if (Test-Path "${installedPath}") {`,
` . "${installedPath}"`,
' }',
'',
'Then restart PowerShell or run: . $PROFILE',
];
}
/**
* 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 = 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 profile configuration
await this.removeProfileConfig();
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=powershell-installer.js.map