openspec-cn 0.23.0

package/dist/ui/welcome-screen.js

@@ -0,0 +1,146 @@
+/**
+ * Animated welcome screen for the experimental artifact workflow setup.
+ * Shows side-by-side layout with animated ASCII art on left and welcome text on right.
+ */
+import chalk from 'chalk';
+import { WELCOME_ANIMATION } from './ascii-patterns.js';
+// Minimum terminal width for side-by-side layout
+const MIN_WIDTH = 60;
+// Width of the ASCII art column (with padding)
+const ART_COLUMN_WIDTH = 24;
+/**
+ * Welcome text content (right column)
+ */
+function getWelcomeText() {
+    return [
+        chalk.white.bold('Welcome to OpenSpec'),
+        chalk.dim('A lightweight spec-driven framework'),
+        '',
+        chalk.white('This setup will configure:'),
+        chalk.dim('  • Agent Skills for AI tools'),
+        chalk.dim('  • /opsx:* slash commands'),
+        '',
+        chalk.white('Quick start after setup:'),
+        `  ${chalk.yellow('/opsx:new')}      ${chalk.dim('Create a change')}`,
+        `  ${chalk.yellow('/opsx:continue')} ${chalk.dim('Next artifact')}`,
+        `  ${chalk.yellow('/opsx:apply')}    ${chalk.dim('Implement tasks')}`,
+        '',
+        chalk.cyan('Press Enter to select tools...'),
+    ];
+}
+/**
+ * Renders a single frame with side-by-side layout
+ */
+function renderFrame(artLines, textLines) {
+    const maxLines = Math.max(artLines.length, textLines.length);
+    const lines = [];
+    for (let i = 0; i < maxLines; i++) {
+        const artLine = artLines[i] || '';
+        const textLine = textLines[i] || '';
+        // Pad the art column to fixed width
+        const paddedArt = artLine.padEnd(ART_COLUMN_WIDTH);
+        // Color the ASCII art with cyan for visual appeal
+        const coloredArt = chalk.cyan(paddedArt);
+        // Clear line before writing to prevent residual characters
+        lines.push(`\x1b[2K${coloredArt}${textLine}`);
+    }
+    return lines.join('\n');
+}
+/**
+ * Checks if the terminal supports animation
+ */
+function canAnimate() {
+    // Must be TTY
+    if (!process.stdout.isTTY)
+        return false;
+    // Respect NO_COLOR
+    if (process.env.NO_COLOR)
+        return false;
+    // Check terminal width
+    const columns = process.stdout.columns || 80;
+    if (columns < MIN_WIDTH)
+        return false;
+    return true;
+}
+/**
+ * Wait for Enter key press
+ */
+function waitForEnter() {
+    return new Promise((resolve) => {
+        const { stdin } = process;
+        // Handle non-TTY gracefully
+        if (!stdin.isTTY) {
+            resolve();
+            return;
+        }
+        const wasRaw = stdin.isRaw;
+        stdin.setRawMode(true);
+        stdin.resume();
+        const onData = (data) => {
+            const char = data.toString();
+            // Enter key or Ctrl+C
+            if (char === '\r' || char === '\n' || char === '\u0003') {
+                stdin.removeListener('data', onData);
+                stdin.setRawMode(wasRaw);
+                stdin.pause();
+                // Handle Ctrl+C
+                if (char === '\u0003') {
+                    process.stdout.write('\n');
+                    process.exit(0);
+                }
+                resolve();
+            }
+        };
+        stdin.on('data', onData);
+    });
+}
+/**
+ * Shows the animated welcome screen.
+ * Returns when user presses Enter.
+ */
+export async function showWelcomeScreen() {
+    const textLines = getWelcomeText();
+    if (!canAnimate()) {
+        // Fallback: show static welcome
+        const frame = WELCOME_ANIMATION.frames[3]; // Peak frame
+        process.stdout.write('\n' + renderFrame(frame, textLines) + '\n\n');
+        return;
+    }
+    let frameIndex = 0;
+    let running = true;
+    let isFirstRender = true;
+    // Content height for cursor movement between frames
+    const numContentLines = Math.max(WELCOME_ANIMATION.frames[0].length, textLines.length);
+    const frameHeight = numContentLines + 1; // internal newlines (11) + trailing newlines (2) = 13
+    // Total height including initial newline (for cleanup)
+    const totalHeight = frameHeight + 1; // 14
+    // Initial render
+    process.stdout.write('\n');
+    // Animation loop
+    const interval = setInterval(() => {
+        if (!running)
+            return;
+        const frame = WELCOME_ANIMATION.frames[frameIndex];
+        // Move cursor up to overwrite previous frame (always after first render)
+        if (!isFirstRender) {
+            process.stdout.write(`\x1b[${frameHeight}A`);
+        }
+        isFirstRender = false;
+        // Render current frame
+        process.stdout.write(renderFrame(frame, textLines) + '\n\n');
+        // Advance to next frame
+        frameIndex = (frameIndex + 1) % WELCOME_ANIMATION.frames.length;
+    }, WELCOME_ANIMATION.interval);
+    // Wait for Enter
+    await waitForEnter();
+    // Stop animation
+    running = false;
+    clearInterval(interval);
+    // Clear the welcome screen and move on
+    process.stdout.write(`\x1b[${totalHeight}A`);
+    for (let i = 0; i < totalHeight; i++) {
+        process.stdout.write('\x1b[2K\n'); // Clear line
+    }
+    process.stdout.write(`\x1b[${totalHeight}A`); // Move back up
+}
+//# sourceMappingURL=welcome-screen.js.map

