mirror of
https://github.com/AutoMaker-Org/automaker.git
synced 2026-02-02 20:43:36 +00:00
Merge pull request #322 from casiusss/feat/customizable-prompts
feat: customizable prompts
This commit is contained in:
433
libs/prompts/src/defaults.ts
Normal file
433
libs/prompts/src/defaults.ts
Normal file
@@ -0,0 +1,433 @@
|
||||
/**
|
||||
* Default Prompts Library
|
||||
*
|
||||
* Central repository for all default AI prompts used throughout the application.
|
||||
* These prompts can be overridden by user customization in settings.
|
||||
*
|
||||
* Extracted from:
|
||||
* - apps/server/src/services/auto-mode-service.ts (Auto Mode planning prompts)
|
||||
* - apps/server/src/services/agent-service.ts (Agent Runner system prompt)
|
||||
* - apps/server/src/routes/backlog-plan/generate-plan.ts (Backlog planning prompts)
|
||||
*/
|
||||
|
||||
import type {
|
||||
ResolvedAutoModePrompts,
|
||||
ResolvedAgentPrompts,
|
||||
ResolvedBacklogPlanPrompts,
|
||||
ResolvedEnhancementPrompts,
|
||||
} from '@automaker/types';
|
||||
|
||||
/**
|
||||
* ========================================================================
|
||||
* AUTO MODE PROMPTS
|
||||
* ========================================================================
|
||||
*/
|
||||
|
||||
export const DEFAULT_AUTO_MODE_PLANNING_LITE = `## Planning Phase (Lite Mode)
|
||||
|
||||
IMPORTANT: Do NOT output exploration text, tool usage, or thinking before the plan. Start DIRECTLY with the planning outline format below. Silently analyze the codebase first, then output ONLY the structured plan.
|
||||
|
||||
Create a brief planning outline:
|
||||
|
||||
1. **Goal**: What are we accomplishing? (1 sentence)
|
||||
2. **Approach**: How will we do it? (2-3 sentences)
|
||||
3. **Files to Touch**: List files and what changes
|
||||
4. **Tasks**: Numbered task list (3-7 items)
|
||||
5. **Risks**: Any gotchas to watch for
|
||||
|
||||
After generating the outline, output:
|
||||
"[PLAN_GENERATED] Planning outline complete."
|
||||
|
||||
Then proceed with implementation.
|
||||
`;
|
||||
|
||||
export const DEFAULT_AUTO_MODE_PLANNING_LITE_WITH_APPROVAL = `## Planning Phase (Lite Mode)
|
||||
|
||||
IMPORTANT: Do NOT output exploration text, tool usage, or thinking before the plan. Start DIRECTLY with the planning outline format below. Silently analyze the codebase first, then output ONLY the structured plan.
|
||||
|
||||
Create a brief planning outline:
|
||||
|
||||
1. **Goal**: What are we accomplishing? (1 sentence)
|
||||
2. **Approach**: How will we do it? (2-3 sentences)
|
||||
3. **Files to Touch**: List files and what changes
|
||||
4. **Tasks**: Numbered task list (3-7 items)
|
||||
5. **Risks**: Any gotchas to watch for
|
||||
|
||||
After generating the outline, output:
|
||||
"[SPEC_GENERATED] Please review the planning outline above. Reply with 'approved' to proceed or provide feedback for revisions."
|
||||
|
||||
DO NOT proceed with implementation until you receive explicit approval.
|
||||
`;
|
||||
|
||||
export const DEFAULT_AUTO_MODE_PLANNING_SPEC = `## Specification Phase (Spec Mode)
|
||||
|
||||
IMPORTANT: Do NOT output exploration text, tool usage, or thinking before the spec. Start DIRECTLY with the specification format below. Silently analyze the codebase first, then output ONLY the structured specification.
|
||||
|
||||
Generate a specification with an actionable task breakdown. WAIT for approval before implementing.
|
||||
|
||||
### Specification Format
|
||||
|
||||
1. **Problem**: What problem are we solving? (user perspective)
|
||||
|
||||
2. **Solution**: Brief approach (1-2 sentences)
|
||||
|
||||
3. **Acceptance Criteria**: 3-5 items in GIVEN-WHEN-THEN format
|
||||
- GIVEN [context], WHEN [action], THEN [outcome]
|
||||
|
||||
4. **Files to Modify**:
|
||||
| File | Purpose | Action |
|
||||
|------|---------|--------|
|
||||
| path/to/file | description | create/modify/delete |
|
||||
|
||||
5. **Implementation Tasks**:
|
||||
Use this EXACT format for each task (the system will parse these):
|
||||
\`\`\`tasks
|
||||
- [ ] T001: [Description] | File: [path/to/file]
|
||||
- [ ] T002: [Description] | File: [path/to/file]
|
||||
- [ ] T003: [Description] | File: [path/to/file]
|
||||
\`\`\`
|
||||
|
||||
Task ID rules:
|
||||
- Sequential: T001, T002, T003, etc.
|
||||
- Description: Clear action (e.g., "Create user model", "Add API endpoint")
|
||||
- File: Primary file affected (helps with context)
|
||||
- Order by dependencies (foundational tasks first)
|
||||
|
||||
6. **Verification**: How to confirm feature works
|
||||
|
||||
After generating the spec, output on its own line:
|
||||
"[SPEC_GENERATED] Please review the specification above. Reply with 'approved' to proceed or provide feedback for revisions."
|
||||
|
||||
DO NOT proceed with implementation until you receive explicit approval.
|
||||
|
||||
When approved, execute tasks SEQUENTIALLY in order. For each task:
|
||||
1. BEFORE starting, output: "[TASK_START] T###: Description"
|
||||
2. Implement the task
|
||||
3. AFTER completing, output: "[TASK_COMPLETE] T###: Brief summary"
|
||||
|
||||
This allows real-time progress tracking during implementation.
|
||||
`;
|
||||
|
||||
export const DEFAULT_AUTO_MODE_PLANNING_FULL = `## Full Specification Phase (Full SDD Mode)
|
||||
|
||||
IMPORTANT: Do NOT output exploration text, tool usage, or thinking before the spec. Start DIRECTLY with the specification format below. Silently analyze the codebase first, then output ONLY the structured specification.
|
||||
|
||||
Generate a comprehensive specification with phased task breakdown. WAIT for approval before implementing.
|
||||
|
||||
### Specification Format
|
||||
|
||||
1. **Problem Statement**: 2-3 sentences from user perspective
|
||||
|
||||
2. **User Story**: As a [user], I want [goal], so that [benefit]
|
||||
|
||||
3. **Acceptance Criteria**: Multiple scenarios with GIVEN-WHEN-THEN
|
||||
- **Happy Path**: GIVEN [context], WHEN [action], THEN [expected outcome]
|
||||
- **Edge Cases**: GIVEN [edge condition], WHEN [action], THEN [handling]
|
||||
- **Error Handling**: GIVEN [error condition], WHEN [action], THEN [error response]
|
||||
|
||||
4. **Technical Context**:
|
||||
| Aspect | Value |
|
||||
|--------|-------|
|
||||
| Affected Files | list of files |
|
||||
| Dependencies | external libs if any |
|
||||
| Constraints | technical limitations |
|
||||
| Patterns to Follow | existing patterns in codebase |
|
||||
|
||||
5. **Non-Goals**: What this feature explicitly does NOT include
|
||||
|
||||
6. **Implementation Tasks**:
|
||||
Use this EXACT format for each task (the system will parse these):
|
||||
\`\`\`tasks
|
||||
## Phase 1: Foundation
|
||||
- [ ] T001: [Description] | File: [path/to/file]
|
||||
- [ ] T002: [Description] | File: [path/to/file]
|
||||
|
||||
## Phase 2: Core Implementation
|
||||
- [ ] T003: [Description] | File: [path/to/file]
|
||||
- [ ] T004: [Description] | File: [path/to/file]
|
||||
|
||||
## Phase 3: Integration & Testing
|
||||
- [ ] T005: [Description] | File: [path/to/file]
|
||||
- [ ] T006: [Description] | File: [path/to/file]
|
||||
\`\`\`
|
||||
|
||||
Task ID rules:
|
||||
- Sequential across all phases: T001, T002, T003, etc.
|
||||
- Description: Clear action verb + target
|
||||
- File: Primary file affected
|
||||
- Order by dependencies within each phase
|
||||
- Phase structure helps organize complex work
|
||||
|
||||
7. **Success Metrics**: How we know it's done (measurable criteria)
|
||||
|
||||
8. **Risks & Mitigations**:
|
||||
| Risk | Mitigation |
|
||||
|------|------------|
|
||||
| description | approach |
|
||||
|
||||
After generating the spec, output on its own line:
|
||||
"[SPEC_GENERATED] Please review the comprehensive specification above. Reply with 'approved' to proceed or provide feedback for revisions."
|
||||
|
||||
DO NOT proceed with implementation until you receive explicit approval.
|
||||
|
||||
When approved, execute tasks SEQUENTIALLY by phase. For each task:
|
||||
1. BEFORE starting, output: "[TASK_START] T###: Description"
|
||||
2. Implement the task
|
||||
3. AFTER completing, output: "[TASK_COMPLETE] T###: Brief summary"
|
||||
|
||||
After completing all tasks in a phase, output:
|
||||
"[PHASE_COMPLETE] Phase N complete"
|
||||
|
||||
This allows real-time progress tracking during implementation.
|
||||
`;
|
||||
|
||||
export const DEFAULT_AUTO_MODE_FEATURE_PROMPT_TEMPLATE = `## Feature Implementation Task
|
||||
|
||||
**Feature ID:** {{featureId}}
|
||||
**Title:** {{title}}
|
||||
**Description:** {{description}}
|
||||
|
||||
{{#if spec}}
|
||||
**Specification:**
|
||||
{{spec}}
|
||||
{{/if}}
|
||||
|
||||
{{#if imagePaths}}
|
||||
**Context Images:**
|
||||
{{#each imagePaths}}
|
||||
- {{this}}
|
||||
{{/each}}
|
||||
{{/if}}
|
||||
|
||||
{{#if dependencies}}
|
||||
**Dependencies:**
|
||||
This feature depends on: {{dependencies}}
|
||||
{{/if}}
|
||||
|
||||
{{#if verificationInstructions}}
|
||||
**Verification:**
|
||||
{{verificationInstructions}}
|
||||
{{/if}}
|
||||
`;
|
||||
|
||||
export const DEFAULT_AUTO_MODE_FOLLOW_UP_PROMPT_TEMPLATE = `## Follow-up on Feature Implementation
|
||||
|
||||
{{featurePrompt}}
|
||||
|
||||
## Previous Agent Work
|
||||
{{previousContext}}
|
||||
|
||||
## Follow-up Instructions
|
||||
{{followUpInstructions}}
|
||||
|
||||
## Task
|
||||
Address the follow-up instructions above.
|
||||
`;
|
||||
|
||||
export const DEFAULT_AUTO_MODE_CONTINUATION_PROMPT_TEMPLATE = `## Continuing Feature Implementation
|
||||
|
||||
{{featurePrompt}}
|
||||
|
||||
## Previous Context
|
||||
{{previousContext}}
|
||||
|
||||
## Instructions
|
||||
Review the previous work and continue the implementation.
|
||||
`;
|
||||
|
||||
export const DEFAULT_AUTO_MODE_PIPELINE_STEP_PROMPT_TEMPLATE = `## Pipeline Step: {{stepName}}
|
||||
|
||||
### Feature Context
|
||||
{{featurePrompt}}
|
||||
|
||||
### Previous Work
|
||||
{{previousContext}}
|
||||
|
||||
### Pipeline Step Instructions
|
||||
{{stepInstructions}}
|
||||
`;
|
||||
|
||||
/**
|
||||
* Default Auto Mode prompts (from auto-mode-service.ts)
|
||||
*/
|
||||
export const DEFAULT_AUTO_MODE_PROMPTS: ResolvedAutoModePrompts = {
|
||||
planningLite: DEFAULT_AUTO_MODE_PLANNING_LITE,
|
||||
planningLiteWithApproval: DEFAULT_AUTO_MODE_PLANNING_LITE_WITH_APPROVAL,
|
||||
planningSpec: DEFAULT_AUTO_MODE_PLANNING_SPEC,
|
||||
planningFull: DEFAULT_AUTO_MODE_PLANNING_FULL,
|
||||
featurePromptTemplate: DEFAULT_AUTO_MODE_FEATURE_PROMPT_TEMPLATE,
|
||||
followUpPromptTemplate: DEFAULT_AUTO_MODE_FOLLOW_UP_PROMPT_TEMPLATE,
|
||||
continuationPromptTemplate: DEFAULT_AUTO_MODE_CONTINUATION_PROMPT_TEMPLATE,
|
||||
pipelineStepPromptTemplate: DEFAULT_AUTO_MODE_PIPELINE_STEP_PROMPT_TEMPLATE,
|
||||
};
|
||||
|
||||
/**
|
||||
* ========================================================================
|
||||
* AGENT RUNNER PROMPTS
|
||||
* ========================================================================
|
||||
*/
|
||||
|
||||
export const DEFAULT_AGENT_SYSTEM_PROMPT = `You are an AI assistant helping users build software. You are part of the Automaker application,
|
||||
which is designed to help developers plan, design, and implement software projects autonomously.
|
||||
|
||||
**Feature Storage:**
|
||||
Features are stored in .automaker/features/{id}/feature.json - each feature has its own folder.
|
||||
Use the UpdateFeatureStatus tool to manage features, not direct file edits.
|
||||
|
||||
Your role is to:
|
||||
- Help users define their project requirements and specifications
|
||||
- Ask clarifying questions to better understand their needs
|
||||
- Suggest technical approaches and architectures
|
||||
- Guide them through the development process
|
||||
- Be conversational and helpful
|
||||
- Write, edit, and modify code files as requested
|
||||
- Execute commands and tests
|
||||
- Search and analyze the codebase
|
||||
|
||||
**Tools Available:**
|
||||
You have access to several tools:
|
||||
- UpdateFeatureStatus: Update feature status (NOT file edits)
|
||||
- Read/Write/Edit: File operations
|
||||
- Bash: Execute commands
|
||||
- Glob/Grep: Search codebase
|
||||
- WebSearch/WebFetch: Research online
|
||||
|
||||
**Important Guidelines:**
|
||||
1. When users want to add or modify features, help them create clear feature definitions
|
||||
2. Use UpdateFeatureStatus tool to manage features in the backlog
|
||||
3. Be proactive in suggesting improvements and best practices
|
||||
4. Ask questions when requirements are unclear
|
||||
5. Guide users toward good software design principles
|
||||
|
||||
Remember: You're a collaborative partner in the development process. Be helpful, clear, and thorough.`;
|
||||
|
||||
/**
|
||||
* Default Agent Runner prompts (from agent-service.ts)
|
||||
*/
|
||||
export const DEFAULT_AGENT_PROMPTS: ResolvedAgentPrompts = {
|
||||
systemPrompt: DEFAULT_AGENT_SYSTEM_PROMPT,
|
||||
};
|
||||
|
||||
/**
|
||||
* ========================================================================
|
||||
* BACKLOG PLAN PROMPTS
|
||||
* ========================================================================
|
||||
*/
|
||||
|
||||
export const DEFAULT_BACKLOG_PLAN_SYSTEM_PROMPT = `You are an AI assistant helping to modify a software project's feature backlog.
|
||||
You will be given the current list of features and a user request to modify the backlog.
|
||||
|
||||
IMPORTANT CONTEXT (automatically injected):
|
||||
- Remember to update the dependency graph if deleting existing features
|
||||
- Remember to define dependencies on new features hooked into relevant existing ones
|
||||
- Maintain dependency graph integrity (no orphaned dependencies)
|
||||
- When deleting a feature, identify which other features depend on it
|
||||
|
||||
Your task is to analyze the request and produce a structured JSON plan with:
|
||||
1. Features to ADD (include title, description, category, and dependencies)
|
||||
2. Features to UPDATE (specify featureId and the updates)
|
||||
3. Features to DELETE (specify featureId)
|
||||
4. A summary of the changes
|
||||
5. Any dependency updates needed (removed dependencies due to deletions, new dependencies for new features)
|
||||
|
||||
Respond with ONLY a JSON object in this exact format:
|
||||
{
|
||||
"plan": {
|
||||
"add": [
|
||||
{
|
||||
"title": "string",
|
||||
"description": "string",
|
||||
"category": "feature" | "bug" | "enhancement" | "refactor",
|
||||
"dependencies": ["featureId1", "featureId2"]
|
||||
}
|
||||
],
|
||||
"update": [
|
||||
{
|
||||
"featureId": "string",
|
||||
"updates": {
|
||||
"title"?: "string",
|
||||
"description"?: "string",
|
||||
"category"?: "feature" | "bug" | "enhancement" | "refactor",
|
||||
"priority"?: number,
|
||||
"dependencies"?: ["featureId1"]
|
||||
}
|
||||
}
|
||||
],
|
||||
"delete": ["featureId1", "featureId2"],
|
||||
"summary": "Brief summary of all changes",
|
||||
"dependencyUpdates": [
|
||||
{
|
||||
"featureId": "string",
|
||||
"action": "remove_dependency" | "add_dependency",
|
||||
"dependencyId": "string",
|
||||
"reason": "string"
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
|
||||
Important rules:
|
||||
- Only include fields that need to change in updates
|
||||
- Ensure dependency references are valid (don't reference deleted features)
|
||||
- Provide clear, actionable descriptions
|
||||
- Maintain category consistency (feature, bug, enhancement, refactor)
|
||||
- When adding dependencies, ensure the referenced features exist or are being added in the same plan
|
||||
`;
|
||||
|
||||
export const DEFAULT_BACKLOG_PLAN_USER_PROMPT_TEMPLATE = `Current Features in Backlog:
|
||||
{{currentFeatures}}
|
||||
|
||||
---
|
||||
|
||||
User Request: {{userRequest}}
|
||||
|
||||
Please analyze the current backlog and the user's request, then provide a JSON plan for the modifications.`;
|
||||
|
||||
/**
|
||||
* Default Backlog Plan prompts (from backlog-plan/generate-plan.ts)
|
||||
*/
|
||||
export const DEFAULT_BACKLOG_PLAN_PROMPTS: ResolvedBacklogPlanPrompts = {
|
||||
systemPrompt: DEFAULT_BACKLOG_PLAN_SYSTEM_PROMPT,
|
||||
userPromptTemplate: DEFAULT_BACKLOG_PLAN_USER_PROMPT_TEMPLATE,
|
||||
};
|
||||
|
||||
/**
|
||||
* ========================================================================
|
||||
* ENHANCEMENT PROMPTS
|
||||
* ========================================================================
|
||||
* Note: Enhancement prompts are already defined in enhancement.ts
|
||||
* We import and re-export them here for consistency
|
||||
*/
|
||||
|
||||
import {
|
||||
IMPROVE_SYSTEM_PROMPT,
|
||||
TECHNICAL_SYSTEM_PROMPT,
|
||||
SIMPLIFY_SYSTEM_PROMPT,
|
||||
ACCEPTANCE_SYSTEM_PROMPT,
|
||||
} from './enhancement.js';
|
||||
|
||||
/**
|
||||
* Default Enhancement prompts (from libs/prompts/src/enhancement.ts)
|
||||
*/
|
||||
export const DEFAULT_ENHANCEMENT_PROMPTS: ResolvedEnhancementPrompts = {
|
||||
improveSystemPrompt: IMPROVE_SYSTEM_PROMPT,
|
||||
technicalSystemPrompt: TECHNICAL_SYSTEM_PROMPT,
|
||||
simplifySystemPrompt: SIMPLIFY_SYSTEM_PROMPT,
|
||||
acceptanceSystemPrompt: ACCEPTANCE_SYSTEM_PROMPT,
|
||||
};
|
||||
|
||||
/**
|
||||
* ========================================================================
|
||||
* COMBINED DEFAULTS
|
||||
* ========================================================================
|
||||
*/
|
||||
|
||||
/**
|
||||
* All default prompts in one object for easy access
|
||||
*/
|
||||
export const DEFAULT_PROMPTS = {
|
||||
autoMode: DEFAULT_AUTO_MODE_PROMPTS,
|
||||
agent: DEFAULT_AGENT_PROMPTS,
|
||||
backlogPlan: DEFAULT_BACKLOG_PLAN_PROMPTS,
|
||||
enhancement: DEFAULT_ENHANCEMENT_PROMPTS,
|
||||
} as const;
|
||||
@@ -23,3 +23,40 @@ export {
|
||||
|
||||
// Re-export types from @automaker/types
|
||||
export type { EnhancementMode, EnhancementExample } from '@automaker/types';
|
||||
|
||||
// Default prompts
|
||||
export {
|
||||
DEFAULT_AUTO_MODE_PLANNING_LITE,
|
||||
DEFAULT_AUTO_MODE_PLANNING_LITE_WITH_APPROVAL,
|
||||
DEFAULT_AUTO_MODE_PLANNING_SPEC,
|
||||
DEFAULT_AUTO_MODE_PLANNING_FULL,
|
||||
DEFAULT_AUTO_MODE_FEATURE_PROMPT_TEMPLATE,
|
||||
DEFAULT_AUTO_MODE_FOLLOW_UP_PROMPT_TEMPLATE,
|
||||
DEFAULT_AUTO_MODE_CONTINUATION_PROMPT_TEMPLATE,
|
||||
DEFAULT_AUTO_MODE_PIPELINE_STEP_PROMPT_TEMPLATE,
|
||||
DEFAULT_AUTO_MODE_PROMPTS,
|
||||
DEFAULT_AGENT_SYSTEM_PROMPT,
|
||||
DEFAULT_AGENT_PROMPTS,
|
||||
DEFAULT_BACKLOG_PLAN_SYSTEM_PROMPT,
|
||||
DEFAULT_BACKLOG_PLAN_USER_PROMPT_TEMPLATE,
|
||||
DEFAULT_BACKLOG_PLAN_PROMPTS,
|
||||
DEFAULT_ENHANCEMENT_PROMPTS,
|
||||
DEFAULT_PROMPTS,
|
||||
} from './defaults.js';
|
||||
|
||||
// Prompt merging utilities
|
||||
export {
|
||||
mergeAutoModePrompts,
|
||||
mergeAgentPrompts,
|
||||
mergeBacklogPlanPrompts,
|
||||
mergeEnhancementPrompts,
|
||||
mergeAllPrompts,
|
||||
} from './merge.js';
|
||||
|
||||
// Re-export resolved prompt types from @automaker/types
|
||||
export type {
|
||||
ResolvedAutoModePrompts,
|
||||
ResolvedAgentPrompts,
|
||||
ResolvedBacklogPlanPrompts,
|
||||
ResolvedEnhancementPrompts,
|
||||
} from '@automaker/types';
|
||||
|
||||
130
libs/prompts/src/merge.ts
Normal file
130
libs/prompts/src/merge.ts
Normal file
@@ -0,0 +1,130 @@
|
||||
/**
|
||||
* Prompt Merging Utilities
|
||||
*
|
||||
* Merges user-customized prompts with built-in defaults.
|
||||
* Used by services to get effective prompts at runtime.
|
||||
*
|
||||
* Custom prompts have an `enabled` flag - when true, the custom value is used.
|
||||
* When false or undefined, the default is used instead.
|
||||
*/
|
||||
|
||||
import type {
|
||||
PromptCustomization,
|
||||
AutoModePrompts,
|
||||
AgentPrompts,
|
||||
BacklogPlanPrompts,
|
||||
EnhancementPrompts,
|
||||
CustomPrompt,
|
||||
ResolvedAutoModePrompts,
|
||||
ResolvedAgentPrompts,
|
||||
ResolvedBacklogPlanPrompts,
|
||||
ResolvedEnhancementPrompts,
|
||||
} from '@automaker/types';
|
||||
import {
|
||||
DEFAULT_AUTO_MODE_PROMPTS,
|
||||
DEFAULT_AGENT_PROMPTS,
|
||||
DEFAULT_BACKLOG_PLAN_PROMPTS,
|
||||
DEFAULT_ENHANCEMENT_PROMPTS,
|
||||
} from './defaults.js';
|
||||
|
||||
/**
|
||||
* Resolve a custom prompt to its effective string value
|
||||
* Returns the custom value if enabled=true, otherwise returns the default
|
||||
*/
|
||||
function resolvePrompt(custom: CustomPrompt | undefined, defaultValue: string): string {
|
||||
return custom?.enabled ? custom.value : defaultValue;
|
||||
}
|
||||
|
||||
/**
|
||||
* Merge custom Auto Mode prompts with defaults
|
||||
* Custom prompts override defaults only when enabled=true
|
||||
*/
|
||||
export function mergeAutoModePrompts(custom?: AutoModePrompts): ResolvedAutoModePrompts {
|
||||
return {
|
||||
planningLite: resolvePrompt(custom?.planningLite, DEFAULT_AUTO_MODE_PROMPTS.planningLite),
|
||||
planningLiteWithApproval: resolvePrompt(
|
||||
custom?.planningLiteWithApproval,
|
||||
DEFAULT_AUTO_MODE_PROMPTS.planningLiteWithApproval
|
||||
),
|
||||
planningSpec: resolvePrompt(custom?.planningSpec, DEFAULT_AUTO_MODE_PROMPTS.planningSpec),
|
||||
planningFull: resolvePrompt(custom?.planningFull, DEFAULT_AUTO_MODE_PROMPTS.planningFull),
|
||||
featurePromptTemplate: resolvePrompt(
|
||||
custom?.featurePromptTemplate,
|
||||
DEFAULT_AUTO_MODE_PROMPTS.featurePromptTemplate
|
||||
),
|
||||
followUpPromptTemplate: resolvePrompt(
|
||||
custom?.followUpPromptTemplate,
|
||||
DEFAULT_AUTO_MODE_PROMPTS.followUpPromptTemplate
|
||||
),
|
||||
continuationPromptTemplate: resolvePrompt(
|
||||
custom?.continuationPromptTemplate,
|
||||
DEFAULT_AUTO_MODE_PROMPTS.continuationPromptTemplate
|
||||
),
|
||||
pipelineStepPromptTemplate: resolvePrompt(
|
||||
custom?.pipelineStepPromptTemplate,
|
||||
DEFAULT_AUTO_MODE_PROMPTS.pipelineStepPromptTemplate
|
||||
),
|
||||
};
|
||||
}
|
||||
|
||||
/**
|
||||
* Merge custom Agent prompts with defaults
|
||||
* Custom prompts override defaults only when enabled=true
|
||||
*/
|
||||
export function mergeAgentPrompts(custom?: AgentPrompts): ResolvedAgentPrompts {
|
||||
return {
|
||||
systemPrompt: resolvePrompt(custom?.systemPrompt, DEFAULT_AGENT_PROMPTS.systemPrompt),
|
||||
};
|
||||
}
|
||||
|
||||
/**
|
||||
* Merge custom Backlog Plan prompts with defaults
|
||||
* Custom prompts override defaults only when enabled=true
|
||||
*/
|
||||
export function mergeBacklogPlanPrompts(custom?: BacklogPlanPrompts): ResolvedBacklogPlanPrompts {
|
||||
return {
|
||||
systemPrompt: resolvePrompt(custom?.systemPrompt, DEFAULT_BACKLOG_PLAN_PROMPTS.systemPrompt),
|
||||
userPromptTemplate: resolvePrompt(
|
||||
custom?.userPromptTemplate,
|
||||
DEFAULT_BACKLOG_PLAN_PROMPTS.userPromptTemplate
|
||||
),
|
||||
};
|
||||
}
|
||||
|
||||
/**
|
||||
* Merge custom Enhancement prompts with defaults
|
||||
* Custom prompts override defaults only when enabled=true
|
||||
*/
|
||||
export function mergeEnhancementPrompts(custom?: EnhancementPrompts): ResolvedEnhancementPrompts {
|
||||
return {
|
||||
improveSystemPrompt: resolvePrompt(
|
||||
custom?.improveSystemPrompt,
|
||||
DEFAULT_ENHANCEMENT_PROMPTS.improveSystemPrompt
|
||||
),
|
||||
technicalSystemPrompt: resolvePrompt(
|
||||
custom?.technicalSystemPrompt,
|
||||
DEFAULT_ENHANCEMENT_PROMPTS.technicalSystemPrompt
|
||||
),
|
||||
simplifySystemPrompt: resolvePrompt(
|
||||
custom?.simplifySystemPrompt,
|
||||
DEFAULT_ENHANCEMENT_PROMPTS.simplifySystemPrompt
|
||||
),
|
||||
acceptanceSystemPrompt: resolvePrompt(
|
||||
custom?.acceptanceSystemPrompt,
|
||||
DEFAULT_ENHANCEMENT_PROMPTS.acceptanceSystemPrompt
|
||||
),
|
||||
};
|
||||
}
|
||||
|
||||
/**
|
||||
* Merge all custom prompts with defaults
|
||||
* Returns a complete PromptCustomization with all fields populated
|
||||
*/
|
||||
export function mergeAllPrompts(custom?: PromptCustomization) {
|
||||
return {
|
||||
autoMode: mergeAutoModePrompts(custom?.autoMode),
|
||||
agent: mergeAgentPrompts(custom?.agent),
|
||||
backlogPlan: mergeBacklogPlanPrompts(custom?.backlogPlan),
|
||||
enhancement: mergeEnhancementPrompts(custom?.enhancement),
|
||||
};
|
||||
}
|
||||
@@ -49,6 +49,21 @@ export { specOutputSchema } from './spec.js';
|
||||
// Enhancement types
|
||||
export type { EnhancementMode, EnhancementExample } from './enhancement.js';
|
||||
|
||||
// Prompt customization types
|
||||
export type {
|
||||
CustomPrompt,
|
||||
AutoModePrompts,
|
||||
AgentPrompts,
|
||||
BacklogPlanPrompts,
|
||||
EnhancementPrompts,
|
||||
PromptCustomization,
|
||||
ResolvedAutoModePrompts,
|
||||
ResolvedAgentPrompts,
|
||||
ResolvedBacklogPlanPrompts,
|
||||
ResolvedEnhancementPrompts,
|
||||
} from './prompts.js';
|
||||
export { DEFAULT_PROMPT_CUSTOMIZATION } from './prompts.js';
|
||||
|
||||
// Settings types and constants
|
||||
export type {
|
||||
ThemeMode,
|
||||
|
||||
153
libs/types/src/prompts.ts
Normal file
153
libs/types/src/prompts.ts
Normal file
@@ -0,0 +1,153 @@
|
||||
/**
|
||||
* Prompt Customization Types
|
||||
*
|
||||
* Defines the structure for customizable AI prompts used throughout the application.
|
||||
* Allows users to modify prompts for Auto Mode, Agent Runner, and Backlog Planning.
|
||||
*/
|
||||
|
||||
/**
|
||||
* CustomPrompt - A custom prompt with its value and enabled state
|
||||
*
|
||||
* The value is always preserved even when disabled, so users don't lose their work.
|
||||
*/
|
||||
export interface CustomPrompt {
|
||||
/** The custom prompt text */
|
||||
value: string;
|
||||
|
||||
/** Whether this custom prompt should be used (when false, default is used instead) */
|
||||
enabled: boolean;
|
||||
}
|
||||
|
||||
/**
|
||||
* AutoModePrompts - Customizable prompts for Auto Mode feature implementation
|
||||
*
|
||||
* Controls how the AI plans and implements features in autonomous mode.
|
||||
*/
|
||||
export interface AutoModePrompts {
|
||||
/** Planning mode: Quick outline without approval (lite mode) */
|
||||
planningLite?: CustomPrompt;
|
||||
|
||||
/** Planning mode: Quick outline with approval required (lite with approval) */
|
||||
planningLiteWithApproval?: CustomPrompt;
|
||||
|
||||
/** Planning mode: Detailed specification with task breakdown (spec mode) */
|
||||
planningSpec?: CustomPrompt;
|
||||
|
||||
/** Planning mode: Comprehensive Software Design Document (full SDD mode) */
|
||||
planningFull?: CustomPrompt;
|
||||
|
||||
/** Template for building feature implementation prompts */
|
||||
featurePromptTemplate?: CustomPrompt;
|
||||
|
||||
/** Template for follow-up prompts when resuming work */
|
||||
followUpPromptTemplate?: CustomPrompt;
|
||||
|
||||
/** Template for continuation prompts */
|
||||
continuationPromptTemplate?: CustomPrompt;
|
||||
|
||||
/** Template for pipeline step execution prompts */
|
||||
pipelineStepPromptTemplate?: CustomPrompt;
|
||||
}
|
||||
|
||||
/**
|
||||
* AgentPrompts - Customizable prompts for Agent Runner (chat mode)
|
||||
*
|
||||
* Controls the AI's behavior in interactive chat sessions.
|
||||
*/
|
||||
export interface AgentPrompts {
|
||||
/** System prompt defining the agent's role and behavior in chat */
|
||||
systemPrompt?: CustomPrompt;
|
||||
}
|
||||
|
||||
/**
|
||||
* BacklogPlanPrompts - Customizable prompts for Kanban board planning
|
||||
*
|
||||
* Controls how the AI modifies the feature backlog via the Plan button.
|
||||
*/
|
||||
export interface BacklogPlanPrompts {
|
||||
/** System prompt for backlog plan generation (defines output format and rules) */
|
||||
systemPrompt?: CustomPrompt;
|
||||
|
||||
/** Template for user prompt (includes current features and user request) */
|
||||
userPromptTemplate?: CustomPrompt;
|
||||
}
|
||||
|
||||
/**
|
||||
* EnhancementPrompts - Customizable prompts for feature description enhancement
|
||||
*
|
||||
* Controls how the AI enhances feature titles and descriptions.
|
||||
*/
|
||||
export interface EnhancementPrompts {
|
||||
/** System prompt for "improve" mode (vague → clear) */
|
||||
improveSystemPrompt?: CustomPrompt;
|
||||
|
||||
/** System prompt for "technical" mode (add technical details) */
|
||||
technicalSystemPrompt?: CustomPrompt;
|
||||
|
||||
/** System prompt for "simplify" mode (verbose → concise) */
|
||||
simplifySystemPrompt?: CustomPrompt;
|
||||
|
||||
/** System prompt for "acceptance" mode (add acceptance criteria) */
|
||||
acceptanceSystemPrompt?: CustomPrompt;
|
||||
}
|
||||
|
||||
/**
|
||||
* PromptCustomization - Complete set of customizable prompts
|
||||
*
|
||||
* All fields are optional. Undefined values fall back to built-in defaults.
|
||||
* Stored in GlobalSettings to allow user customization.
|
||||
*/
|
||||
export interface PromptCustomization {
|
||||
/** Auto Mode prompts (feature implementation) */
|
||||
autoMode?: AutoModePrompts;
|
||||
|
||||
/** Agent Runner prompts (interactive chat) */
|
||||
agent?: AgentPrompts;
|
||||
|
||||
/** Backlog planning prompts (Plan button) */
|
||||
backlogPlan?: BacklogPlanPrompts;
|
||||
|
||||
/** Enhancement prompts (feature description improvement) */
|
||||
enhancement?: EnhancementPrompts;
|
||||
}
|
||||
|
||||
/**
|
||||
* Default empty prompt customization (all undefined → use built-in defaults)
|
||||
*/
|
||||
export const DEFAULT_PROMPT_CUSTOMIZATION: PromptCustomization = {
|
||||
autoMode: {},
|
||||
agent: {},
|
||||
backlogPlan: {},
|
||||
enhancement: {},
|
||||
};
|
||||
|
||||
/**
|
||||
* Resolved prompt types - all fields are required strings (ready to use)
|
||||
* Used for default prompts and merged prompts after resolving custom values
|
||||
*/
|
||||
export interface ResolvedAutoModePrompts {
|
||||
planningLite: string;
|
||||
planningLiteWithApproval: string;
|
||||
planningSpec: string;
|
||||
planningFull: string;
|
||||
featurePromptTemplate: string;
|
||||
followUpPromptTemplate: string;
|
||||
continuationPromptTemplate: string;
|
||||
pipelineStepPromptTemplate: string;
|
||||
}
|
||||
|
||||
export interface ResolvedAgentPrompts {
|
||||
systemPrompt: string;
|
||||
}
|
||||
|
||||
export interface ResolvedBacklogPlanPrompts {
|
||||
systemPrompt: string;
|
||||
userPromptTemplate: string;
|
||||
}
|
||||
|
||||
export interface ResolvedEnhancementPrompts {
|
||||
improveSystemPrompt: string;
|
||||
technicalSystemPrompt: string;
|
||||
simplifySystemPrompt: string;
|
||||
acceptanceSystemPrompt: string;
|
||||
}
|
||||
@@ -7,6 +7,7 @@
|
||||
*/
|
||||
|
||||
import type { AgentModel } from './model.js';
|
||||
import type { PromptCustomization } from './prompts.js';
|
||||
|
||||
// Re-export AgentModel for convenience
|
||||
export type { AgentModel };
|
||||
@@ -360,6 +361,10 @@ export interface GlobalSettings {
|
||||
mcpAutoApproveTools?: boolean;
|
||||
/** Allow unrestricted tools when MCP servers are enabled (don't filter allowedTools) */
|
||||
mcpUnrestrictedTools?: boolean;
|
||||
|
||||
// Prompt Customization
|
||||
/** Custom prompts for Auto Mode, Agent Runner, Backlog Planning, and Enhancements */
|
||||
promptCustomization?: PromptCustomization;
|
||||
}
|
||||
|
||||
/**
|
||||
|
||||
Reference in New Issue
Block a user