@dynamicworks/br-openspec 1.3.1

package/dist/commands/workflow/new-change.d.ts

@@ -0,0 +1,11 @@
+/**
+ * New Change Command
+ *
+ * Creates a new change directory with optional description and schema.
+ */
+export interface NewChangeOptions {
+    description?: string;
+    schema?: string;
+}
+export declare function newChangeCommand(name: string | undefined, options: NewChangeOptions): Promise<void>;
+//# sourceMappingURL=new-change.d.ts.map

package/dist/commands/workflow/new-change.js

@@ -0,0 +1,44 @@
+/**
+ * New Change Command
+ *
+ * Creates a new change directory with optional description and schema.
+ */
+import ora from 'ora';
+import path from 'path';
+import { createChange, validateChangeName } from '../../utils/change-utils.js';
+import { validateSchemaExists } from './shared.js';
+import { WORKFLOW_MESSAGES } from '../../messages/index.js';
+// -----------------------------------------------------------------------------
+// Command Implementation
+// -----------------------------------------------------------------------------
+export async function newChangeCommand(name, options) {
+    if (!name) {
+        throw new Error(WORKFLOW_MESSAGES.missingNameArgument);
+    }
+    const validation = validateChangeName(name);
+    if (!validation.valid) {
+        throw new Error(validation.error);
+    }
+    const projectRoot = process.cwd();
+    // Validate schema if provided
+    if (options.schema) {
+        validateSchemaExists(options.schema, projectRoot);
+    }
+    const spinner = ora(WORKFLOW_MESSAGES.creatingChange(name, options.schema)).start();
+    try {
+        const result = await createChange(projectRoot, name, { schema: options.schema });
+        // If description provided, create README.md with description
+        if (options.description) {
+            const { promises: fs } = await import('fs');
+            const changeDir = path.join(projectRoot, 'openspec', 'changes', name);
+            const readmePath = path.join(changeDir, 'README.md');
+            await fs.writeFile(readmePath, `# ${name}\n\n${options.description}\n`, 'utf-8');
+        }
+        spinner.succeed(WORKFLOW_MESSAGES.createdChange(name, result.schema));
+    }
+    catch (error) {
+        spinner.fail(WORKFLOW_MESSAGES.failedToCreateChange(name));
+        throw error;
+    }
+}
+//# sourceMappingURL=new-change.js.map

package/dist/commands/workflow/schemas.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Schemas Command
+ *
+ * Lists available workflow schemas with descriptions.
+ */
+export interface SchemasOptions {
+    json?: boolean;
+}
+export declare function schemasCommand(options: SchemasOptions): Promise<void>;
+//# sourceMappingURL=schemas.d.ts.map

package/dist/commands/workflow/schemas.js

@@ -0,0 +1,35 @@
+/**
+ * Schemas Command
+ *
+ * Lists available workflow schemas with descriptions.
+ */
+import chalk from 'chalk';
+import { listSchemasWithInfo } from '../../core/artifact-graph/index.js';
+import { WORKFLOW_MESSAGES } from '../../messages/index.js';
+// -----------------------------------------------------------------------------
+// Command Implementation
+// -----------------------------------------------------------------------------
+export async function schemasCommand(options) {
+    const projectRoot = process.cwd();
+    const schemas = listSchemasWithInfo(projectRoot);
+    if (options.json) {
+        console.log(JSON.stringify(schemas, null, 2));
+        return;
+    }
+    console.log(WORKFLOW_MESSAGES.availableSchemas);
+    console.log();
+    for (const schema of schemas) {
+        let sourceLabel = '';
+        if (schema.source === 'project') {
+            sourceLabel = chalk.cyan(WORKFLOW_MESSAGES.projectLabel);
+        }
+        else if (schema.source === 'user') {
+            sourceLabel = chalk.dim(WORKFLOW_MESSAGES.userOverrideLabel);
+        }
+        console.log(`  ${chalk.bold(schema.name)}${sourceLabel}`);
+        console.log(`    ${schema.description}`);
+        console.log(`    ${WORKFLOW_MESSAGES.artifactsLabel(schema.artifacts.join(' → '))}`);
+        console.log();
+    }
+}
+//# sourceMappingURL=schemas.js.map

package/dist/commands/workflow/shared.d.ts

