@neuroequalityorg/knightcode/src/ai/prompts.ts

Knightcode CLI - Your local AI coding assistant using Ollama, LM Studio, and more

/**
 * AI Prompts
 * 
 * Contains prompt templates and utilities for formatting prompts 
 * for different AI tasks and scenarios.
 */

import { Message } from './types.js';

// Define MessageRole consts since we're using the type as values
const MESSAGE_ROLE = {
  USER: 'user' as const,
  ASSISTANT: 'assistant' as const,
  SYSTEM: 'system' as const
};

/**
 * System prompt for code assistance
 */
export const CODE_ASSISTANT_SYSTEM_PROMPT = `
You are Claude, an AI assistant with expertise in programming and software development.
Your task is to assist with coding-related questions, debugging, refactoring, and explaining code.

Guidelines:
- Provide clear, concise, and accurate responses
- Include code examples where helpful
- Prioritize modern best practices
- If you're unsure, acknowledge limitations instead of guessing
- Focus on understanding the user's intent, even if the question is ambiguous
`;

/**
 * System prompt for code generation
 */
export const CODE_GENERATION_SYSTEM_PROMPT = `
You are Claude, an AI assistant focused on helping write high-quality code.
Your task is to generate code based on user requirements and specifications.

Guidelines:
- Write clean, efficient, and well-documented code
- Follow language-specific best practices and conventions
- Include helpful comments explaining complex sections
- Prioritize maintainability and readability
- Structure code logically with appropriate error handling
- Consider edge cases and potential issues
`;

/**
 * System prompt for code review
 */
export const CODE_REVIEW_SYSTEM_PROMPT = `
You are Claude, an AI code reviewer with expertise in programming best practices.
Your task is to analyze code, identify issues, and suggest improvements.

Guidelines:
- Look for bugs, security issues, and performance problems
- Suggest improvements for readability and maintainability
- Identify potential edge cases and error handling gaps
- Point out violations of best practices or conventions
- Provide constructive feedback with clear explanations
- Be thorough but prioritize important issues over minor stylistic concerns
`;

/**
 * System prompt for explaining code
 */
export const CODE_EXPLANATION_SYSTEM_PROMPT = `
You are Claude, an AI assistant that specializes in explaining code.
Your task is to break down and explain code in a clear, educational manner.

Guidelines:
- Explain the purpose and functionality of the code
- Break down complex parts step by step
- Define technical terms and concepts when relevant
- Use analogies or examples to illustrate concepts
- Focus on the core logic rather than trivial details
- Adjust explanation depth based on the apparent complexity of the question
`;

/**
 * Interface for prompt templates
 */
export interface PromptTemplate {
  /**
   * Template string with {placeholders}
   */
  template: string;
  
  /**
   * Optional system message to set context
   */
  system?: string;
  
  /**
   * Default values for placeholders
   */
  defaults?: Record<string, string>;
}

/**
 * Collection of prompt templates for common tasks
 */
export const PROMPT_TEMPLATES: Record<string, PromptTemplate> = {
  // Code assistance prompt templates
  explainCode: {
    template: "Please explain what this code does:\n\n{code}",
    system: CODE_EXPLANATION_SYSTEM_PROMPT,
    defaults: {
      code: "// Paste code here"
    }
  },
  
  refactorCode: {
    template: "Please refactor this code to improve its {focus}:\n\n{code}\n\nAdditional context: {context}",
    system: CODE_GENERATION_SYSTEM_PROMPT,
    defaults: {
      focus: "readability and maintainability",
      code: "// Paste code here",
      context: "None"
    }
  },
  
  debugCode: {
    template: "Please help me debug the following code:\n\n{code}\n\nThe issue I'm seeing is: {issue}\n\nAny error messages: {errorMessages}",
    system: CODE_ASSISTANT_SYSTEM_PROMPT,
    defaults: {
      code: "// Paste code here",
      issue: "Describe the issue you're experiencing",
      errorMessages: "None"
    }
  },
  
  reviewCode: {
    template: "Please review this code and provide feedback:\n\n{code}",
    system: CODE_REVIEW_SYSTEM_PROMPT,
    defaults: {
      code: "// Paste code here"
    }
  },
  
  generateCode: {
    template: "Please write code to {task}.\n\nLanguage/Framework: {language}\n\nRequirements:\n{requirements}",
    system: CODE_GENERATION_SYSTEM_PROMPT,
    defaults: {
      task: "Describe what you want the code to do",
      language: "Specify language or framework",
      requirements: "- List your requirements here"
    }
  },
  
  documentCode: {
    template: "Please add documentation to this code:\n\n{code}\n\nDocumentation style: {style}",
    system: CODE_GENERATION_SYSTEM_PROMPT,
    defaults: {
      code: "// Paste code here",
      style: "Standard comments and docstrings"
    }
  },
  
  testCode: {
    template: "Please write tests for this code:\n\n{code}\n\nTesting framework: {framework}",
    system: CODE_GENERATION_SYSTEM_PROMPT,
    defaults: {
      code: "// Paste code here",
      framework: "Specify testing framework or 'standard'"
    }
  }
};

