gitspace 0.2.0-rc.20 → 0.2.0-rc.21

package/src/utils/run-workspace-scripts.ts

@@ -1,355 +0,0 @@
-/**
- * Workspace script execution with phase tracking
- *
- * Consolidates the logic for running pre/setup/select scripts with
- * proper error handling and phase identification.
- */
-
-import { join } from 'path';
-import { discoverScripts, runScriptsInTerminal, type RunScriptsOptions } from './run-scripts';
-import {
-  buildBundleStepFingerprints,
-  buildSetupState,
-  createEmptyWorkspaceLockState,
-  fingerprintValue,
-  getBundleStepKey,
-  readWorkspaceLockState,
-  type WorkspaceLockState,
-  writeWorkspaceLockState,
-} from './workspace-state';
-import { readProjectConfig } from '../core/config';
-import { detectBundleChanges } from '../core/bundle-refresh';
-import { getProjectSecrets } from './secrets';
-import { logger } from './logger';
-import type { ConfirmStepResult, OnboardingStep, SpacesBundle } from '../types/bundle.js';
-import type { WorkspaceScriptPhase } from '../types/script-phase';
-
-export type ScriptPhase = WorkspaceScriptPhase;
-
-export interface RunWorkspaceScriptsOptions {
-  projectName: string;
-  workspacePath: string;
-  workspaceName: string;
-  repository: string;
-  /** If true, skip pre/setup scripts on first-time workspace access. */
-  noSetup?: boolean;
-  /** If true, scripts can prompt for input. If false (default), stdin is closed. */
-  interactive?: boolean;
-  /**
-   * Callback to receive ANSI output as it arrives (for TUI/Web terminal display).
-   * Called with raw output from stdout/stderr.
-   */
-  onOutput?: (data: Buffer) => void;
-  /**
-   * Callback when a new phase starts (for displaying phase name in UI).
-   */
-  onPhaseStart?: (phase: ScriptPhase) => void;
-  /** Script execution policy for session attach attempts. */
-  scriptPolicy?: 'auto' | 'skip';
-}
-
-export type RunWorkspaceScriptsResult =
-  | { success: true }
-  | { success: false; phase: ScriptPhase; error: string };
-
-/**
- * Run workspace scripts based on setup state.
- *
- * - If setup has already been run: runs select scripts only
- * - If first time: runs pre scripts, then setup scripts, then marks setup complete
- *
- * Returns success or failure with the specific phase that failed.
- */
-export async function runWorkspaceScripts(
-  options: RunWorkspaceScriptsOptions
-): Promise<RunWorkspaceScriptsResult> {
-  const {
-    projectName,
-    workspacePath,
-    workspaceName,
-    repository,
-    noSetup = false,
-    interactive = false,
-    onOutput,
-    onPhaseStart,
-    scriptPolicy = 'auto',
-  } = options;
-
-  const changes = detectBundleChanges(projectName, workspacePath);
-  if (changes.parseError) {
-    return {
-      success: false,
-      phase: 'pre',
-      error: changes.parseError,
-    };
-  }
-
-  const currentBundle = changes.currentBundle;
-  const bundleHash = changes.currentHash;
-
-  // Read project config for bundle values and secrets
-  const config = readProjectConfig(projectName);
-
-  const bundleSecretKeys = new Set(config.bundleSecretKeys || []);
-  for (const step of currentBundle?.onboarding || []) {
-    if (step.type === 'secret') {
-      bundleSecretKeys.add(step.configKey);
-    }
-  }
-
-  const bundleSecrets = bundleSecretKeys.size > 0
-    ? await getProjectSecrets(projectName, [...bundleSecretKeys])
-    : {};
-
-  // Build script options
-  const scriptOptions: RunScriptsOptions = {
-    bundleValues: config.bundleValues,
-    bundleSecrets,
-    nonInteractive: !interactive,
-    onOutput,
-  };
-
-  const existingLock = readWorkspaceLockState(workspacePath) || createEmptyWorkspaceLockState();
-  const stepFingerprints = currentBundle ? buildBundleStepFingerprints(currentBundle) : {};
-
-  const setupNeeded = scriptPolicy !== 'skip' && !noSetup && shouldRunSetup({
-    lock: existingLock,
-    bundle: currentBundle,
-    bundleHash,
-    stepFingerprints,
-    bundleValues: config.bundleValues || {},
-    bundleSecrets,
-    confirmHistory: config.bundleConfirmHistory || {},
-  });
-
-  let lockState: WorkspaceLockState = {
-    ...existingLock,
-  };
-
-  if (setupNeeded) {
-    const preScriptsDir = join(workspacePath, '.gitspace', 'scripts', 'pre');
-    const preScripts = discoverScripts(preScriptsDir);
-    if (preScripts.length > 0) {
-      logger.warning('Bundle script phase "pre" is deprecated. Move scripts into ordered setup scripts.');
-    }
-
-    let preScriptsSucceeded = false;
-    try {
-      onPhaseStart?.('pre');
-      await runScriptsInTerminal(preScriptsDir, workspacePath, workspaceName, repository, scriptOptions);
-      preScriptsSucceeded = true;
-
-      onPhaseStart?.('setup');
-      const setupScriptsDir = join(workspacePath, '.gitspace', 'scripts', 'setup');
-      await runScriptsInTerminal(setupScriptsDir, workspacePath, workspaceName, repository, scriptOptions);
-
-      const confirmResults = resolveCurrentConfirmResults(
-        currentBundle,
-        stepFingerprints,
-        config.bundleConfirmHistory || {}
-      );
-
-      lockState = {
-        ...lockState,
-        bundle: bundleHash
-          ? {
-              bundleHash,
-              stepFingerprints,
-            }
-          : lockState.bundle,
-        setup: buildSetupState({
-          bundle: currentBundle,
-          bundleHash,
-          stepFingerprints,
-          bundleValues: config.bundleValues || {},
-          bundleSecrets,
-          confirmResults,
-        }),
-      };
-      writeWorkspaceLockState(workspacePath, lockState);
-    } catch (error) {
-      const phase: ScriptPhase = preScriptsSucceeded ? 'setup' : 'pre';
-      const message = error instanceof Error ? error.message : String(error);
-      lockState = {
-        ...lockState,
-        bundle: bundleHash
-          ? {
-              bundleHash,
-              stepFingerprints,
-            }
-          : lockState.bundle,
-        setup: {
-          ...lockState.setup,
-          status: 'failed',
-          ranAt: new Date().toISOString(),
-          error: message,
-        },
-      };
-      writeWorkspaceLockState(workspacePath, lockState);
-      return { success: false, phase, error: message };
-    }
-  }
-
-  if (scriptPolicy === 'skip') {
-    return { success: true };
-  }
-
-  // Always run select scripts on terminal attach (new session path).
-  const selectScriptsDir = join(workspacePath, '.gitspace', 'scripts', 'select');
-  try {
-    onPhaseStart?.('select');
-    await runScriptsInTerminal(selectScriptsDir, workspacePath, workspaceName, repository, scriptOptions);
-    lockState = {
-      ...lockState,
-      select: {
-        status: 'success',
-        ranAt: new Date().toISOString(),
-      },
-    };
-    writeWorkspaceLockState(workspacePath, lockState);
-    return { success: true };
-  } catch (error) {
-    const message = error instanceof Error ? error.message : String(error);
-    lockState = {
-      ...lockState,
-      select: {
-        status: 'failed',
-        ranAt: new Date().toISOString(),
-        error: message,
-      },
-    };
-    writeWorkspaceLockState(workspacePath, lockState);
-    return { success: false, phase: 'select', error: message };
-  }
-}
-
-function resolveCurrentConfirmResults(
-  bundle: SpacesBundle | undefined,
-  stepFingerprints: Record<string, string>,
-  confirmHistory: Record<string, { status: ConfirmStepResult['status'] }>
-): Record<string, ConfirmStepResult> {
-  const results: Record<string, ConfirmStepResult> = {};
-  if (!bundle) {
-    return results;
-  }
-
-  for (const step of bundle.onboarding || []) {
-    if (step.type !== 'confirm') {
-      continue;
-    }
-
-    const key = getBundleStepKey(step);
-    const fingerprint = stepFingerprints[key];
-    if (!fingerprint) {
-      continue;
-    }
-
-    const history = confirmHistory[fingerprint];
-    if (!history) {
-      continue;
-    }
-
-    results[step.id] = {
-      status: history.status,
-      checkCommand: step.checkCommand,
-    };
-  }
-
-  return results;
-}
-
-interface SetupDecisionOptions {
-  lock: WorkspaceLockState;
-  bundle: SpacesBundle | undefined;
-  bundleHash: string | undefined;
-  stepFingerprints: Record<string, string>;
-  bundleValues: Record<string, string>;
-  bundleSecrets: Record<string, string>;
-  confirmHistory: Record<string, { status: ConfirmStepResult['status'] }>;
-}
-
-function shouldRunSetup(options: SetupDecisionOptions): boolean {
-  const {
-    lock,
-    bundle,
-    bundleHash,
-    stepFingerprints,
-    bundleValues,
-    bundleSecrets,
-    confirmHistory,
-  } = options;
-
-  if (lock.setup.status !== 'success') {
-    return true;
-  }
-
-  if (!bundle) {
-    return false;
-  }
-
-  const previousBundle = lock.bundle;
-  if (!previousBundle || !bundleHash) {
-    return true;
-  }
-
-  const relevantSteps = getRelevantSetupSteps(bundle.onboarding || [], lock.setup.usedOptionalSteps);
-
-  for (const step of relevantSteps) {
-    const key = getBundleStepKey(step);
-    const currentStepFingerprint = stepFingerprints[key];
-    if (!currentStepFingerprint || previousBundle.stepFingerprints[key] !== currentStepFingerprint) {
-      return true;
-    }
-
-    if (step.type === 'input') {
-      const value = bundleValues[step.configKey] ?? '';
-      const currentValueFingerprint = fingerprintValue(value);
-      if (lock.setup.inputFingerprints[step.configKey] !== currentValueFingerprint) {
-        return true;
-      }
-      continue;
-    }
-
-    if (step.type === 'secret') {
-      const value = bundleSecrets[step.configKey] ?? '';
-      const currentSecretFingerprint = fingerprintValue(value);
-      if (lock.setup.secretFingerprints[step.configKey] !== currentSecretFingerprint) {
-        return true;
-      }
-      continue;
-    }
-
-    if (step.type === 'confirm') {
-      const previous = lock.setup.confirmsUsed[key];
-      if (!previous) {
-        continue;
-      }
-      const history = confirmHistory[currentStepFingerprint];
-      const currentStatus = history?.status;
-      if (previous.status !== currentStatus || previous.fingerprint !== currentStepFingerprint) {
-        return true;
-      }
-    }
-  }
-
-  return false;
-}
-
-function getRelevantSetupSteps(
-  steps: OnboardingStep[],
-  usedOptionalSteps: Record<string, true>
-): OnboardingStep[] {
-  return steps.filter((step) => {
-    const required = step.required !== false;
-    if (required) {
-      return step.type === 'input' || step.type === 'secret' || step.type === 'confirm';
-    }
-
-    const key = getBundleStepKey(step);
-    if (!usedOptionalSteps[key]) {
-      return false;
-    }
-
-    return step.type === 'input' || step.type === 'secret' || step.type === 'confirm';
-  });
-}