package/dist/utils/change-metadata.d.ts

@@ -0,0 +1,51 @@
+import { type ChangeMetadata } from '../core/artifact-graph/types.js';
+/**
+ * Error thrown when change metadata validation fails.
+ */
+export declare class ChangeMetadataError extends Error {
+    readonly metadataPath: string;
+    readonly cause?: Error | undefined;
+    constructor(message: string, metadataPath: string, cause?: Error | undefined);
+}
+/**
+ * Validates that a schema name is valid (exists in available schemas).
+ *
+ * @param schemaName - The schema name to validate
+ * @param projectRoot - Optional project root for project-local schema resolution
+ * @returns The validated schema name
+ * @throws Error if schema is not found
+ */
+export declare function validateSchemaName(schemaName: string, projectRoot?: string): string;
+/**
+ * Writes change metadata to .openspec.yaml in the change directory.
+ *
+ * @param changeDir - The path to the change directory
+ * @param metadata - The metadata to write
+ * @param projectRoot - Optional project root for project-local schema resolution
+ * @throws ChangeMetadataError if validation fails or write fails
+ */
+export declare function writeChangeMetadata(changeDir: string, metadata: ChangeMetadata, projectRoot?: string): void;
+/**
+ * Reads change metadata from .openspec.yaml in the change directory.
+ *
+ * @param changeDir - The path to the change directory
+ * @param projectRoot - Optional project root for project-local schema resolution
+ * @returns The validated metadata, or null if no metadata file exists
+ * @throws ChangeMetadataError if the file exists but is invalid
+ */
+export declare function readChangeMetadata(changeDir: string, projectRoot?: string): ChangeMetadata | null;
+/**
+ * Resolves the schema for a change, with explicit override taking precedence.
+ *
+ * Resolution order:
+ * 1. Explicit schema (if provided)
+ * 2. Schema from .openspec.yaml metadata (if exists)
+ * 3. Schema from openspec/config.yaml (if exists)
+ * 4. Default 'spec-driven'
+ *
+ * @param changeDir - The path to the change directory
+ * @param explicitSchema - Optional explicit schema override
+ * @returns The resolved schema name
+ */
+export declare function resolveSchemaForChange(changeDir: string, explicitSchema?: string): string;
+//# sourceMappingURL=change-metadata.d.ts.map

package/dist/utils/change-metadata.js

