Skip to content

fix: embed prd-creator structure in roadmap slicer #104

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jonit-dev merged 1 commit into from
May 6, 2026
Merged

fix: embed prd-creator structure in roadmap slicer #104

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
197 changes: 108 additions & 89 deletions packages/core/src/__tests__/templates/slicer-prompt.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,149 +2,174 @@
* Tests for the Slicer Prompt Template rendering system
*/

import { describe, it, expect, beforeEach } from "vitest";
import { describe, it, expect, beforeEach } from 'vitest';
import {
renderSlicerPrompt,
loadSlicerTemplate,
clearTemplateCache,
createSlicerPromptVars,
ISlicerPromptVars,
} from "../../templates/slicer-prompt.js";
} from '../../templates/slicer-prompt.js';

function createTestVars(overrides: Partial<ISlicerPromptVars> = {}): ISlicerPromptVars {
return {
title: "Test Feature",
section: "Features",
description: "A test feature description",
outputFilePath: "/path/to/prds/01-test-feature.md",
prdDir: "/path/to/prds",
title: 'Test Feature',
section: 'Features',
description: 'A test feature description',
outputFilePath: '/path/to/prds/01-test-feature.md',
prdDir: '/path/to/prds',
...overrides,
};
}

describe("slicer-prompt", () => {
describe('slicer-prompt', () => {
beforeEach(() => {
// Clear the template cache before each test
clearTemplateCache();
});

describe("renderSlicerPrompt", () => {
it("should interpolate all placeholders", () => {
describe('renderSlicerPrompt', () => {
it('should interpolate all placeholders', () => {
const vars = createTestVars({
title: "My Awesome Feature",
section: "Roadmap",
description: "This feature does amazing things",
outputFilePath: "/project/docs/PRDs/42-awesome.md",
prdDir: "/project/docs/PRDs",
title: 'My Awesome Feature',
section: 'Roadmap',
description: 'This feature does amazing things',
outputFilePath: '/project/docs/PRDs/42-awesome.md',
prdDir: '/project/docs/PRDs',
});

const result = renderSlicerPrompt(vars);

expect(result).toContain("My Awesome Feature");
expect(result).toContain("Roadmap");
expect(result).toContain("This feature does amazing things");
expect(result).toContain("/project/docs/PRDs/42-awesome.md");
expect(result).toContain("/project/docs/PRDs");
expect(result).toContain('My Awesome Feature');
expect(result).toContain('Roadmap');
expect(result).toContain('This feature does amazing things');
expect(result).toContain('/project/docs/PRDs/42-awesome.md');
expect(result).toContain('/project/docs/PRDs');
});

it("should not contain any uninterpolated placeholders", () => {
it('should not contain any uninterpolated placeholders', () => {
const vars = createTestVars();

const result = renderSlicerPrompt(vars);

expect(result).not.toContain("{{");
expect(result).not.toContain("}}");
expect(result).not.toContain('{{');
expect(result).not.toContain('}}');
});

it("should include prd-creator template structure", () => {
it('should include prd-creator template structure', () => {
const vars = createTestVars();

const result = renderSlicerPrompt(vars);

// Check for key PRD structure elements
expect(result).toContain("Complexity");
expect(result).toContain("Execution Phases");
expect(result).toContain("Context");
expect(result).toContain("Solution");
expect(result).toContain("Acceptance Criteria");
expect(result).toContain('Complexity');
expect(result).toContain('Execution Phases');
expect(result).toContain('Context');
expect(result).toContain('Solution');
expect(result).toContain('Acceptance Criteria');
});

it("should include complexity scoring guide", () => {
it('should embed prd-creator instructions instead of referencing an external file', () => {
const vars = createTestVars();

const result = renderSlicerPrompt(vars);

expect(result).toContain("Complexity Scoring");
expect(result).toContain("Touches 1-5 files");
expect(result).toContain("LOW");
expect(result).toContain("MEDIUM");
expect(result).toContain("HIGH");
expect(result).not.toContain('Read and apply `instructions/prd-creator.md`');
expect(result).not.toContain('Load Planner Skill');
expect(result).toContain('The PRD will be used directly as a GitHub issue body');
});

it("should include instructions to write the file", () => {
it('should include exact required PRD sections inline', () => {
const vars = createTestVars();

const result = renderSlicerPrompt(vars);

expect(result).toContain('## 1. Context');
expect(result).toContain('**Problem:**');
expect(result).toContain('**Files Analyzed:**');
expect(result).toContain('**Current Behavior:**');
expect(result).toContain('## 2. Solution');
expect(result).toContain('## 4. Execution Phases');
expect(result).toContain('## 5. Acceptance Criteria');
expect(result).toContain('The PRD MUST include these sections');
});

it('should include complexity scoring guide', () => {
const vars = createTestVars();

const result = renderSlicerPrompt(vars);

expect(result).toContain('Complexity Scoring');
expect(result).toContain('Touches 1-5 files');
expect(result).toContain('LOW');
expect(result).toContain('MEDIUM');
expect(result).toContain('HIGH');
});

it('should include instructions to write the file', () => {
const vars = createTestVars({
outputFilePath: "/custom/path/feature.md",
outputFilePath: '/custom/path/feature.md',
});

const result = renderSlicerPrompt(vars);

expect(result).toContain("/custom/path/feature.md");
expect(result).toContain("Write tool");
expect(result).toContain('/custom/path/feature.md');
expect(result).toContain('Write tool');
});

it("should use custom template when provided", () => {
const vars = createTestVars({ title: "Custom Title" });
const customTemplate = "Custom Prompt: {{TITLE}} in {{SECTION}}";
it('should use custom template when provided', () => {
const vars = createTestVars({ title: 'Custom Title' });
const customTemplate = 'Custom Prompt: {{TITLE}} in {{SECTION}}';

const result = renderSlicerPrompt(vars, customTemplate);

expect(result).toBe("Custom Prompt: Custom Title in Features");
expect(result).toBe('Custom Prompt: Custom Title in Features');
});

it("should handle empty description", () => {
const vars = createTestVars({ description: "" });
it('should handle empty description', () => {
const vars = createTestVars({ description: '' });

const result = renderSlicerPrompt(vars);

// Should still render without errors
expect(result).toContain("Test Feature");
expect(result).not.toContain("{{DESCRIPTION}}");
expect(result).toContain('Test Feature');
expect(result).not.toContain('{{DESCRIPTION}}');
});

it("should handle special characters in values", () => {
it('should handle special characters in values', () => {
const vars = createTestVars({
title: "Feature with `backticks` and $pecial chars",
description: "Description with\nnewlines\nand **markdown**",
title: 'Feature with `backticks` and $pecial chars',
description: 'Description with\nnewlines\nand **markdown**',
});

const result = renderSlicerPrompt(vars);

expect(result).toContain("Feature with `backticks` and $pecial chars");
expect(result).toContain("Description with\nnewlines\nand **markdown**");
expect(result).toContain('Feature with `backticks` and $pecial chars');
expect(result).toContain('Description with\nnewlines\nand **markdown**');
});
});

describe("loadSlicerTemplate", () => {
it("should load template from file", () => {
describe('loadSlicerTemplate', () => {
it('should load template from file', () => {
const template = loadSlicerTemplate();

expect(template).toContain("Principal Software Architect");
expect(template).toContain("{{TITLE}}");
expect(template).toContain("{{SECTION}}");
expect(template).toContain("{{DESCRIPTION}}");
expect(template).toContain("{{OUTPUT_FILE_PATH}}");
expect(template).toContain("{{PRD_DIR}}");
expect(template).toContain('Principal Software Architect');
expect(template).toContain('{{TITLE}}');
expect(template).toContain('{{SECTION}}');
expect(template).toContain('{{DESCRIPTION}}');
expect(template).toContain('{{OUTPUT_FILE_PATH}}');
expect(template).toContain('{{PRD_DIR}}');
});

it("should cache the template", () => {
it('should cache the template', () => {
const template1 = loadSlicerTemplate();
const template2 = loadSlicerTemplate();

// Should return the same reference (cached)
expect(template1).toBe(template2);
});

it("should clear cache when requested", () => {
it('should clear cache when requested', () => {
loadSlicerTemplate();
clearTemplateCache();

Expand All @@ -155,53 +180,47 @@ describe("slicer-prompt", () => {
});
});

describe("createSlicerPromptVars", () => {
it("should create variables with correct paths", () => {
describe('createSlicerPromptVars', () => {
it('should create variables with correct paths', () => {
const vars = createSlicerPromptVars(
"Feature Title",
"Section Name",
"Feature description",
"/path/to/prds",
"99-feature-title.md",
'Feature Title',
'Section Name',
'Feature description',
'/path/to/prds',
'99-feature-title.md',
);

expect(vars.title).toBe("Feature Title");
expect(vars.section).toBe("Section Name");
expect(vars.description).toBe("Feature description");
expect(vars.prdDir).toBe("/path/to/prds");
expect(vars.outputFilePath).toBe("/path/to/prds/99-feature-title.md");
expect(vars.title).toBe('Feature Title');
expect(vars.section).toBe('Section Name');
expect(vars.description).toBe('Feature description');
expect(vars.prdDir).toBe('/path/to/prds');
expect(vars.outputFilePath).toBe('/path/to/prds/99-feature-title.md');
});

it("should handle empty description with default", () => {
const vars = createSlicerPromptVars(
"Feature",
"Section",
"",
"/prds",
"file.md",
);
it('should handle empty description with default', () => {
const vars = createSlicerPromptVars('Feature', 'Section', '', '/prds', 'file.md');

expect(vars.description).toBe("(No description provided)");
expect(vars.description).toBe('(No description provided)');
});
});

describe("integration with prd-creator format", () => {
it("should produce a prompt that instructs AI to explore the codebase", () => {
describe('integration with prd-creator format', () => {
it('should produce a prompt that instructs AI to explore the codebase', () => {
const vars = createTestVars();
const result = renderSlicerPrompt(vars);

expect(result).toMatch(/explore/i);
expect(result).toMatch(/codebase/i);
});

it("should produce a prompt that instructs AI to assess complexity", () => {
it('should produce a prompt that instructs AI to assess complexity', () => {
const vars = createTestVars();
const result = renderSlicerPrompt(vars);

expect(result).toMatch(/assess.*complexity/i);
});

it("should produce a prompt that instructs AI to write a complete PRD with all required sections", () => {
it('should produce a prompt that instructs AI to write a complete PRD with all required sections', () => {
const vars = createTestVars();
const result = renderSlicerPrompt(vars);

Expand All @@ -212,9 +231,9 @@ describe("slicer-prompt", () => {
expect(result).toMatch(/acceptance.?criteria/i);
});

it("should emphasize the exact output file path", () => {
it('should emphasize the exact output file path', () => {
const vars = createTestVars({
outputFilePath: "/exact/path/to/prd.md",
outputFilePath: '/exact/path/to/prd.md',
});
const result = renderSlicerPrompt(vars);

Expand Down
Loading
Loading