@@ -0,0 +1,57 @@
+/**
+ * Shared Types and Utilities for Artifact Workflow Commands
+ *
+ * This module contains types, constants, and validation helpers used across
+ * multiple artifact workflow commands.
+ */
+export interface TaskItem {
+    id: string;
+    description: string;
+    done: boolean;
+}
+export interface ApplyInstructions {
+    changeName: string;
+    changeDir: string;
+    schemaName: string;
+    contextFiles: Record<string, string[]>;
+    progress: {
+        total: number;
+        complete: number;
+        remaining: number;
+    };
+    tasks: TaskItem[];
+    state: 'blocked' | 'all_done' | 'ready';
+    missingArtifacts?: string[];
+    instruction: string;
+}
+export declare const DEFAULT_SCHEMA = "spec-driven";
+/**
+ * Checks if color output is disabled via NO_COLOR env or --no-color flag.
+ */
+export declare function isColorDisabled(): boolean;
+/**
+ * Gets the color function based on status.
+ */
+export declare function getStatusColor(status: 'done' | 'ready' | 'blocked'): (text: string) => string;
+/**
+ * Gets the status indicator for an artifact.
+ */
+export declare function getStatusIndicator(status: 'done' | 'ready' | 'blocked'): string;
+/**
+ * Returns the list of available change directory names under openspec/changes/.
+ * Excludes the archive directory and hidden directories.
+ */
+export declare function getAvailableChanges(projectRoot: string): Promise<string[]>;
+/**
+ * Validates that a change exists and returns available changes if not.
+ * Checks directory existence directly to support scaffolded changes (without proposal.md).
+ */
+export declare function validateChangeExists(changeName: string | undefined, projectRoot: string): Promise<string>;
+/**
+ * Validates that a schema exists and returns available schemas if not.
+ *
+ * @param schemaName - The schema name to validate
+ * @param projectRoot - Optional project root for project-local schema resolution
+ */
+export declare function validateSchemaExists(schemaName: string, projectRoot?: string): string;
+//# sourceMappingURL=shared.d.ts.map

package/dist/commands/workflow/shared.js

@@ -0,0 +1,117 @@
+/**
+ * Shared Types and Utilities for Artifact Workflow Commands
+ *
+ * This module contains types, constants, and validation helpers used across
+ * multiple artifact workflow commands.
+ */
+import chalk from 'chalk';
+import path from 'path';
+import * as fs from 'fs';
+import { getSchemaDir, listSchemas } from '../../core/artifact-graph/index.js';
+import { validateChangeName } from '../../utils/change-utils.js';
+import { WORKFLOW_MESSAGES } from '../../messages/index.js';
+// -----------------------------------------------------------------------------
+// Constants
+// -----------------------------------------------------------------------------
+export const DEFAULT_SCHEMA = 'spec-driven';
+// -----------------------------------------------------------------------------
+// Utility Functions
+// -----------------------------------------------------------------------------
+/**
+ * Checks if color output is disabled via NO_COLOR env or --no-color flag.
+ */
+export function isColorDisabled() {
+    return process.env.NO_COLOR === '1' || process.env.NO_COLOR === 'true';
+}
+/**
+ * Gets the color function based on status.
+ */
+export function getStatusColor(status) {
+    if (isColorDisabled()) {
+        return (text) => text;
+    }
+    switch (status) {
+        case 'done':
+            return chalk.green;
+        case 'ready':
+            return chalk.yellow;
+        case 'blocked':
+            return chalk.red;
+    }
+}
+/**
+ * Gets the status indicator for an artifact.
+ */
+export function getStatusIndicator(status) {
+    const color = getStatusColor(status);
+    switch (status) {
+        case 'done':
+            return color('[x]');
+        case 'ready':
+            return color('[ ]');
+        case 'blocked':
+            return color('[-]');
+    }
+}
+/**
+ * Returns the list of available change directory names under openspec/changes/.
+ * Excludes the archive directory and hidden directories.
+ */
+export async function getAvailableChanges(projectRoot) {
+    const changesPath = path.join(projectRoot, 'openspec', 'changes');
+    try {
+        const entries = await fs.promises.readdir(changesPath, { withFileTypes: true });
+        return entries
+            .filter((e) => e.isDirectory() && e.name !== 'archive' && !e.name.startsWith('.'))
+            .map((e) => e.name);
+    }
+    catch (error) {
+        if (error.code === 'ENOENT')
+            return [];
+        throw error;
+    }
+}
+/**
+ * Validates that a change exists and returns available changes if not.
+ * Checks directory existence directly to support scaffolded changes (without proposal.md).
+ */
+export async function validateChangeExists(changeName, projectRoot) {
+    if (!changeName) {
+        const available = await getAvailableChanges(projectRoot);
+        if (available.length === 0) {
+            throw new Error(WORKFLOW_MESSAGES.noChangesFound);
+        }
+        throw new Error(WORKFLOW_MESSAGES.missingChangeOption(available.join('\n  ')));
+    }
+    // Validate change name format to prevent path traversal
+    const nameValidation = validateChangeName(changeName);
+    if (!nameValidation.valid) {
+        throw new Error(WORKFLOW_MESSAGES.invalidChangeName(changeName, nameValidation.error));
+    }
+    // Check directory existence directly
+    const changePath = path.join(projectRoot, 'openspec', 'changes', changeName);
+    const exists = fs.existsSync(changePath) && fs.statSync(changePath).isDirectory();
+    if (!exists) {
+        const available = await getAvailableChanges(projectRoot);
+        if (available.length === 0) {
+            throw new Error(WORKFLOW_MESSAGES.changeNotFoundNoChanges(changeName));
+        }
+        throw new Error(WORKFLOW_MESSAGES.changeNotFound(changeName, available.join('\n  ')));
+    }
+    return changeName;
+}
+/**
+ * Validates that a schema exists and returns available schemas if not.
+ *
+ * @param schemaName - The schema name to validate
+ * @param projectRoot - Optional project root for project-local schema resolution
+ */
+export function validateSchemaExists(schemaName, projectRoot) {
+    const schemaDir = getSchemaDir(schemaName, projectRoot);
+    if (!schemaDir) {
+        const availableSchemas = listSchemas(projectRoot);
+        throw new Error(WORKFLOW_MESSAGES.schemaNotFound(schemaName, availableSchemas.join('\n  ')));
+    }
+    return schemaName;
+}
+//# sourceMappingURL=shared.js.map