@@ -0,0 +1,147 @@
+import * as fs from 'node:fs';
+import * as path from 'node:path';
+import * as yaml from 'yaml';
+import { ChangeMetadataSchema } from '../core/artifact-graph/types.js';
+import { listSchemas } from '../core/artifact-graph/resolver.js';
+import { readProjectConfig } from '../core/project-config.js';
+const METADATA_FILENAME = '.openspec.yaml';
+/**
+ * Error thrown when change metadata validation fails.
+ */
+export class ChangeMetadataError extends Error {
+    metadataPath;
+    cause;
+    constructor(message, metadataPath, cause) {
+        super(message);
+        this.metadataPath = metadataPath;
+        this.cause = cause;
+        this.name = 'ChangeMetadataError';
+    }
+}
+/**
+ * Validates that a schema name is valid (exists in available schemas).
+ *
+ * @param schemaName - The schema name to validate
+ * @param projectRoot - Optional project root for project-local schema resolution
+ * @returns The validated schema name
+ * @throws Error if schema is not found
+ */
+export function validateSchemaName(schemaName, projectRoot) {
+    const availableSchemas = listSchemas(projectRoot);
+    if (!availableSchemas.includes(schemaName)) {
+        throw new Error(`Unknown schema '${schemaName}'. Available: ${availableSchemas.join(', ')}`);
+    }
+    return schemaName;
+}
+/**
+ * Writes change metadata to .openspec.yaml in the change directory.
+ *
+ * @param changeDir - The path to the change directory
+ * @param metadata - The metadata to write
+ * @param projectRoot - Optional project root for project-local schema resolution
+ * @throws ChangeMetadataError if validation fails or write fails
+ */
+export function writeChangeMetadata(changeDir, metadata, projectRoot) {
+    const metaPath = path.join(changeDir, METADATA_FILENAME);
+    // Validate schema exists
+    validateSchemaName(metadata.schema, projectRoot);
+    // Validate with Zod
+    const parseResult = ChangeMetadataSchema.safeParse(metadata);
+    if (!parseResult.success) {
+        throw new ChangeMetadataError(`Invalid metadata: ${parseResult.error.message}`, metaPath);
+    }
+    // Write YAML file
+    const content = yaml.stringify(parseResult.data);
+    try {
+        fs.writeFileSync(metaPath, content, 'utf-8');
+    }
+    catch (err) {
+        const ioError = err instanceof Error ? err : new Error(String(err));
+        throw new ChangeMetadataError(`Failed to write metadata: ${ioError.message}`, metaPath, ioError);
+    }
+}
+/**
+ * Reads change metadata from .openspec.yaml in the change directory.
+ *
+ * @param changeDir - The path to the change directory
+ * @param projectRoot - Optional project root for project-local schema resolution
+ * @returns The validated metadata, or null if no metadata file exists
+ * @throws ChangeMetadataError if the file exists but is invalid
+ */
+export function readChangeMetadata(changeDir, projectRoot) {
+    const metaPath = path.join(changeDir, METADATA_FILENAME);
+    if (!fs.existsSync(metaPath)) {
+        return null;
+    }
+    let content;
+    try {
+        content = fs.readFileSync(metaPath, 'utf-8');
+    }
+    catch (err) {
+        const ioError = err instanceof Error ? err : new Error(String(err));
+        throw new ChangeMetadataError(`Failed to read metadata: ${ioError.message}`, metaPath, ioError);
+    }
+    let parsed;
+    try {
+        parsed = yaml.parse(content);
+    }
+    catch (err) {
+        const parseError = err instanceof Error ? err : new Error(String(err));
+        throw new ChangeMetadataError(`Invalid YAML in metadata file: ${parseError.message}`, metaPath, parseError);
+    }
+    // Validate with Zod
+    const parseResult = ChangeMetadataSchema.safeParse(parsed);
+    if (!parseResult.success) {
+        throw new ChangeMetadataError(`Invalid metadata: ${parseResult.error.message}`, metaPath);
+    }
+    // Validate that the schema exists
+    const availableSchemas = listSchemas(projectRoot);
+    if (!availableSchemas.includes(parseResult.data.schema)) {
+        throw new ChangeMetadataError(`Unknown schema '${parseResult.data.schema}'. Available: ${availableSchemas.join(', ')}`, metaPath);
+    }
+    return parseResult.data;
+}
+/**
+ * Resolves the schema for a change, with explicit override taking precedence.
+ *
+ * Resolution order:
+ * 1. Explicit schema (if provided)
+ * 2. Schema from .openspec.yaml metadata (if exists)
+ * 3. Schema from openspec/config.yaml (if exists)
+ * 4. Default 'spec-driven'
+ *
+ * @param changeDir - The path to the change directory
+ * @param explicitSchema - Optional explicit schema override
+ * @returns The resolved schema name
+ */
+export function resolveSchemaForChange(changeDir, explicitSchema) {
+    // Derive project root from changeDir (changeDir is typically projectRoot/openspec/changes/change-name)
+    const projectRoot = path.resolve(changeDir, '../../..');
+    // 1. Explicit override wins
+    if (explicitSchema) {
+        return explicitSchema;
+    }
+    // 2. Try reading from metadata
+    try {
+        const metadata = readChangeMetadata(changeDir, projectRoot);
+        if (metadata?.schema) {
+            return metadata.schema;
+        }
+    }
+    catch {
+        // If metadata read fails, continue to next option
+    }
+    // 3. Try reading from project config
+    try {
+        const config = readProjectConfig(projectRoot);
+        if (config?.schema) {
+            return config.schema;
+        }
+    }
+    catch {
+        // If config read fails, fall back to default
+    }
+    // 4. Default
+    return 'spec-driven';
+}
+//# sourceMappingURL=change-metadata.js.map

