@fission-ai/openspec 0.21.0 → 0.22.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/cli/index.js CHANGED
@@ -16,6 +16,7 @@ import { CompletionCommand } from '../commands/completion.js';
16
16
  import { FeedbackCommand } from '../commands/feedback.js';
17
17
  import { registerConfigCommand } from '../commands/config.js';
18
18
  import { registerArtifactWorkflowCommands } from '../commands/artifact-workflow.js';
19
+ import { registerSchemaCommand } from '../commands/schema.js';
19
20
  import { maybeShowTelemetryNotice, trackCommand, shutdown } from '../telemetry/index.js';
20
21
  const program = new Command();
21
22
  const require = createRequire(import.meta.url);
@@ -230,6 +231,7 @@ program
230
231
  });
231
232
  registerSpecCommand(program);
232
233
  registerConfigCommand(program);
234
+ registerSchemaCommand(program);
233
235
  // Top-level validate command
234
236
  program
235
237
  .command('validate [item-name]')
@@ -16,6 +16,7 @@ import { loadChangeContext, formatChangeStatus, generateInstructions, listSchema
16
16
  import { createChange, validateChangeName } from '../utils/change-utils.js';
17
17
  import { getExploreSkillTemplate, getNewChangeSkillTemplate, getContinueChangeSkillTemplate, getApplyChangeSkillTemplate, getFfChangeSkillTemplate, getSyncSpecsSkillTemplate, getArchiveChangeSkillTemplate, getVerifyChangeSkillTemplate, getOpsxExploreCommandTemplate, getOpsxNewCommandTemplate, getOpsxContinueCommandTemplate, getOpsxApplyCommandTemplate, getOpsxFfCommandTemplate, getOpsxSyncCommandTemplate, getOpsxArchiveCommandTemplate, getOpsxVerifyCommandTemplate } from '../core/templates/skill-templates.js';
18
18
  import { FileSystemUtils } from '../utils/file-system.js';
19
+ import { promptForConfig, serializeConfig, isExitPromptError } from '../core/config-prompts.js';
19
20
  const DEFAULT_SCHEMA = 'spec-driven';
20
21
  /**
21
22
  * Checks if color output is disabled via NO_COLOR env or --no-color flag.
@@ -97,11 +98,14 @@ async function validateChangeExists(changeName, projectRoot) {
97
98
  }
98
99
  /**
99
100
  * Validates that a schema exists and returns available schemas if not.
101
+ *
102
+ * @param schemaName - The schema name to validate
103
+ * @param projectRoot - Optional project root for project-local schema resolution
100
104
  */
101
- function validateSchemaExists(schemaName) {
102
- const schemaDir = getSchemaDir(schemaName);
105
+ function validateSchemaExists(schemaName, projectRoot) {
106
+ const schemaDir = getSchemaDir(schemaName, projectRoot);
103
107
  if (!schemaDir) {
104
- const availableSchemas = listSchemas();
108
+ const availableSchemas = listSchemas(projectRoot);
105
109
  throw new Error(`Schema '${schemaName}' not found. Available schemas:\n ${availableSchemas.join('\n ')}`);
106
110
  }
107
111
  return schemaName;
@@ -113,7 +117,7 @@ async function statusCommand(options) {
113
117
  const changeName = await validateChangeExists(options.change, projectRoot);
114
118
  // Validate schema if explicitly provided
115
119
  if (options.schema) {
116
- validateSchemaExists(options.schema);
120
+ validateSchemaExists(options.schema, projectRoot);
117
121
  }
118
122
  // loadChangeContext will auto-detect schema from metadata if not provided
119
123
  const context = loadChangeContext(projectRoot, changeName, options.schema);
@@ -158,7 +162,7 @@ async function instructionsCommand(artifactId, options) {
158
162
  const changeName = await validateChangeExists(options.change, projectRoot);
159
163
  // Validate schema if explicitly provided
160
164
  if (options.schema) {
161
- validateSchemaExists(options.schema);
165
+ validateSchemaExists(options.schema, projectRoot);
162
166
  }
163
167
  // loadChangeContext will auto-detect schema from metadata if not provided
164
168
  const context = loadChangeContext(projectRoot, changeName, options.schema);
@@ -173,7 +177,7 @@ async function instructionsCommand(artifactId, options) {
173
177
  const validIds = context.graph.getAllArtifacts().map((a) => a.id);
174
178
  throw new Error(`Artifact '${artifactId}' not found in schema '${context.schemaName}'. Valid artifacts:\n ${validIds.join('\n ')}`);
175
179
  }
176
- const instructions = generateInstructions(context, artifactId);
180
+ const instructions = generateInstructions(context, artifactId, projectRoot);
177
181
  const isBlocked = instructions.dependencies.some((d) => !d.done);
178
182
  spinner.stop();
179
183
  if (options.json) {
@@ -433,7 +437,7 @@ async function applyInstructionsCommand(options) {
433
437
  const changeName = await validateChangeExists(options.change, projectRoot);
434
438
  // Validate schema if explicitly provided
435
439
  if (options.schema) {
436
- validateSchemaExists(options.schema);
440
+ validateSchemaExists(options.schema, projectRoot);
437
441
  }
438
442
  // generateApplyInstructions uses loadChangeContext which auto-detects schema
439
443
  const instructions = await generateApplyInstructions(projectRoot, changeName, options.schema);
@@ -498,18 +502,29 @@ function printApplyInstructionsText(instructions) {
498
502
  async function templatesCommand(options) {
499
503
  const spinner = ora('Loading templates...').start();
500
504
  try {
501
- const schemaName = validateSchemaExists(options.schema ?? DEFAULT_SCHEMA);
502
- const schema = resolveSchema(schemaName);
505
+ const projectRoot = process.cwd();
506
+ const schemaName = validateSchemaExists(options.schema ?? DEFAULT_SCHEMA, projectRoot);
507
+ const schema = resolveSchema(schemaName, projectRoot);
503
508
  const graph = ArtifactGraph.fromSchema(schema);
504
- const schemaDir = getSchemaDir(schemaName);
505
- // Determine if this is a user override or package built-in
506
- const { getUserSchemasDir } = await import('../core/artifact-graph/resolver.js');
509
+ const schemaDir = getSchemaDir(schemaName, projectRoot);
510
+ // Determine the source (project, user, or package)
511
+ const { getUserSchemasDir, getProjectSchemasDir, } = await import('../core/artifact-graph/resolver.js');
512
+ const projectSchemasDir = getProjectSchemasDir(projectRoot);
507
513
  const userSchemasDir = getUserSchemasDir();
508
- const isUserOverride = schemaDir.startsWith(userSchemasDir);
514
+ let source;
515
+ if (schemaDir.startsWith(projectSchemasDir)) {
516
+ source = 'project';
517
+ }
518
+ else if (schemaDir.startsWith(userSchemasDir)) {
519
+ source = 'user';
520
+ }
521
+ else {
522
+ source = 'package';
523
+ }
509
524
  const templates = graph.getAllArtifacts().map((artifact) => ({
510
525
  artifactId: artifact.id,
511
526
  templatePath: path.join(schemaDir, 'templates', artifact.template),
512
- source: isUserOverride ? 'user' : 'package',
527
+ source,
513
528
  }));
514
529
  spinner.stop();
515
530
  if (options.json) {
@@ -521,7 +536,7 @@ async function templatesCommand(options) {
521
536
  return;
522
537
  }
523
538
  console.log(`Schema: ${schemaName}`);
524
- console.log(`Source: ${isUserOverride ? 'user override' : 'package built-in'}`);
539
+ console.log(`Source: ${source}`);
525
540
  console.log();
526
541
  for (const t of templates) {
527
542
  console.log(`${t.artifactId}:`);
@@ -541,15 +556,15 @@ async function newChangeCommand(name, options) {
541
556
  if (!validation.valid) {
542
557
  throw new Error(validation.error);
543
558
  }
559
+ const projectRoot = process.cwd();
544
560
  // Validate schema if provided
545
561
  if (options.schema) {
546
- validateSchemaExists(options.schema);
562
+ validateSchemaExists(options.schema, projectRoot);
547
563
  }
548
564
  const schemaDisplay = options.schema ? ` with schema '${options.schema}'` : '';
549
565
  const spinner = ora(`Creating change '${name}'${schemaDisplay}...`).start();
550
566
  try {
551
- const projectRoot = process.cwd();
552
- await createChange(projectRoot, name, { schema: options.schema });
567
+ const result = await createChange(projectRoot, name, { schema: options.schema });
553
568
  // If description provided, create README.md with description
554
569
  if (options.description) {
555
570
  const { promises: fs } = await import('fs');
@@ -557,8 +572,7 @@ async function newChangeCommand(name, options) {
557
572
  const readmePath = path.join(changeDir, 'README.md');
558
573
  await fs.writeFile(readmePath, `# ${name}\n\n${options.description}\n`, 'utf-8');
559
574
  }
560
- const schemaUsed = options.schema ?? DEFAULT_SCHEMA;
561
- spinner.succeed(`Created change '${name}' at openspec/changes/${name}/ (schema: ${schemaUsed})`);
575
+ spinner.succeed(`Created change '${name}' at openspec/changes/${name}/ (schema: ${result.schema})`);
562
576
  }
563
577
  catch (error) {
564
578
  spinner.fail(`Failed to create change '${name}'`);
@@ -667,6 +681,118 @@ ${template.content}
667
681
  console.log(chalk.green(' ✓ ' + file));
668
682
  }
669
683
  console.log();
684
+ // Config creation section
685
+ console.log('━'.repeat(70));
686
+ console.log();
687
+ console.log(chalk.bold('📋 Project Configuration (Optional)'));
688
+ console.log();
689
+ console.log('Configure project defaults for OpenSpec workflows.');
690
+ console.log();
691
+ // Check if config already exists
692
+ const configPath = path.join(projectRoot, 'openspec', 'config.yaml');
693
+ const configYmlPath = path.join(projectRoot, 'openspec', 'config.yml');
694
+ const configExists = fs.existsSync(configPath) || fs.existsSync(configYmlPath);
695
+ if (configExists) {
696
+ // Config already exists, skip creation
697
+ console.log(chalk.blue('â„šī¸ openspec/config.yaml already exists. Skipping config creation.'));
698
+ console.log();
699
+ console.log(' To update config, edit openspec/config.yaml manually or:');
700
+ console.log(' 1. Delete openspec/config.yaml');
701
+ console.log(' 2. Run openspec artifact-experimental-setup again');
702
+ console.log();
703
+ }
704
+ else if (!process.stdin.isTTY) {
705
+ // Non-interactive mode (CI, automation, piped input)
706
+ console.log(chalk.blue('â„šī¸ Skipping config prompts (non-interactive mode)'));
707
+ console.log();
708
+ console.log(' To create config manually, add openspec/config.yaml with:');
709
+ console.log(chalk.dim(' schema: spec-driven'));
710
+ console.log();
711
+ }
712
+ else {
713
+ // Prompt for config creation
714
+ try {
715
+ const configResult = await promptForConfig(projectRoot);
716
+ if (configResult.createConfig && configResult.schema) {
717
+ // Build config object
718
+ const config = {
719
+ schema: configResult.schema,
720
+ context: configResult.context,
721
+ rules: configResult.rules,
722
+ };
723
+ // Serialize to YAML
724
+ const yamlContent = serializeConfig(config);
725
+ // Write config file
726
+ try {
727
+ await FileSystemUtils.writeFile(configPath, yamlContent);
728
+ console.log();
729
+ console.log(chalk.green('✓ Created openspec/config.yaml'));
730
+ console.log();
731
+ console.log('━'.repeat(70));
732
+ console.log();
733
+ console.log(chalk.bold('📖 Config created at: openspec/config.yaml'));
734
+ // Display summary
735
+ const contextLines = config.context ? config.context.split('\n').length : 0;
736
+ const rulesCount = config.rules ? Object.keys(config.rules).length : 0;
737
+ console.log(` â€ĸ Default schema: ${chalk.cyan(config.schema)}`);
738
+ if (contextLines > 0) {
739
+ console.log(` â€ĸ Project context: ${chalk.cyan(`Added (${contextLines} lines)`)}`);
740
+ }
741
+ if (rulesCount > 0) {
742
+ console.log(` â€ĸ Rules: ${chalk.cyan(`${rulesCount} artifact${rulesCount > 1 ? 's' : ''} configured`)}`);
743
+ }
744
+ console.log();
745
+ // Usage examples
746
+ console.log(chalk.bold('Usage:'));
747
+ console.log(' â€ĸ New changes automatically use this schema');
748
+ console.log(' â€ĸ Context injected into all artifact instructions');
749
+ console.log(' â€ĸ Rules applied to matching artifacts');
750
+ console.log();
751
+ // Git commit suggestion
752
+ console.log(chalk.bold('To share with team:'));
753
+ console.log(chalk.dim(' git add openspec/config.yaml .claude/'));
754
+ console.log(chalk.dim(' git commit -m "Setup OpenSpec experimental workflow with project config"'));
755
+ console.log();
756
+ }
757
+ catch (writeError) {
758
+ // Handle file write errors
759
+ console.error();
760
+ console.error(chalk.red('✗ Failed to write openspec/config.yaml'));
761
+ console.error(chalk.dim(` ${writeError.message}`));
762
+ console.error();
763
+ console.error('Fallback: Create config manually:');
764
+ console.error(chalk.dim(' 1. Create openspec/config.yaml'));
765
+ console.error(chalk.dim(' 2. Copy the following content:'));
766
+ console.error();
767
+ console.error(chalk.dim(yamlContent));
768
+ console.error();
769
+ }
770
+ }
771
+ else {
772
+ // User chose not to create config
773
+ console.log();
774
+ console.log(chalk.blue('â„šī¸ Skipped config creation.'));
775
+ console.log(' You can create openspec/config.yaml manually later.');
776
+ console.log();
777
+ }
778
+ }
779
+ catch (promptError) {
780
+ if (isExitPromptError(promptError)) {
781
+ // User cancelled (Ctrl+C)
782
+ console.log();
783
+ console.log(chalk.blue('â„šī¸ Config creation cancelled'));
784
+ console.log(' Skills and commands already created');
785
+ console.log(' Run setup again to create config later');
786
+ console.log();
787
+ }
788
+ else {
789
+ // Unexpected error
790
+ throw promptError;
791
+ }
792
+ }
793
+ }
794
+ console.log('━'.repeat(70));
795
+ console.log();
670
796
  console.log(chalk.bold('📖 Usage:'));
671
797
  console.log();
672
798
  console.log(' ' + chalk.cyan('Skills') + ' work automatically in compatible editors:');
@@ -699,7 +825,8 @@ ${template.content}
699
825
  }
700
826
  }
701
827
  async function schemasCommand(options) {
702
- const schemas = listSchemasWithInfo();
828
+ const projectRoot = process.cwd();
829
+ const schemas = listSchemasWithInfo(projectRoot);
703
830
  if (options.json) {
704
831
  console.log(JSON.stringify(schemas, null, 2));
705
832
  return;
@@ -707,7 +834,13 @@ async function schemasCommand(options) {
707
834
  console.log('Available schemas:');
708
835
  console.log();
709
836
  for (const schema of schemas) {
710
- const sourceLabel = schema.source === 'user' ? chalk.dim(' (user override)') : '';
837
+ let sourceLabel = '';
838
+ if (schema.source === 'project') {
839
+ sourceLabel = chalk.cyan(' (project)');
840
+ }
841
+ else if (schema.source === 'user') {
842
+ sourceLabel = chalk.dim(' (user override)');
843
+ }
711
844
  console.log(` ${chalk.bold(schema.name)}${sourceLabel}`);
712
845
  console.log(` ${schema.description}`);
713
846
  console.log(` Artifacts: ${schema.artifacts.join(' → ')}`);
@@ -0,0 +1,6 @@
1
+ import { Command } from 'commander';
2
+ /**
3
+ * Register the schema command and all its subcommands.
4
+ */
5
+ export declare function registerSchemaCommand(program: Command): void;
6
+ //# sourceMappingURL=schema.d.ts.map