openspecui 0.0.0 → 0.2.0

package/references/openspec/src/core/parsers/requirement-blocks.ts

@@ -1,234 +0,0 @@
-export interface RequirementBlock {
-  headerLine: string; // e.g., '### Requirement: Something'
-  name: string; // e.g., 'Something'
-  raw: string; // full block including headerLine and following content
-}
-
-export interface RequirementsSectionParts {
-  before: string;
-  headerLine: string; // the '## Requirements' line
-  preamble: string; // content between headerLine and first requirement block
-  bodyBlocks: RequirementBlock[]; // parsed requirement blocks in order
-  after: string;
-}
-
-export function normalizeRequirementName(name: string): string {
-  return name.trim();
-}
-
-const REQUIREMENT_HEADER_REGEX = /^###\s*Requirement:\s*(.+)\s*$/;
-
-/**
- * Extracts the Requirements section from a spec file and parses requirement blocks.
- */
-export function extractRequirementsSection(content: string): RequirementsSectionParts {
-  const normalized = normalizeLineEndings(content);
-  const lines = normalized.split('\n');
-  const reqHeaderIndex = lines.findIndex(l => /^##\s+Requirements\s*$/i.test(l));
-
-  if (reqHeaderIndex === -1) {
-    // No requirements section; create an empty one at the end
-    const before = content.trimEnd();
-    const headerLine = '## Requirements';
-    return {
-      before: before ? before + '\n\n' : '',
-      headerLine,
-      preamble: '',
-      bodyBlocks: [],
-      after: '\n',
-    };
-  }
-
-  // Find end of this section: next line that starts with '## ' at same or higher level
-  let endIndex = lines.length;
-  for (let i = reqHeaderIndex + 1; i < lines.length; i++) {
-    if (/^##\s+/.test(lines[i])) {
-      endIndex = i;
-      break;
-    }
-  }
-
-  const before = lines.slice(0, reqHeaderIndex).join('\n');
-  const headerLine = lines[reqHeaderIndex];
-  const sectionBodyLines = lines.slice(reqHeaderIndex + 1, endIndex);
-
-  // Parse requirement blocks within section body
-  const blocks: RequirementBlock[] = [];
-  let cursor = 0;
-  let preambleLines: string[] = [];
-
-  // Collect preamble lines until first requirement header
-  while (cursor < sectionBodyLines.length && !/^###\s+Requirement:/.test(sectionBodyLines[cursor])) {
-    preambleLines.push(sectionBodyLines[cursor]);
-    cursor++;
-  }
-
-  while (cursor < sectionBodyLines.length) {
-    const headerStart = cursor;
-    const headerLineCandidate = sectionBodyLines[cursor];
-    const headerMatch = headerLineCandidate.match(REQUIREMENT_HEADER_REGEX);
-    if (!headerMatch) {
-      // Not a requirement header; skip line defensively
-      cursor++;
-      continue;
-    }
-    const name = normalizeRequirementName(headerMatch[1]);
-    cursor++;
-    // Gather lines until next requirement header or end of section
-    const bodyLines: string[] = [headerLineCandidate];
-    while (cursor < sectionBodyLines.length && !/^###\s+Requirement:/.test(sectionBodyLines[cursor]) && !/^##\s+/.test(sectionBodyLines[cursor])) {
-      bodyLines.push(sectionBodyLines[cursor]);
-      cursor++;
-    }
-    const raw = bodyLines.join('\n').trimEnd();
-    blocks.push({ headerLine: headerLineCandidate, name, raw });
-  }
-
-  const after = lines.slice(endIndex).join('\n');
-  const preamble = preambleLines.join('\n').trimEnd();
-
-  return {
-    before: before.trimEnd() ? before + '\n' : before,
-    headerLine,
-    preamble,
-    bodyBlocks: blocks,
-    after: after.startsWith('\n') ? after : '\n' + after,
-  };
-}
-
-export interface DeltaPlan {
-  added: RequirementBlock[];
-  modified: RequirementBlock[];
-  removed: string[]; // requirement names
-  renamed: Array<{ from: string; to: string }>;
-  sectionPresence: {
-    added: boolean;
-    modified: boolean;
-    removed: boolean;
-    renamed: boolean;
-  };
-}
-
-function normalizeLineEndings(content: string): string {
-  return content.replace(/\r\n?/g, '\n');
-}
-
-/**
- * Parse a delta-formatted spec change file content into a DeltaPlan with raw blocks.
- */
-export function parseDeltaSpec(content: string): DeltaPlan {
-  const normalized = normalizeLineEndings(content);
-  const sections = splitTopLevelSections(normalized);
-  const addedLookup = getSectionCaseInsensitive(sections, 'ADDED Requirements');
-  const modifiedLookup = getSectionCaseInsensitive(sections, 'MODIFIED Requirements');
-  const removedLookup = getSectionCaseInsensitive(sections, 'REMOVED Requirements');
-  const renamedLookup = getSectionCaseInsensitive(sections, 'RENAMED Requirements');
-  const added = parseRequirementBlocksFromSection(addedLookup.body);
-  const modified = parseRequirementBlocksFromSection(modifiedLookup.body);
-  const removedNames = parseRemovedNames(removedLookup.body);
-  const renamedPairs = parseRenamedPairs(renamedLookup.body);
-  return {
-    added,
-    modified,
-    removed: removedNames,
-    renamed: renamedPairs,
-    sectionPresence: {
-      added: addedLookup.found,
-      modified: modifiedLookup.found,
-      removed: removedLookup.found,
-      renamed: renamedLookup.found,
-    },
-  };
-}
-
-function splitTopLevelSections(content: string): Record<string, string> {
-  const lines = content.split('\n');
-  const result: Record<string, string> = {};
-  const indices: Array<{ title: string; index: number; level: number }> = [];
-  for (let i = 0; i < lines.length; i++) {
-    const m = lines[i].match(/^(##)\s+(.+)$/);
-    if (m) {
-      const level = m[1].length; // only care for '##'
-      indices.push({ title: m[2].trim(), index: i, level });
-    }
-  }
-  for (let i = 0; i < indices.length; i++) {
-    const current = indices[i];
-    const next = indices[i + 1];
-    const body = lines.slice(current.index + 1, next ? next.index : lines.length).join('\n');
-    result[current.title] = body;
-  }
-  return result;
-}
-
-function getSectionCaseInsensitive(sections: Record<string, string>, desired: string): { body: string; found: boolean } {
-  const target = desired.toLowerCase();
-  for (const [title, body] of Object.entries(sections)) {
-    if (title.toLowerCase() === target) return { body, found: true };
-  }
-  return { body: '', found: false };
-}
-
-function parseRequirementBlocksFromSection(sectionBody: string): RequirementBlock[] {
-  if (!sectionBody) return [];
-  const lines = normalizeLineEndings(sectionBody).split('\n');
-  const blocks: RequirementBlock[] = [];
-  let i = 0;
-  while (i < lines.length) {
-    // Seek next requirement header
-    while (i < lines.length && !/^###\s+Requirement:/.test(lines[i])) i++;
-    if (i >= lines.length) break;
-    const headerLine = lines[i];
-    const m = headerLine.match(REQUIREMENT_HEADER_REGEX);
-    if (!m) { i++; continue; }
-    const name = normalizeRequirementName(m[1]);
-    const buf: string[] = [headerLine];
-    i++;
-    while (i < lines.length && !/^###\s+Requirement:/.test(lines[i]) && !/^##\s+/.test(lines[i])) {
-      buf.push(lines[i]);
-      i++;
-    }
-    blocks.push({ headerLine, name, raw: buf.join('\n').trimEnd() });
-  }
-  return blocks;
-}
-
-function parseRemovedNames(sectionBody: string): string[] {
-  if (!sectionBody) return [];
-  const names: string[] = [];
-  const lines = normalizeLineEndings(sectionBody).split('\n');
-  for (const line of lines) {
-    const m = line.match(REQUIREMENT_HEADER_REGEX);
-    if (m) {
-      names.push(normalizeRequirementName(m[1]));
-      continue;
-    }
-    // Also support bullet list of headers
-    const bullet = line.match(/^\s*-\s*`?###\s*Requirement:\s*(.+?)`?\s*$/);
-    if (bullet) {
-      names.push(normalizeRequirementName(bullet[1]));
-    }
-  }
-  return names;
-}
-
-function parseRenamedPairs(sectionBody: string): Array<{ from: string; to: string }> {
-  if (!sectionBody) return [];
-  const pairs: Array<{ from: string; to: string }> = [];
-  const lines = normalizeLineEndings(sectionBody).split('\n');
-  let current: { from?: string; to?: string } = {};
-  for (const line of lines) {
-    const fromMatch = line.match(/^\s*-?\s*FROM:\s*`?###\s*Requirement:\s*(.+?)`?\s*$/);
-    const toMatch = line.match(/^\s*-?\s*TO:\s*`?###\s*Requirement:\s*(.+?)`?\s*$/);
-    if (fromMatch) {
-      current.from = normalizeRequirementName(fromMatch[1]);
-    } else if (toMatch) {
-      current.to = normalizeRequirementName(toMatch[1]);
-      if (current.from && current.to) {
-        pairs.push({ from: current.from, to: current.to });
-        current = {};
-      }
-    }
-  }
-  return pairs;
-}

package/references/openspec/src/core/schemas/base.schema.ts

@@ -1,20 +0,0 @@
-import { z } from 'zod';
-import { VALIDATION_MESSAGES } from '../validation/constants.js';
-
-export const ScenarioSchema = z.object({
-  rawText: z.string().min(1, VALIDATION_MESSAGES.SCENARIO_EMPTY),
-});
-
-export const RequirementSchema = z.object({
-  text: z.string()
-    .min(1, VALIDATION_MESSAGES.REQUIREMENT_EMPTY)
-    .refine(
-      (text) => text.includes('SHALL') || text.includes('MUST'),
-      VALIDATION_MESSAGES.REQUIREMENT_NO_SHALL
-    ),
-  scenarios: z.array(ScenarioSchema)
-    .min(1, VALIDATION_MESSAGES.REQUIREMENT_NO_SCENARIOS),
-});
-
-export type Scenario = z.infer<typeof ScenarioSchema>;
-export type Requirement = z.infer<typeof RequirementSchema>;

package/references/openspec/src/core/schemas/change.schema.ts

@@ -1,42 +0,0 @@
-import { z } from 'zod';
-import { RequirementSchema } from './base.schema.js';
-import { 
-  MIN_WHY_SECTION_LENGTH,
-  MAX_WHY_SECTION_LENGTH,
-  MAX_DELTAS_PER_CHANGE,
-  VALIDATION_MESSAGES 
-} from '../validation/constants.js';
-
-export const DeltaOperationType = z.enum(['ADDED', 'MODIFIED', 'REMOVED', 'RENAMED']);
-
-export const DeltaSchema = z.object({
-  spec: z.string().min(1, VALIDATION_MESSAGES.DELTA_SPEC_EMPTY),
-  operation: DeltaOperationType,
-  description: z.string().min(1, VALIDATION_MESSAGES.DELTA_DESCRIPTION_EMPTY),
-  requirement: RequirementSchema.optional(),
-  requirements: z.array(RequirementSchema).optional(),
-  rename: z.object({
-    from: z.string(),
-    to: z.string(),
-  }).optional(),
-});
-
-export const ChangeSchema = z.object({
-  name: z.string().min(1, VALIDATION_MESSAGES.CHANGE_NAME_EMPTY),
-  why: z.string()
-    .min(MIN_WHY_SECTION_LENGTH, VALIDATION_MESSAGES.CHANGE_WHY_TOO_SHORT)
-    .max(MAX_WHY_SECTION_LENGTH, VALIDATION_MESSAGES.CHANGE_WHY_TOO_LONG),
-  whatChanges: z.string().min(1, VALIDATION_MESSAGES.CHANGE_WHAT_EMPTY),
-  deltas: z.array(DeltaSchema)
-    .min(1, VALIDATION_MESSAGES.CHANGE_NO_DELTAS)
-    .max(MAX_DELTAS_PER_CHANGE, VALIDATION_MESSAGES.CHANGE_TOO_MANY_DELTAS),
-  metadata: z.object({
-    version: z.string().default('1.0.0'),
-    format: z.literal('openspec-change'),
-    sourcePath: z.string().optional(),
-  }).optional(),
-});
-
-export type DeltaOperation = z.infer<typeof DeltaOperationType>;
-export type Delta = z.infer<typeof DeltaSchema>;
-export type Change = z.infer<typeof ChangeSchema>;

package/references/openspec/src/core/schemas/index.ts

@@ -1,20 +0,0 @@
-export {
-  ScenarioSchema,
-  RequirementSchema,
-  type Scenario,
-  type Requirement,
-} from './base.schema.js';
-
-export {
-  SpecSchema,
-  type Spec,
-} from './spec.schema.js';
-
-export {
-  DeltaOperationType,
-  DeltaSchema,
-  ChangeSchema,
-  type DeltaOperation,
-  type Delta,
-  type Change,
-} from './change.schema.js';

package/references/openspec/src/core/schemas/spec.schema.ts

@@ -1,17 +0,0 @@
-import { z } from 'zod';
-import { RequirementSchema } from './base.schema.js';
-import { VALIDATION_MESSAGES } from '../validation/constants.js';
-
-export const SpecSchema = z.object({
-  name: z.string().min(1, VALIDATION_MESSAGES.SPEC_NAME_EMPTY),
-  overview: z.string().min(1, VALIDATION_MESSAGES.SPEC_PURPOSE_EMPTY),
-  requirements: z.array(RequirementSchema)
-    .min(1, VALIDATION_MESSAGES.SPEC_NO_REQUIREMENTS),
-  metadata: z.object({
-    version: z.string().default('1.0.0'),
-    format: z.literal('openspec'),
-    sourcePath: z.string().optional(),
-  }).optional(),
-});
-
-export type Spec = z.infer<typeof SpecSchema>;

package/references/openspec/src/core/styles/palette.ts

@@ -1,8 +0,0 @@
-import chalk from 'chalk';
-
-export const PALETTE = {
-  white: chalk.hex('#f4f4f4'),
-  lightGray: chalk.hex('#c8c8c8'),
-  midGray: chalk.hex('#8a8a8a'),
-  darkGray: chalk.hex('#4a4a4a')
-};

package/references/openspec/src/core/templates/agents-root-stub.ts

@@ -1,16 +0,0 @@
-export const agentsRootStubTemplate = `# OpenSpec Instructions
-
-These instructions are for AI assistants working in this project.
-
-Always open \`@/openspec/AGENTS.md\` when the request:
-- Mentions planning or proposals (words like proposal, spec, change, plan)
-- Introduces new capabilities, breaking changes, architecture shifts, or big performance/security work
-- Sounds ambiguous and you need the authoritative spec before coding
-
-Use \`@/openspec/AGENTS.md\` to learn:
-- How to create and apply change proposals
-- Spec format and conventions
-- Project structure and guidelines
-
-Keep this managed block so 'openspec update' can refresh the instructions.
-`;