package/dist/utils/change-utils.d.ts

@@ -0,0 +1,62 @@
+/**
+ * Options for creating a change.
+ */
+export interface CreateChangeOptions {
+    /** The workflow schema to use (default: 'spec-driven') */
+    schema?: string;
+}
+/**
+ * Result of creating a change.
+ */
+export interface CreateChangeResult {
+    /** The schema that was actually used (resolved from options, config, or default) */
+    schema: string;
+}
+/**
+ * Result of validating a change name.
+ */
+export interface ValidationResult {
+    valid: boolean;
+    error?: string;
+}
+/**
+ * Validates that a change name follows kebab-case conventions.
+ *
+ * Valid names:
+ * - Start with a lowercase letter
+ * - Contain only lowercase letters, numbers, and hyphens
+ * - Do not start or end with a hyphen
+ * - Do not contain consecutive hyphens
+ *
+ * @param name - The change name to validate
+ * @returns Validation result with `valid: true` or `valid: false` with an error message
+ *
+ * @example
+ * validateChangeName('add-auth') // { valid: true }
+ * validateChangeName('Add-Auth') // { valid: false, error: '...' }
+ */
+export declare function validateChangeName(name: string): ValidationResult;
+/**
+ * Creates a new change directory with metadata file.
+ *
+ * @param projectRoot - The root directory of the project (where `openspec/` lives)
+ * @param name - The change name (must be valid kebab-case)
+ * @param options - Optional settings for the change
+ * @throws Error if the change name is invalid
+ * @throws Error if the schema name is invalid
+ * @throws Error if the change directory already exists
+ *
+ * @returns Result containing the resolved schema name
+ *
+ * @example
+ * // Creates openspec/changes/add-auth/ with default schema
+ * const result = await createChange('/path/to/project', 'add-auth')
+ * console.log(result.schema) // 'spec-driven' or value from config
+ *
+ * @example
+ * // Creates openspec/changes/add-auth/ with TDD schema
+ * const result = await createChange('/path/to/project', 'add-auth', { schema: 'tdd' })
+ * console.log(result.schema) // 'tdd'
+ */
+export declare function createChange(projectRoot: string, name: string, options?: CreateChangeOptions): Promise<CreateChangeResult>;
+//# sourceMappingURL=change-utils.d.ts.map

package/dist/utils/change-utils.js