/**
 * Format a prompt by replacing placeholders with values
 * 
 * @param template The prompt template with {placeholders}
 * @param values Values to replace placeholders with
 * @param defaults Default values for placeholders not in values
 * @returns Formatted prompt string
 */
export function formatPrompt(
  template: string,
  values: Record<string, string | number | boolean>,
  defaults: Record<string, string> = {}
): string {
  // Create a merged object of defaults and provided values
  const mergedValues = { ...defaults, ...values };
  
  // Replace each placeholder with its value
  return template.replace(
    /{(\w+)}/g, 
    (match, key) => {
      const value = mergedValues[key];
      return value !== undefined ? String(value) : match;
    }
  );
}

/**
 * Format a prompt using a predefined template
 * 
 * @param templateName Name of the template from PROMPT_TEMPLATES
 * @param values Values to replace placeholders with
 * @returns Object with formatted prompt and system message
 */
export function usePromptTemplate(
  templateName: string,
  values: Record<string, string | number | boolean>
): { prompt: string; system?: string } {
  const template = PROMPT_TEMPLATES[templateName];
  
  if (!template) {
    throw new Error(`Prompt template "${templateName}" not found`);
  }
  
  return {
    prompt: formatPrompt(template.template, values, template.defaults),
    system: template.system
  };
}

/**
 * Create a conversation from a prompt
 * 
 * @param prompt User prompt string
 * @param system Optional system message
 * @returns Array of messages for the conversation
 */
export function createConversation(
  prompt: string,
  system?: string
): Array<{ role: 'user' | 'assistant' | 'system'; content: string }> {
  const messages = [];
  
  // Add system message if provided
  if (system) {
    messages.push({
      role: MESSAGE_ROLE.SYSTEM,
      content: system
    });
  }
  
  // Add user message
  messages.push({
    role: MESSAGE_ROLE.USER,
    content: prompt
  });
  
  return messages;
}

/**
 * Create a user message
 */
export function createUserMessage(content: string): Message {
  return {
    role: MESSAGE_ROLE.USER,
    content
  };
}

/**
 * Create a system message
 */
export function createSystemMessage(content: string): Message {
  return {
    role: MESSAGE_ROLE.SYSTEM,
    content
  };
}

/**
 * Create an assistant message
 */
export function createAssistantMessage(content: string): Message {
  return {
    role: MESSAGE_ROLE.ASSISTANT,
    content
  };
}

/**
 * Create a message with file context
 */
export function createFileContextMessage(
  filePath: string,
  content: string,
  language?: string
): string {
  // Return a simpler content format that works with the current Message type
  return `File: ${filePath}\n\n\`\`\`${language || getLanguageFromFilePath(filePath)}\n${content}\n\`\`\``;
}

/**
 * Get language from file path
 */
function getLanguageFromFilePath(filePath: string): string {
  const extension = filePath.split('.').pop()?.toLowerCase() || '';
  
  const languageMap: Record<string, string> = {
    js: 'javascript',
    ts: 'typescript',
    jsx: 'javascript',
    tsx: 'typescript',
    py: 'python',
    rb: 'ruby',
    java: 'java',
    c: 'c',
    cpp: 'cpp',
    cs: 'csharp',
    go: 'go',
    rs: 'rust',
    php: 'php',
    swift: 'swift',
    kt: 'kotlin',
    scala: 'scala',
    sh: 'bash',
    html: 'html',
    css: 'css',
    scss: 'scss',
    sass: 'sass',
    less: 'less',
    md: 'markdown',
    json: 'json',
    yml: 'yaml',
    yaml: 'yaml',
    toml: 'toml',
    sql: 'sql',
    graphql: 'graphql',
    xml: 'xml'
  };
  
  return languageMap[extension] || '';
}