package/src/utils/sanitize.test.ts

@@ -1,149 +0,0 @@
-import { describe, expect, it } from 'bun:test';
-import {
-  sanitizeForFileSystem,
-  generateWorkspaceName,
-  isValidWorkspaceName,
-  isValidBranchName,
-  extractRepoName,
-} from './sanitize';
-
-describe('sanitizeForFileSystem', () => {
-  it('should convert slashes to hyphens', () => {
-    expect(sanitizeForFileSystem('fix/bla-bla-blah')).toBe('fix-bla-bla-blah');
-  });
-
-  it('should handle feature branch patterns', () => {
-    expect(sanitizeForFileSystem('feature/user-auth')).toBe('feature-user-auth');
-  });
-
-  it('should handle multiple slashes', () => {
-    expect(sanitizeForFileSystem('feature/auth/oauth')).toBe('feature-auth-oauth');
-  });
-
-  it('should convert to lowercase', () => {
-    expect(sanitizeForFileSystem('Fix/BLA-Blah')).toBe('fix-bla-blah');
-  });
-
-  it('should collapse multiple hyphens', () => {
-    expect(sanitizeForFileSystem('fix//double-slash')).toBe('fix-double-slash');
-  });
-
-  it('should remove leading and trailing hyphens', () => {
-    expect(sanitizeForFileSystem('/leading-slash')).toBe('leading-slash');
-    expect(sanitizeForFileSystem('trailing-slash/')).toBe('trailing-slash');
-  });
-
-  it('should handle spaces', () => {
-    expect(sanitizeForFileSystem('fix login bug')).toBe('fix-login-bug');
-  });
-
-  it('should handle special characters', () => {
-    expect(sanitizeForFileSystem('fix!@#$%bug')).toBe('fix-bug');
-  });
-
-  it('should preserve underscores', () => {
-    expect(sanitizeForFileSystem('fix_login_bug')).toBe('fix_login_bug');
-  });
-
-  it('should return empty string for input with no valid characters', () => {
-    expect(sanitizeForFileSystem('!@#$%')).toBe('');
-  });
-
-  it('should limit length to 100 characters', () => {
-    const longName = 'a'.repeat(150);
-    expect(sanitizeForFileSystem(longName).length).toBe(100);
-  });
-});
-
-describe('isValidWorkspaceName', () => {
-  it('should accept valid names', () => {
-    expect(isValidWorkspaceName('my-workspace')).toBe(true);
-    expect(isValidWorkspaceName('workspace123')).toBe(true);
-    expect(isValidWorkspaceName('my_workspace')).toBe(true);
-  });
-
-  it('should reject names with spaces', () => {
-    expect(isValidWorkspaceName('my workspace')).toBe(false);
-  });
-
-  it('should reject names with slashes', () => {
-    expect(isValidWorkspaceName('fix/bug')).toBe(false);
-  });
-
-  it('should reject empty names', () => {
-    expect(isValidWorkspaceName('')).toBe(false);
-  });
-
-  it('should reject names starting or ending with hyphens', () => {
-    expect(isValidWorkspaceName('-workspace')).toBe(false);
-    expect(isValidWorkspaceName('workspace-')).toBe(false);
-  });
-});
-
-describe('isValidBranchName', () => {
-  it('should accept valid branch names with slashes', () => {
-    expect(isValidBranchName('fix/bla-bla-blah')).toBe(true);
-    expect(isValidBranchName('feature/user-auth')).toBe(true);
-  });
-
-  it('should accept simple branch names', () => {
-    expect(isValidBranchName('main')).toBe(true);
-    expect(isValidBranchName('develop')).toBe(true);
-  });
-
-  it('should reject names with consecutive dots', () => {
-    expect(isValidBranchName('branch..name')).toBe(false);
-  });
-
-  it('should reject names starting or ending with slash', () => {
-    expect(isValidBranchName('/branch')).toBe(false);
-    expect(isValidBranchName('branch/')).toBe(false);
-  });
-
-  it('should reject names with consecutive slashes', () => {
-    expect(isValidBranchName('branch//name')).toBe(false);
-  });
-
-  it('should reject names ending with .lock', () => {
-    expect(isValidBranchName('branch.lock')).toBe(false);
-  });
-
-  it('should reject names with special characters', () => {
-    expect(isValidBranchName('branch~name')).toBe(false);
-    expect(isValidBranchName('branch^name')).toBe(false);
-    expect(isValidBranchName('branch:name')).toBe(false);
-    expect(isValidBranchName('branch?name')).toBe(false);
-    expect(isValidBranchName('branch*name')).toBe(false);
-    expect(isValidBranchName('branch[name')).toBe(false);
-    expect(isValidBranchName('branch\\name')).toBe(false);
-  });
-
-  it('should reject components starting with dot', () => {
-    expect(isValidBranchName('.hidden')).toBe(false);
-    expect(isValidBranchName('feature/.hidden')).toBe(false);
-  });
-
-  it('should reject names starting with dash', () => {
-    expect(isValidBranchName('-branch')).toBe(false);
-  });
-});
-
-describe('generateWorkspaceName', () => {
-  it('should combine identifier and sanitized title', () => {
-    expect(generateWorkspaceName('ENG-123', 'Fix Login Bug!')).toBe('eng-123-fix-login-bug');
-  });
-
-  it('should handle spaces in title', () => {
-    expect(generateWorkspaceName('FEAT-456', 'Add Dark Mode')).toBe('feat-456-add-dark-mode');
-  });
-});
-
-describe('extractRepoName', () => {
-  it('should extract repo name from owner/repo format', () => {
-    expect(extractRepoName('myorg/my-app')).toBe('my-app');
-  });
-
-  it('should handle simple repo name', () => {
-    expect(extractRepoName('my-app')).toBe('my-app');
-  });
-});

