@mytechtoday/augment-extensions 1.3.0 → 1.4.0

package/augment-extensions/writing-standards/screenplay/utils/__tests__/file-organization.test.ts

@@ -1,169 +1,169 @@
-/**
- * Integration tests for screenplay file organization utilities
- */
-
-import * as fs from 'fs';
-import * as path from 'path';
-import * as os from 'os';
-import {
-  getScreenplaysDir,
-  ensureScreenplaysDir,
-  getProjectNameFromOpenSpec,
-  getProjectNameFromBeads,
-  getProjectName,
-  createProjectDir,
-  ScreenplayProjectInfo
-} from '../file-organization';
-
-describe('Screenplay File Organization', () => {
-  let testDir: string;
-
-  beforeEach(() => {
-    // Create a temporary test directory
-    testDir = fs.mkdtempSync(path.join(os.tmpdir(), 'screenplay-test-'));
-  });
-
-  afterEach(() => {
-    // Clean up test directory
-    if (fs.existsSync(testDir)) {
-      fs.rmSync(testDir, { recursive: true, force: true });
-    }
-  });
-
-  describe('getScreenplaysDir', () => {
-    it('should return screenplays directory path', () => {
-      const result = getScreenplaysDir(testDir);
-      expect(result).toBe(path.join(testDir, 'screenplays'));
-    });
-  });
-
-  describe('ensureScreenplaysDir', () => {
-    it('should create screenplays directory if it does not exist', () => {
-      const screenplaysDir = ensureScreenplaysDir(testDir);
-      expect(fs.existsSync(screenplaysDir)).toBe(true);
-      expect(fs.statSync(screenplaysDir).isDirectory()).toBe(true);
-    });
-
-    it('should not fail if screenplays directory already exists', () => {
-      const screenplaysDir = path.join(testDir, 'screenplays');
-      fs.mkdirSync(screenplaysDir);
-      
-      const result = ensureScreenplaysDir(testDir);
-      expect(result).toBe(screenplaysDir);
-      expect(fs.existsSync(screenplaysDir)).toBe(true);
-    });
-  });
-
-  describe('getProjectNameFromOpenSpec', () => {
-    it('should return null if openspec directory does not exist', () => {
-      const result = getProjectNameFromOpenSpec(testDir);
-      expect(result).toBeNull();
-    });
-
-    it('should return project info from OpenSpec changes', () => {
-      // Create mock OpenSpec structure
-      const changesDir = path.join(testDir, 'openspec', 'changes', 'heist-movie');
-      fs.mkdirSync(changesDir, { recursive: true });
-
-      const result = getProjectNameFromOpenSpec(testDir);
-      expect(result).not.toBeNull();
-      expect(result?.name).toBe('heist-movie');
-      expect(result?.source).toBe('openspec');
-      expect(result?.specId).toBe('heist-movie');
-    });
-  });
-
-  describe('getProjectNameFromBeads', () => {
-    it('should return null if .beads directory does not exist', () => {
-      const result = getProjectNameFromBeads(testDir);
-      expect(result).toBeNull();
-    });
-
-    it('should return project info from Beads epic', () => {
-      // Create mock Beads structure
-      const beadsDir = path.join(testDir, '.beads');
-      fs.mkdirSync(beadsDir);
-      
-      const issue = {
-        id: 'bd-scr-test',
-        title: 'Test Screenplay',
-        issue_type: 'epic',
-        status: 'open',
-        labels: ['screenplay', 'writing-standards']
-      };
-      
-      fs.writeFileSync(
-        path.join(beadsDir, 'issues.jsonl'),
-        JSON.stringify(issue) + '\n'
-      );
-
-      const result = getProjectNameFromBeads(testDir);
-      expect(result).not.toBeNull();
-      expect(result?.name).toBe('bd-scr-test');
-      expect(result?.source).toBe('beads');
-      expect(result?.epicId).toBe('bd-scr-test');
-    });
-  });
-
-  describe('getProjectName', () => {
-    it('should prefer OpenSpec over Beads', () => {
-      // Create both OpenSpec and Beads structures
-      const changesDir = path.join(testDir, 'openspec', 'changes', 'openspec-project');
-      fs.mkdirSync(changesDir, { recursive: true });
-
-      const beadsDir = path.join(testDir, '.beads');
-      fs.mkdirSync(beadsDir);
-      fs.writeFileSync(
-        path.join(beadsDir, 'issues.jsonl'),
-        JSON.stringify({
-          id: 'bd-beads-project',
-          issue_type: 'epic',
-          status: 'open',
-          labels: ['screenplay']
-        }) + '\n'
-      );
-
-      const result = getProjectName(testDir);
-      expect(result.name).toBe('openspec-project');
-      expect(result.source).toBe('openspec');
-    });
-
-    it('should use timestamp fallback if no context available', () => {
-      const result = getProjectName(testDir);
-      expect(result.source).toBe('manual');
-      expect(result.name).toMatch(/^screenplay-\d{4}-\d{2}-\d{2}$/);
-    });
-  });
-
-  describe('createProjectDir', () => {
-    it('should create project directory', () => {
-      const projectInfo: ScreenplayProjectInfo = {
-        name: 'test-project',
-        source: 'manual'
-      };
-
-      const projectDir = createProjectDir(projectInfo, { rootDir: testDir });
-      expect(fs.existsSync(projectDir)).toBe(true);
-      expect(projectDir).toBe(path.join(testDir, 'screenplays', 'test-project'));
-    });
-
-    it('should handle conflicts with append-number strategy', () => {
-      const projectInfo: ScreenplayProjectInfo = {
-        name: 'conflict-test',
-        source: 'manual'
-      };
-
-      // Create first project
-      const firstDir = createProjectDir(projectInfo, { rootDir: testDir });
-      expect(firstDir).toBe(path.join(testDir, 'screenplays', 'conflict-test'));
-
-      // Create second project with same name
-      const secondDir = createProjectDir(projectInfo, { 
-        rootDir: testDir,
-        handleConflicts: 'append-number'
-      });
-      expect(secondDir).toBe(path.join(testDir, 'screenplays', 'conflict-test-1'));
-    });
-  });
-});
-
+/**
+ * Integration tests for screenplay file organization utilities
+ */
+
+import * as fs from 'fs';
+import * as path from 'path';
+import * as os from 'os';
+import {
+  getScreenplaysDir,
+  ensureScreenplaysDir,
+  getProjectNameFromOpenSpec,
+  getProjectNameFromBeads,
+  getProjectName,
+  createProjectDir,
+  ScreenplayProjectInfo
+} from '../file-organization';
+
+describe('Screenplay File Organization', () => {
+  let testDir: string;
+
+  beforeEach(() => {
+    // Create a temporary test directory
+    testDir = fs.mkdtempSync(path.join(os.tmpdir(), 'screenplay-test-'));
+  });
+
+  afterEach(() => {
+    // Clean up test directory
+    if (fs.existsSync(testDir)) {
+      fs.rmSync(testDir, { recursive: true, force: true });
+    }
+  });
+
+  describe('getScreenplaysDir', () => {
+    it('should return screenplays directory path', () => {
+      const result = getScreenplaysDir(testDir);
+      expect(result).toBe(path.join(testDir, 'screenplays'));
+    });
+  });
+
+  describe('ensureScreenplaysDir', () => {
+    it('should create screenplays directory if it does not exist', () => {
+      const screenplaysDir = ensureScreenplaysDir(testDir);
+      expect(fs.existsSync(screenplaysDir)).toBe(true);
+      expect(fs.statSync(screenplaysDir).isDirectory()).toBe(true);
+    });
+
+    it('should not fail if screenplays directory already exists', () => {
+      const screenplaysDir = path.join(testDir, 'screenplays');
+      fs.mkdirSync(screenplaysDir);
+      
+      const result = ensureScreenplaysDir(testDir);
+      expect(result).toBe(screenplaysDir);
+      expect(fs.existsSync(screenplaysDir)).toBe(true);
+    });
+  });
+
+  describe('getProjectNameFromOpenSpec', () => {
+    it('should return null if openspec directory does not exist', () => {
+      const result = getProjectNameFromOpenSpec(testDir);
+      expect(result).toBeNull();
+    });
+
+    it('should return project info from OpenSpec changes', () => {
+      // Create mock OpenSpec structure
+      const changesDir = path.join(testDir, 'openspec', 'changes', 'heist-movie');
+      fs.mkdirSync(changesDir, { recursive: true });
+
+      const result = getProjectNameFromOpenSpec(testDir);
+      expect(result).not.toBeNull();
+      expect(result?.name).toBe('heist-movie');
+      expect(result?.source).toBe('openspec');
+      expect(result?.specId).toBe('heist-movie');
+    });
+  });
+
+  describe('getProjectNameFromBeads', () => {
+    it('should return null if .beads directory does not exist', () => {
+      const result = getProjectNameFromBeads(testDir);
+      expect(result).toBeNull();
+    });
+
+    it('should return project info from Beads epic', () => {
+      // Create mock Beads structure
+      const beadsDir = path.join(testDir, '.beads');
+      fs.mkdirSync(beadsDir);
+      
+      const issue = {
+        id: 'bd-scr-test',
+        title: 'Test Screenplay',
+        issue_type: 'epic',
+        status: 'open',
+        labels: ['screenplay', 'writing-standards']
+      };
+      
+      fs.writeFileSync(
+        path.join(beadsDir, 'issues.jsonl'),
+        JSON.stringify(issue) + '\n'
+      );
+
+      const result = getProjectNameFromBeads(testDir);
+      expect(result).not.toBeNull();
+      expect(result?.name).toBe('bd-scr-test');
+      expect(result?.source).toBe('beads');
+      expect(result?.epicId).toBe('bd-scr-test');
+    });
+  });
+
+  describe('getProjectName', () => {
+    it('should prefer OpenSpec over Beads', () => {
+      // Create both OpenSpec and Beads structures
+      const changesDir = path.join(testDir, 'openspec', 'changes', 'openspec-project');
+      fs.mkdirSync(changesDir, { recursive: true });
+
+      const beadsDir = path.join(testDir, '.beads');
+      fs.mkdirSync(beadsDir);
+      fs.writeFileSync(
+        path.join(beadsDir, 'issues.jsonl'),
+        JSON.stringify({
+          id: 'bd-beads-project',
+          issue_type: 'epic',
+          status: 'open',
+          labels: ['screenplay']
+        }) + '\n'
+      );
+
+      const result = getProjectName(testDir);
+      expect(result.name).toBe('openspec-project');
+      expect(result.source).toBe('openspec');
+    });
+
+    it('should use timestamp fallback if no context available', () => {
+      const result = getProjectName(testDir);
+      expect(result.source).toBe('manual');
+      expect(result.name).toMatch(/^screenplay-\d{4}-\d{2}-\d{2}$/);
+    });
+  });
+
+  describe('createProjectDir', () => {
+    it('should create project directory', () => {
+      const projectInfo: ScreenplayProjectInfo = {
+        name: 'test-project',
+        source: 'manual'
+      };
+
+      const projectDir = createProjectDir(projectInfo, { rootDir: testDir });
+      expect(fs.existsSync(projectDir)).toBe(true);
+      expect(projectDir).toBe(path.join(testDir, 'screenplays', 'test-project'));
+    });
+
+    it('should handle conflicts with append-number strategy', () => {
+      const projectInfo: ScreenplayProjectInfo = {
+        name: 'conflict-test',
+        source: 'manual'
+      };
+
+      // Create first project
+      const firstDir = createProjectDir(projectInfo, { rootDir: testDir });
+      expect(firstDir).toBe(path.join(testDir, 'screenplays', 'conflict-test'));
+
+      // Create second project with same name
+      const secondDir = createProjectDir(projectInfo, { 
+        rootDir: testDir,
+        handleConflicts: 'append-number'
+      });
+      expect(secondDir).toBe(path.join(testDir, 'screenplays', 'conflict-test-1'));
+    });
+  });
+});
+