package/dist/commands/workflow/status.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Status Command
+ *
+ * Displays artifact completion status for a change.
+ */
+import { type ChangeStatus } from '../../core/artifact-graph/index.js';
+export interface StatusOptions {
+    change?: string;
+    schema?: string;
+    json?: boolean;
+}
+export declare function statusCommand(options: StatusOptions): Promise<void>;
+export declare function printStatusText(status: ChangeStatus): void;
+//# sourceMappingURL=status.d.ts.map

package/dist/commands/workflow/status.js

@@ -0,0 +1,76 @@
+/**
+ * Status Command
+ *
+ * Displays artifact completion status for a change.
+ */
+import ora from 'ora';
+import chalk from 'chalk';
+import { loadChangeContext, formatChangeStatus, } from '../../core/artifact-graph/index.js';
+import { validateChangeExists, validateSchemaExists, getAvailableChanges, getStatusIndicator, getStatusColor, } from './shared.js';
+import { WORKFLOW_MESSAGES } from '../../messages/index.js';
+// -----------------------------------------------------------------------------
+// Command Implementation
+// -----------------------------------------------------------------------------
+export async function statusCommand(options) {
+    const spinner = options.json ? undefined : ora(WORKFLOW_MESSAGES.loadingChangeStatus).start();
+    try {
+        const projectRoot = process.cwd();
+        // Handle no-changes case gracefully — status is informational,
+        // so "no changes" is a valid state, not an error.
+        if (!options.change) {
+            const available = await getAvailableChanges(projectRoot);
+            if (available.length === 0) {
+                spinner?.stop();
+                if (options.json) {
+                    console.log(JSON.stringify({ changes: [], message: WORKFLOW_MESSAGES.noActiveChanges }, null, 2));
+                    return;
+                }
+                console.log(WORKFLOW_MESSAGES.noActiveChanges);
+                return;
+            }
+            // Changes exist but --change not provided
+            spinner?.stop();
+            throw new Error(WORKFLOW_MESSAGES.missingChangeOption(available.join('\n  ')));
+        }
+        const changeName = await validateChangeExists(options.change, projectRoot);
+        // Validate schema if explicitly provided
+        if (options.schema) {
+            validateSchemaExists(options.schema, projectRoot);
+        }
+        // loadChangeContext will auto-detect schema from metadata if not provided
+        const context = loadChangeContext(projectRoot, changeName, options.schema);
+        const status = formatChangeStatus(context);
+        spinner?.stop();
+        if (options.json) {
+            console.log(JSON.stringify(status, null, 2));
+            return;
+        }
+        printStatusText(status);
+    }
+    catch (error) {
+        spinner?.stop();
+        throw error;
+    }
+}
+export function printStatusText(status) {
+    const doneCount = status.artifacts.filter((a) => a.status === 'done').length;
+    const total = status.artifacts.length;
+    console.log(WORKFLOW_MESSAGES.changeLabel(status.changeName));
+    console.log(WORKFLOW_MESSAGES.schemaLabel2(status.schemaName));
+    console.log(WORKFLOW_MESSAGES.progressArtifacts(doneCount, total));
+    console.log();
+    for (const artifact of status.artifacts) {
+        const indicator = getStatusIndicator(artifact.status);
+        const color = getStatusColor(artifact.status);
+        let line = `${indicator} ${artifact.id}`;
+        if (artifact.status === 'blocked' && artifact.missingDeps && artifact.missingDeps.length > 0) {
+            line += color(WORKFLOW_MESSAGES.blockedBy(artifact.missingDeps.join(', ')));
+        }
+        console.log(line);
+    }
+    if (status.isComplete) {
+        console.log();
+        console.log(chalk.green(WORKFLOW_MESSAGES.allArtifactsComplete));
+    }
+}
+//# sourceMappingURL=status.js.map