@@ -0,0 +1,121 @@
+import path from 'path';
+import { FileSystemUtils } from './file-system.js';
+import { writeChangeMetadata, validateSchemaName } from './change-metadata.js';
+import { readProjectConfig } from '../core/project-config.js';
+const DEFAULT_SCHEMA = 'spec-driven';
+/**
+ * Validates that a change name follows kebab-case conventions.
+ *
+ * Valid names:
+ * - Start with a lowercase letter
+ * - Contain only lowercase letters, numbers, and hyphens
+ * - Do not start or end with a hyphen
+ * - Do not contain consecutive hyphens
+ *
+ * @param name - The change name to validate
+ * @returns Validation result with `valid: true` or `valid: false` with an error message
+ *
+ * @example
+ * validateChangeName('add-auth') // { valid: true }
+ * validateChangeName('Add-Auth') // { valid: false, error: '...' }
+ */
+export function validateChangeName(name) {
+    // Pattern: starts with lowercase letter, followed by lowercase letters/numbers,
+    // optionally followed by hyphen + lowercase letters/numbers (repeatable)
+    const kebabCasePattern = /^[a-z][a-z0-9]*(-[a-z0-9]+)*$/;
+    if (!name) {
+        return { valid: false, error: 'Change name cannot be empty' };
+    }
+    if (!kebabCasePattern.test(name)) {
+        // Provide specific error messages for common mistakes
+        if (/[A-Z]/.test(name)) {
+            return { valid: false, error: 'Change name must be lowercase (use kebab-case)' };
+        }
+        if (/\s/.test(name)) {
+            return { valid: false, error: 'Change name cannot contain spaces (use hyphens instead)' };
+        }
+        if (/_/.test(name)) {
+            return { valid: false, error: 'Change name cannot contain underscores (use hyphens instead)' };
+        }
+        if (name.startsWith('-')) {
+            return { valid: false, error: 'Change name cannot start with a hyphen' };
+        }
+        if (name.endsWith('-')) {
+            return { valid: false, error: 'Change name cannot end with a hyphen' };
+        }
+        if (/--/.test(name)) {
+            return { valid: false, error: 'Change name cannot contain consecutive hyphens' };
+        }
+        if (/[^a-z0-9-]/.test(name)) {
+            return { valid: false, error: 'Change name can only contain lowercase letters, numbers, and hyphens' };
+        }
+        if (/^[0-9]/.test(name)) {
+            return { valid: false, error: 'Change name must start with a letter' };
+        }
+        return { valid: false, error: 'Change name must follow kebab-case convention (e.g., add-auth, refactor-db)' };
+    }
+    return { valid: true };
+}
+/**
+ * Creates a new change directory with metadata file.
+ *
+ * @param projectRoot - The root directory of the project (where `openspec/` lives)
+ * @param name - The change name (must be valid kebab-case)
+ * @param options - Optional settings for the change
+ * @throws Error if the change name is invalid
+ * @throws Error if the schema name is invalid
+ * @throws Error if the change directory already exists
+ *
+ * @returns Result containing the resolved schema name
+ *
+ * @example
+ * // Creates openspec/changes/add-auth/ with default schema
+ * const result = await createChange('/path/to/project', 'add-auth')
+ * console.log(result.schema) // 'spec-driven' or value from config
+ *
+ * @example
+ * // Creates openspec/changes/add-auth/ with TDD schema
+ * const result = await createChange('/path/to/project', 'add-auth', { schema: 'tdd' })
+ * console.log(result.schema) // 'tdd'
+ */
+export async function createChange(projectRoot, name, options = {}) {
+    // Validate the name first
+    const validation = validateChangeName(name);
+    if (!validation.valid) {
+        throw new Error(validation.error);
+    }
+    // Determine schema: explicit option → project config → hardcoded default
+    let schemaName;
+    if (options.schema) {
+        schemaName = options.schema;
+    }
+    else {
+        // Try to read from project config
+        try {
+            const config = readProjectConfig(projectRoot);
+            schemaName = config?.schema ?? DEFAULT_SCHEMA;
+        }
+        catch {
+            // If config read fails, use default
+            schemaName = DEFAULT_SCHEMA;
+        }
+    }
+    // Validate the resolved schema
+    validateSchemaName(schemaName, projectRoot);
+    // Build the change directory path
+    const changeDir = path.join(projectRoot, 'openspec', 'changes', name);
+    // Check if change already exists
+    if (await FileSystemUtils.directoryExists(changeDir)) {
+        throw new Error(`Change '${name}' already exists at ${changeDir}`);
+    }
+    // Create the directory (including parent directories if needed)
+    await FileSystemUtils.createDirectory(changeDir);
+    // Write metadata file with schema and creation date
+    const today = new Date().toISOString().split('T')[0];
+    writeChangeMetadata(changeDir, {
+        schema: schemaName,
+        created: today,
+    }, projectRoot);
+    return { schema: schemaName };
+}
+//# sourceMappingURL=change-utils.js.map

package/dist/utils/file-system.d.ts

@@ -0,0 +1,36 @@
+export declare class FileSystemUtils {
+    /**
+     * Converts a path to use forward slashes (POSIX style).
+     * Essential for cross-platform compatibility with glob libraries like fast-glob.
+     */
+    static toPosixPath(p: string): string;
+    private static isWindowsBasePath;
+    private static normalizeSegments;
+    static joinPath(basePath: string, ...segments: string[]): string;
+    static createDirectory(dirPath: string): Promise<void>;
+    static fileExists(filePath: string): Promise<boolean>;
+    /**
+     * Finds the first existing parent directory by walking up the directory tree.
+     * @param dirPath Starting directory path
+     * @returns The first existing directory path, or null if root is reached without finding one
+     */
+    private static findFirstExistingDirectory;
+    static canWriteFile(filePath: string): Promise<boolean>;
+    static directoryExists(dirPath: string): Promise<boolean>;
+    static writeFile(filePath: string, content: string): Promise<void>;
+    static readFile(filePath: string): Promise<string>;
+    static updateFileWithMarkers(filePath: string, content: string, startMarker: string, endMarker: string): Promise<void>;
+    static ensureWritePermissions(dirPath: string): Promise<boolean>;
+}
+/**
+ * Removes a marker block from file content.
+ * Only removes markers that are on their own lines (ignores inline mentions).
+ * Cleans up double blank lines that may result from removal.
+ *
+ * @param content - File content with markers
+ * @param startMarker - The start marker string
+ * @param endMarker - The end marker string
+ * @returns Content with marker block removed, or original content if markers not found/invalid
+ */
+export declare function removeMarkerBlock(content: string, startMarker: string, endMarker: string): string;
+//# sourceMappingURL=file-system.d.ts.map