package/augment-extensions/writing-standards/screenplay/utils/file-organization.ts

@@ -1,165 +1,165 @@
-/**
- * File Organization Utilities for Screenplay Module
- * 
- * Provides utilities for organizing screenplay files into structured directories
- * based on OpenSpec specs or Beads epics.
- */
-
-import * as fs from 'fs';
-import * as path from 'path';
-
-export interface ScreenplayProjectInfo {
-  name: string;
-  source: 'openspec' | 'beads' | 'manual';
-  specId?: string;
-  epicId?: string;
-  timestamp?: string;
-}
-
-export interface OrganizationOptions {
-  rootDir?: string;
-  createIfMissing?: boolean;
-  handleConflicts?: 'append-timestamp' | 'append-number' | 'error';
-}
-
-/**
- * Get the screenplays directory path
- */
-export function getScreenplaysDir(rootDir: string = process.cwd()): string {
-  return path.join(rootDir, 'screenplays');
-}
-
-/**
- * Ensure the screenplays directory exists
- */
-export function ensureScreenplaysDir(rootDir: string = process.cwd()): string {
-  const screenplaysDir = getScreenplaysDir(rootDir);
-  
-  if (!fs.existsSync(screenplaysDir)) {
-    fs.mkdirSync(screenplaysDir, { recursive: true });
-  }
-  
-  return screenplaysDir;
-}
-
-/**
- * Get project name from OpenSpec spec
- */
-export function getProjectNameFromOpenSpec(rootDir: string = process.cwd()): ScreenplayProjectInfo | null {
-  const openspecDir = path.join(rootDir, 'openspec');
-  
-  if (!fs.existsSync(openspecDir)) {
-    return null;
-  }
-  
-  // Check for active changes
-  const changesDir = path.join(openspecDir, 'changes');
-  if (fs.existsSync(changesDir)) {
-    const changes = fs.readdirSync(changesDir, { withFileTypes: true })
-      .filter(dirent => dirent.isDirectory())
-      .map(dirent => dirent.name);
-    
-    if (changes.length > 0) {
-      // Use the first active change as the project name
-      return {
-        name: changes[0],
-        source: 'openspec',
-        specId: changes[0]
-      };
-    }
-  }
-  
-  return null;
-}
-
-/**
- * Get project name from Beads epic
- */
-export function getProjectNameFromBeads(rootDir: string = process.cwd()): ScreenplayProjectInfo | null {
-  const beadsFile = path.join(rootDir, '.beads', 'issues.jsonl');
-  
-  if (!fs.existsSync(beadsFile)) {
-    return null;
-  }
-  
-  try {
-    const lines = fs.readFileSync(beadsFile, 'utf-8').split('\n').filter(line => line.trim());
-    
-    // Find the most recent open epic with screenplay labels
-    for (let i = lines.length - 1; i >= 0; i--) {
-      const issue = JSON.parse(lines[i]);
-      
-      if (issue.issue_type === 'epic' && 
-          issue.status === 'open' && 
-          (issue.labels?.includes('screenplay') || issue.labels?.includes('writing-standards'))) {
-        return {
-          name: issue.id,
-          source: 'beads',
-          epicId: issue.id
-        };
-      }
-    }
-  } catch (error) {
-    console.warn('Error reading Beads issues:', error);
-  }
-  
-  return null;
-}
-
-/**
- * Get project name with fallback logic
- */
-export function getProjectName(rootDir: string = process.cwd()): ScreenplayProjectInfo {
-  // Try OpenSpec first
-  const openspecInfo = getProjectNameFromOpenSpec(rootDir);
-  if (openspecInfo) {
-    return openspecInfo;
-  }
-  
-  // Try Beads second
-  const beadsInfo = getProjectNameFromBeads(rootDir);
-  if (beadsInfo) {
-    return beadsInfo;
-  }
-  
-  // Fallback to timestamp
-  const timestamp = new Date().toISOString().replace(/[:.]/g, '-').split('T')[0];
-  return {
-    name: `screenplay-${timestamp}`,
-    source: 'manual',
-    timestamp
-  };
-}
-
-/**
- * Create project directory with conflict resolution
- */
-export function createProjectDir(
-  projectInfo: ScreenplayProjectInfo,
-  options: OrganizationOptions = {}
-): string {
-  const { rootDir = process.cwd(), handleConflicts = 'append-number' } = options;
-  
-  const screenplaysDir = ensureScreenplaysDir(rootDir);
-  let projectDir = path.join(screenplaysDir, projectInfo.name);
-  
-  // Handle conflicts
-  if (fs.existsSync(projectDir)) {
-    if (handleConflicts === 'error') {
-      throw new Error(`Project directory already exists: ${projectDir}`);
-    } else if (handleConflicts === 'append-timestamp') {
-      const timestamp = new Date().toISOString().replace(/[:.]/g, '-');
-      projectDir = path.join(screenplaysDir, `${projectInfo.name}-${timestamp}`);
-    } else if (handleConflicts === 'append-number') {
-      let counter = 1;
-      while (fs.existsSync(projectDir)) {
-        projectDir = path.join(screenplaysDir, `${projectInfo.name}-${counter}`);
-        counter++;
-      }
-    }
-  }
-  
-  fs.mkdirSync(projectDir, { recursive: true });
-  return projectDir;
-}
-
+/**
+ * File Organization Utilities for Screenplay Module
+ * 
+ * Provides utilities for organizing screenplay files into structured directories
+ * based on OpenSpec specs or Beads epics.
+ */
+
+import * as fs from 'fs';
+import * as path from 'path';
+
+export interface ScreenplayProjectInfo {
+  name: string;
+  source: 'openspec' | 'beads' | 'manual';
+  specId?: string;
+  epicId?: string;
+  timestamp?: string;
+}
+
+export interface OrganizationOptions {
+  rootDir?: string;
+  createIfMissing?: boolean;
+  handleConflicts?: 'append-timestamp' | 'append-number' | 'error';
+}
+
+/**
+ * Get the screenplays directory path
+ */
+export function getScreenplaysDir(rootDir: string = process.cwd()): string {
+  return path.join(rootDir, 'screenplays');
+}
+
+/**
+ * Ensure the screenplays directory exists
+ */
+export function ensureScreenplaysDir(rootDir: string = process.cwd()): string {
+  const screenplaysDir = getScreenplaysDir(rootDir);
+  
+  if (!fs.existsSync(screenplaysDir)) {
+    fs.mkdirSync(screenplaysDir, { recursive: true });
+  }
+  
+  return screenplaysDir;
+}
+
+/**
+ * Get project name from OpenSpec spec
+ */
+export function getProjectNameFromOpenSpec(rootDir: string = process.cwd()): ScreenplayProjectInfo | null {
+  const openspecDir = path.join(rootDir, 'openspec');
+  
+  if (!fs.existsSync(openspecDir)) {
+    return null;
+  }
+  
+  // Check for active changes
+  const changesDir = path.join(openspecDir, 'changes');
+  if (fs.existsSync(changesDir)) {
+    const changes = fs.readdirSync(changesDir, { withFileTypes: true })
+      .filter(dirent => dirent.isDirectory())
+      .map(dirent => dirent.name);
+    
+    if (changes.length > 0) {
+      // Use the first active change as the project name
+      return {
+        name: changes[0],
+        source: 'openspec',
+        specId: changes[0]
+      };
+    }
+  }
+  
+  return null;
+}
+
+/**
+ * Get project name from Beads epic
+ */
+export function getProjectNameFromBeads(rootDir: string = process.cwd()): ScreenplayProjectInfo | null {
+  const beadsFile = path.join(rootDir, '.beads', 'issues.jsonl');
+  
+  if (!fs.existsSync(beadsFile)) {
+    return null;
+  }
+  
+  try {
+    const lines = fs.readFileSync(beadsFile, 'utf-8').split('\n').filter(line => line.trim());
+    
+    // Find the most recent open epic with screenplay labels
+    for (let i = lines.length - 1; i >= 0; i--) {
+      const issue = JSON.parse(lines[i]);
+      
+      if (issue.issue_type === 'epic' && 
+          issue.status === 'open' && 
+          (issue.labels?.includes('screenplay') || issue.labels?.includes('writing-standards'))) {
+        return {
+          name: issue.id,
+          source: 'beads',
+          epicId: issue.id
+        };
+      }
+    }
+  } catch (error) {
+    console.warn('Error reading Beads issues:', error);
+  }
+  
+  return null;
+}
+
+/**
+ * Get project name with fallback logic
+ */
+export function getProjectName(rootDir: string = process.cwd()): ScreenplayProjectInfo {
+  // Try OpenSpec first
+  const openspecInfo = getProjectNameFromOpenSpec(rootDir);
+  if (openspecInfo) {
+    return openspecInfo;
+  }
+  
+  // Try Beads second
+  const beadsInfo = getProjectNameFromBeads(rootDir);
+  if (beadsInfo) {
+    return beadsInfo;
+  }
+  
+  // Fallback to timestamp
+  const timestamp = new Date().toISOString().replace(/[:.]/g, '-').split('T')[0];
+  return {
+    name: `screenplay-${timestamp}`,
+    source: 'manual',
+    timestamp
+  };
+}
+
+/**
+ * Create project directory with conflict resolution
+ */
+export function createProjectDir(
+  projectInfo: ScreenplayProjectInfo,
+  options: OrganizationOptions = {}
+): string {
+  const { rootDir = process.cwd(), handleConflicts = 'append-number' } = options;
+  
+  const screenplaysDir = ensureScreenplaysDir(rootDir);
+  let projectDir = path.join(screenplaysDir, projectInfo.name);
+  
+  // Handle conflicts
+  if (fs.existsSync(projectDir)) {
+    if (handleConflicts === 'error') {
+      throw new Error(`Project directory already exists: ${projectDir}`);
+    } else if (handleConflicts === 'append-timestamp') {
+      const timestamp = new Date().toISOString().replace(/[:.]/g, '-');
+      projectDir = path.join(screenplaysDir, `${projectInfo.name}-${timestamp}`);
+    } else if (handleConflicts === 'append-number') {
+      let counter = 1;
+      while (fs.existsSync(projectDir)) {
+        projectDir = path.join(screenplaysDir, `${projectInfo.name}-${counter}`);
+        counter++;
+      }
+    }
+  }
+  
+  fs.mkdirSync(projectDir, { recursive: true });
+  return projectDir;
+}
+