package/dist/commands/workflow/templates.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Templates Command
+ *
+ * Shows resolved template paths for all artifacts in a schema.
+ */
+export interface TemplatesOptions {
+    schema?: string;
+    json?: boolean;
+}
+export interface TemplateInfo {
+    artifactId: string;
+    templatePath: string;
+    source: 'project' | 'user' | 'package';
+}
+export declare function templatesCommand(options: TemplatesOptions): Promise<void>;
+//# sourceMappingURL=templates.d.ts.map

package/dist/commands/workflow/templates.js

@@ -0,0 +1,70 @@
+/**
+ * Templates Command
+ *
+ * Shows resolved template paths for all artifacts in a schema.
+ */
+import ora from 'ora';
+import path from 'path';
+import { resolveSchema, getSchemaDir, ArtifactGraph, } from '../../core/artifact-graph/index.js';
+import { FileSystemUtils } from '../../utils/file-system.js';
+import { validateSchemaExists, DEFAULT_SCHEMA } from './shared.js';
+import { WORKFLOW_MESSAGES } from '../../messages/index.js';
+// -----------------------------------------------------------------------------
+// Command Implementation
+// -----------------------------------------------------------------------------
+export async function templatesCommand(options) {
+    const spinner = options.json ? undefined : ora(WORKFLOW_MESSAGES.loadingTemplates).start();
+    try {
+        const projectRoot = process.cwd();
+        const schemaName = validateSchemaExists(options.schema ?? DEFAULT_SCHEMA, projectRoot);
+        const schema = resolveSchema(schemaName, projectRoot);
+        const graph = ArtifactGraph.fromSchema(schema);
+        const schemaDir = getSchemaDir(schemaName, projectRoot);
+        // Determine the source (project, user, or package)
+        const { getUserSchemasDir, getProjectSchemasDir, } = await import('../../core/artifact-graph/resolver.js');
+        const projectSchemasDir = getProjectSchemasDir(projectRoot);
+        const userSchemasDir = getUserSchemasDir();
+        // Determine source by checking if schemaDir is inside each base directory
+        // Using path.relative is more robust than startsWith for path comparisons
+        const isInsideDir = (child, parent) => {
+            const relative = path.relative(parent, child);
+            return !relative.startsWith('..') && !path.isAbsolute(relative);
+        };
+        let source;
+        if (isInsideDir(schemaDir, projectSchemasDir)) {
+            source = 'project';
+        }
+        else if (isInsideDir(schemaDir, userSchemasDir)) {
+            source = 'user';
+        }
+        else {
+            source = 'package';
+        }
+        const templates = graph.getAllArtifacts().map((artifact) => ({
+            artifactId: artifact.id,
+            templatePath: FileSystemUtils.canonicalizeExistingPath(path.join(schemaDir, 'templates', artifact.template)),
+            source,
+        }));
+        spinner?.stop();
+        if (options.json) {
+            const output = {};
+            for (const t of templates) {
+                output[t.artifactId] = { path: t.templatePath, source: t.source };
+            }
+            console.log(JSON.stringify(output, null, 2));
+            return;
+        }
+        console.log(WORKFLOW_MESSAGES.schemaLabel3(schemaName));
+        console.log(WORKFLOW_MESSAGES.sourceLabel(source));
+        console.log();
+        for (const t of templates) {
+            console.log(`${t.artifactId}:`);
+            console.log(`  ${t.templatePath}`);
+        }
+    }
+    catch (error) {
+        spinner?.stop();
+        throw error;
+    }
+}
+//# sourceMappingURL=templates.js.map

package/dist/core/archive.d.ts

@@ -0,0 +1,11 @@
+export declare class ArchiveCommand {
+    execute(changeName?: string, options?: {
+        yes?: boolean;
+        skipSpecs?: boolean;
+        noValidate?: boolean;
+        validate?: boolean;
+    }): Promise<void>;
+    private selectChange;
+    private getArchiveDate;
+}
+//# sourceMappingURL=archive.d.ts.map