package/src/utils/sanitize.ts

@@ -1,162 +0,0 @@
-/**
- * Name sanitization utilities for filesystem safety
- */
-
-/**
- * Sanitize a string for filesystem use
- * - Converts to lowercase
- * - Replaces invalid characters with hyphens
- * - Collapses multiple hyphens
- * - Removes leading/trailing hyphens
- * - Limits length to 100 characters
- *
- * @param name String to sanitize
- * @returns Sanitized string safe for filesystem
- *
- * @example
- * sanitizeForFileSystem("Fix Login Bug!") // "fix-login-bug"
- * sanitizeForFileSystem("Feature / User Settings") // "feature-user-settings"
- */
-export function sanitizeForFileSystem(name: string): string {
-  return (
-    name
-      .toLowerCase()
-      // Replace any non-alphanumeric characters (except hyphens and underscores) with hyphen
-      .replace(/[^a-z0-9-_]/g, '-')
-      // Collapse multiple hyphens into one
-      .replace(/-+/g, '-')
-      // Remove leading and trailing hyphens
-      .replace(/^-|-$/g, '')
-      // Limit length to 100 characters
-      .slice(0, 100)
-  );
-}
-
-/**
- * Generate a workspace name from a Linear issue identifier and title
- *
- * @param identifier Issue identifier (e.g., "ENG-123")
- * @param title Issue title
- * @returns Workspace name in format "{identifier}-{sanitized-title}"
- *
- * @example
- * generateWorkspaceName("ENG-123", "Fix Login Bug!") // "eng-123-fix-login-bug"
- * generateWorkspaceName("FEAT-456", "Add Dark Mode") // "feat-456-add-dark-mode"
- */
-export function generateWorkspaceName(identifier: string, title: string): string {
-  const sanitizedTitle = sanitizeForFileSystem(title);
-  const sanitizedIdentifier = identifier.toLowerCase();
-
-  return `${sanitizedIdentifier}-${sanitizedTitle}`;
-}
-
-/**
- * Validate a workspace name
- * - Must contain only alphanumeric characters, hyphens, and underscores
- * - Must not contain spaces
- * - Must not be empty
- * - Must not start or end with a hyphen
- *
- * @param name Workspace name to validate
- * @returns true if valid, false otherwise
- */
-export function isValidWorkspaceName(name: string): boolean {
-  if (!name || name.length === 0) {
-    return false;
-  }
-
-  // Check for spaces (explicitly rejected)
-  if (name.includes(' ')) {
-    return false;
-  }
-
-  // Check for valid characters
-  if (!/^[a-z0-9-_]+$/i.test(name)) {
-    return false;
-  }
-
-  // Check for leading/trailing hyphens
-  if (name.startsWith('-') || name.endsWith('-')) {
-    return false;
-  }
-
-  return true;
-}
-
-/**
- * Validate a git branch name according to git-check-ref-format rules
- * See: https://git-scm.com/docs/git-check-ref-format
- *
- * @param name Branch name to validate
- * @returns true if valid, false otherwise
- */
-export function isValidBranchName(name: string): boolean {
-  if (!name || name.length === 0) {
-    return false;
-  }
-
-  // Cannot have two consecutive dots
-  if (name.includes('..')) {
-    return false;
-  }
-
-  // Cannot have ASCII control characters, space, tilde, caret, colon,
-  // question mark, asterisk, open bracket, or backslash
-  if (/[\x00-\x1f\x7f ~^:?*\[\\]/.test(name)) {
-    return false;
-  }
-
-  // Cannot start or end with a slash, or have consecutive slashes
-  if (name.startsWith('/') || name.endsWith('/') || name.includes('//')) {
-    return false;
-  }
-
-  // Cannot end with a dot
-  if (name.endsWith('.')) {
-    return false;
-  }
-
-  // Cannot contain @{
-  if (name.includes('@{')) {
-    return false;
-  }
-
-  // Cannot be exactly @
-  if (name === '@') {
-    return false;
-  }
-
-  // Cannot end with .lock
-  if (name.endsWith('.lock')) {
-    return false;
-  }
-
-  // Cannot start with a dash
-  if (name.startsWith('-')) {
-    return false;
-  }
-
-  // Each component cannot start with a dot
-  const components = name.split('/');
-  for (const component of components) {
-    if (component.startsWith('.') || component.length === 0) {
-      return false;
-    }
-  }
-
-  return true;
-}
-
-/**
- * Extract repository name from owner/repo format
- *
- * @param repository Repository in "owner/repo" format
- * @returns Repository name
- *
- * @example
- * extractRepoName("myorg/my-app") // "my-app"
- */
-export function extractRepoName(repository: string): string {
-  const parts = repository.split('/');
-  return parts[parts.length - 1];
-}