@specmarket/cli 0.0.4 → 0.0.6

package/src/lib/meta-instructions.test.ts

@@ -0,0 +1,340 @@
+import { describe, it, expect, beforeEach, afterEach } from 'vitest';
+import { mkdir, writeFile, rm } from 'fs/promises';
+import { join } from 'path';
+import { tmpdir } from 'os';
+import { randomUUID } from 'crypto';
+import { generateMetaInstructions, META_INSTRUCTION_FILENAME } from './meta-instructions.js';
+
+describe('generateMetaInstructions', () => {
+  let tmpDir: string;
+
+  beforeEach(async () => {
+    tmpDir = join(tmpdir(), `meta-instr-${randomUUID()}`);
+    await mkdir(tmpDir, { recursive: true });
+  });
+
+  afterEach(async () => {
+    await rm(tmpDir, { recursive: true, force: true });
+  });
+
+  // ── META_INSTRUCTION_FILENAME constant ───────────────────────────────────
+
+  it('exports META_INSTRUCTION_FILENAME as .specmarket-runner.md', () => {
+    expect(META_INSTRUCTION_FILENAME).toBe('.specmarket-runner.md');
+  });
+
+  // ── Sidecar data injection ───────────────────────────────────────────────
+
+  it('includes display_name and description from specmarket.yaml when present', async () => {
+    await writeFile(
+      join(tmpDir, 'specmarket.yaml'),
+      'spec_format: specmarket\ndisplay_name: My Spec\ndescription: A test spec.'
+    );
+    const content = await generateMetaInstructions(tmpDir, 'specmarket');
+    expect(content).toContain('My Spec');
+    expect(content).toContain('A test spec.');
+  });
+
+  it('omits display_name/description lines when specmarket.yaml absent', async () => {
+    const content = await generateMetaInstructions(tmpDir, 'specmarket');
+    expect(content).not.toContain('**Spec:**');
+    expect(content).not.toContain('**Description:**');
+  });
+
+  it('includes preamble for every format', async () => {
+    for (const fmt of ['specmarket', 'speckit', 'bmad', 'ralph', 'custom']) {
+      const content = await generateMetaInstructions(tmpDir, fmt);
+      expect(content).toContain('# SpecMarket Runner Instructions');
+      expect(content).toContain('You are an AI coding agent');
+    }
+  });
+
+  // ── specmarket format ────────────────────────────────────────────────────
+
+  describe('specmarket format', () => {
+    it('returns content identifying specmarket format', async () => {
+      const content = await generateMetaInstructions(tmpDir, 'specmarket');
+      expect(content).toContain('SpecMarket (Native)');
+    });
+
+    it('lists present spec files', async () => {
+      await writeFile(join(tmpDir, 'PROMPT.md'), '# Prompt');
+      await writeFile(join(tmpDir, 'SPEC.md'), '# Spec');
+      const content = await generateMetaInstructions(tmpDir, 'specmarket');
+      expect(content).toContain('`PROMPT.md`');
+      expect(content).toContain('`SPEC.md`');
+    });
+
+    it('does not list absent spec files', async () => {
+      // Only write PROMPT.md — SPEC.md absent
+      await writeFile(join(tmpDir, 'PROMPT.md'), '# Prompt');
+      const content = await generateMetaInstructions(tmpDir, 'specmarket');
+      expect(content).toContain('`PROMPT.md`');
+      expect(content).not.toContain('`SPEC.md`');
+    });
+
+    it('includes task tracking with TASKS.md format', async () => {
+      const content = await generateMetaInstructions(tmpDir, 'specmarket');
+      expect(content).toContain('TASKS.md');
+      expect(content).toContain('- [ ]');
+      expect(content).toContain('- [x]');
+    });
+
+    it('includes SUCCESS_CRITERIA.md in completion criteria', async () => {
+      const content = await generateMetaInstructions(tmpDir, 'specmarket');
+      expect(content).toContain('SUCCESS_CRITERIA.md');
+    });
+
+    it('includes testing section', async () => {
+      const content = await generateMetaInstructions(tmpDir, 'specmarket');
+      expect(content).toContain('Running Tests');
+      expect(content).toContain('npm test');
+    });
+
+    it('includes completion reminders', async () => {
+      const content = await generateMetaInstructions(tmpDir, 'specmarket');
+      expect(content).toContain('Important Reminders');
+    });
+  });
+
+  // ── speckit format ───────────────────────────────────────────────────────
+
+  describe('speckit format', () => {
+    it('returns content identifying speckit format', async () => {
+      const content = await generateMetaInstructions(tmpDir, 'speckit');
+      expect(content).toContain('Spec Kit');
+    });
+
+    it('references tasks.md when present', async () => {
+      await writeFile(join(tmpDir, 'spec.md'), '# Spec');
+      await writeFile(join(tmpDir, 'tasks.md'), '# Tasks');
+      const content = await generateMetaInstructions(tmpDir, 'speckit');
+      expect(content).toContain('tasks.md');
+    });
+
+    it('references plan.md when tasks.md absent but plan.md present', async () => {
+      await writeFile(join(tmpDir, 'spec.md'), '# Spec');
+      await writeFile(join(tmpDir, 'plan.md'), '# Plan');
+      const content = await generateMetaInstructions(tmpDir, 'speckit');
+      expect(content).toContain('plan.md');
+    });
+
+    it('defaults to tasks.md when neither file is present', async () => {
+      const content = await generateMetaInstructions(tmpDir, 'speckit');
+      expect(content).toContain('tasks.md');
+    });
+
+    it('mentions .specify/ when that directory exists', async () => {
+      await mkdir(join(tmpDir, '.specify'), { recursive: true });
+      const content = await generateMetaInstructions(tmpDir, 'speckit');
+      expect(content).toContain('.specify/');
+    });
+
+    it('does not mention .specify/ when absent', async () => {
+      const content = await generateMetaInstructions(tmpDir, 'speckit');
+      expect(content).not.toContain('.specify/');
+    });
+
+    it('includes testing section', async () => {
+      const content = await generateMetaInstructions(tmpDir, 'speckit');
+      expect(content).toContain('Running Tests');
+    });
+  });
+
+  // ── bmad format ──────────────────────────────────────────────────────────
+
+  describe('bmad format', () => {
+    it('returns content identifying bmad format', async () => {
+      const content = await generateMetaInstructions(tmpDir, 'bmad');
+      expect(content).toContain('BMAD Method');
+    });
+
+    it('lists present story files', async () => {
+      await writeFile(join(tmpDir, 'story-1.md'), '# Story 1');
+      await writeFile(join(tmpDir, 'story-2.md'), '# Story 2');
+      const content = await generateMetaInstructions(tmpDir, 'bmad');
+      expect(content).toContain('story-1.md');
+      expect(content).toContain('story-2.md');
+    });
+
+    it('notes when no story files found', async () => {
+      const content = await generateMetaInstructions(tmpDir, 'bmad');
+      expect(content).toContain('No story');
+    });
+
+    it('references prd.md and architecture.md when present', async () => {
+      await writeFile(join(tmpDir, 'prd.md'), '# PRD');
+      await writeFile(join(tmpDir, 'architecture.md'), '# Arch');
+      const content = await generateMetaInstructions(tmpDir, 'bmad');
+      expect(content).toContain('`prd.md`');
+      expect(content).toContain('`architecture.md`');
+    });
+
+    it('includes instructions for marking stories done', async () => {
+      const content = await generateMetaInstructions(tmpDir, 'bmad');
+      expect(content).toContain('Status: Done');
+    });
+
+    it('includes testing section', async () => {
+      const content = await generateMetaInstructions(tmpDir, 'bmad');
+      expect(content).toContain('Running Tests');
+    });
+
+    it('sorts story files numerically so story-10.md follows story-9.md', async () => {
+      for (let i = 1; i <= 11; i++) {
+        await writeFile(join(tmpDir, `story-${i}.md`), `# Story ${i}`);
+      }
+      const content = await generateMetaInstructions(tmpDir, 'bmad');
+      const pos9 = content.indexOf('story-9.md');
+      const pos10 = content.indexOf('story-10.md');
+      expect(pos9).toBeGreaterThan(-1);
+      expect(pos10).toBeGreaterThan(-1);
+      // story-9 must appear before story-10 in the listing
+      expect(pos9).toBeLessThan(pos10);
+    });
+  });
+
+  // ── ralph format ─────────────────────────────────────────────────────────
+
+  describe('ralph format', () => {
+    it('returns content identifying ralph format', async () => {
+      const content = await generateMetaInstructions(tmpDir, 'ralph');
+      expect(content).toContain('Ralph');
+    });
+
+    it('references prd.json', async () => {
+      const content = await generateMetaInstructions(tmpDir, 'ralph');
+      expect(content).toContain('prd.json');
+    });
+
+    it('lists user story titles from prd.json when available', async () => {
+      await writeFile(
+        join(tmpDir, 'prd.json'),
+        JSON.stringify({
+          userStories: [
+            { title: 'User can log in' },
+            { title: 'User can view dashboard' },
+          ],
+        })
+      );
+      const content = await generateMetaInstructions(tmpDir, 'ralph');
+      expect(content).toContain('User can log in');
+      expect(content).toContain('User can view dashboard');
+    });
+
+    it('uses name field when title is absent', async () => {
+      await writeFile(
+        join(tmpDir, 'prd.json'),
+        JSON.stringify({ userStories: [{ name: 'Build API' }] })
+      );
+      const content = await generateMetaInstructions(tmpDir, 'ralph');
+      expect(content).toContain('Build API');
+    });
+
+    it('falls back to Story N when no title or name', async () => {
+      await writeFile(
+        join(tmpDir, 'prd.json'),
+        JSON.stringify({ userStories: [{ description: 'Some story' }] })
+      );
+      const content = await generateMetaInstructions(tmpDir, 'ralph');
+      expect(content).toContain('Story 1');
+    });
+
+    it('handles prd.json with empty userStories without error', async () => {
+      await writeFile(
+        join(tmpDir, 'prd.json'),
+        JSON.stringify({ userStories: [] })
+      );
+      const content = await generateMetaInstructions(tmpDir, 'ralph');
+      expect(content).toContain('prd.json');
+    });
+
+    it('handles missing prd.json without throwing', async () => {
+      const content = await generateMetaInstructions(tmpDir, 'ralph');
+      expect(content).toContain('prd.json');
+    });
+
+    it('instructs agent to create PROGRESS.md', async () => {
+      const content = await generateMetaInstructions(tmpDir, 'ralph');
+      expect(content).toContain('PROGRESS.md');
+    });
+
+    it('includes testing section', async () => {
+      const content = await generateMetaInstructions(tmpDir, 'ralph');
+      expect(content).toContain('Running Tests');
+    });
+  });
+
+  // ── custom format ────────────────────────────────────────────────────────
+
+  describe('custom format', () => {
+    it('returns content identifying custom format', async () => {
+      const content = await generateMetaInstructions(tmpDir, 'custom');
+      expect(content).toContain('Custom');
+    });
+
+    it('lists top-level markdown files when present', async () => {
+      await writeFile(join(tmpDir, 'README.md'), '# Readme');
+      await writeFile(join(tmpDir, 'requirements.md'), '# Requirements');
+      const content = await generateMetaInstructions(tmpDir, 'custom');
+      expect(content).toContain('README.md');
+      expect(content).toContain('requirements.md');
+    });
+
+    it('notes when no markdown files found', async () => {
+      const content = await generateMetaInstructions(tmpDir, 'custom');
+      expect(content).toContain('no .md files found');
+    });
+
+    it('instructs agent to create PROGRESS.md when no checkboxes', async () => {
+      const content = await generateMetaInstructions(tmpDir, 'custom');
+      expect(content).toContain('PROGRESS.md');
+    });
+
+    it('includes checkbox format instructions', async () => {
+      const content = await generateMetaInstructions(tmpDir, 'custom');
+      expect(content).toContain('- [ ]');
+      expect(content).toContain('- [x]');
+    });
+
+    it('includes testing section', async () => {
+      const content = await generateMetaInstructions(tmpDir, 'custom');
+      expect(content).toContain('Running Tests');
+    });
+  });
+
+  // ── Unknown format fallback ───────────────────────────────────────────────
+
+  it('falls back to custom instructions for unknown format strings', async () => {
+    const content = await generateMetaInstructions(tmpDir, 'my-proprietary-format');
+    expect(content).toContain('# SpecMarket Runner Instructions');
+    expect(content).toContain('Custom');
+  });
+
+  // ── Content structure guarantees ─────────────────────────────────────────
+
+  it.each(['specmarket', 'speckit', 'bmad', 'ralph', 'custom'])(
+    '%s format always includes a testing section with npm test',
+    async (fmt) => {
+      const content = await generateMetaInstructions(tmpDir, fmt);
+      expect(content).toContain('npm test');
+      expect(content).toContain('pytest');
+    }
+  );
+
+  it.each(['specmarket', 'speckit', 'bmad', 'ralph', 'custom'])(
+    '%s format always includes a completion criteria section',
+    async (fmt) => {
+      const content = await generateMetaInstructions(tmpDir, fmt);
+      expect(content).toContain('Completion Criteria');
+    }
+  );
+
+  it.each(['specmarket', 'speckit', 'bmad', 'ralph', 'custom'])(
+    '%s format always includes important reminders',
+    async (fmt) => {
+      const content = await generateMetaInstructions(tmpDir, fmt);
+      expect(content).toContain('Important Reminders');
+    }
+  );
+});