claude_agent/output_style/

generator.rs

//! System prompt generator.
//!
//! Generates customized system prompts based on output style configuration.
//! This is the core logic that implements the keep-coding-instructions behavior.

use std::path::PathBuf;

use super::{
    ChainOutputStyleProvider, InMemoryOutputStyleProvider, OutputStyle, OutputStyleSourceType,
    builtin_styles, default_style, file_output_style_provider,
};
use crate::client::DEFAULT_MODEL;
use crate::common::Provider;
use crate::prompts::{
    base::{BASE_SYSTEM_PROMPT, TOOL_USAGE_POLICY},
    coding,
    environment::{current_platform, environment_block, is_git_repository, os_version},
    identity::CLI_IDENTITY,
};

/// System prompt generator with output style support.
///
/// # System Prompt Structure
///
/// The generated system prompt follows this structure:
///
/// 1. **CLI Identity** (required for CLI OAuth authentication)
///    - "You are Claude Code, Anthropic's official CLI for Claude."
///    - This MUST be included when using CLI OAuth and cannot be replaced
///
/// 2. **Base System Prompt** (always included after identity)
///    - Tone and style, professional objectivity, task management
///
/// 3. **Tool Usage Policy** (always included)
///    - Tool-specific guidelines
///
/// 4. **Coding Instructions** (if `keep_coding_instructions: true`)
///    - Software engineering instructions
///    - Git commit/PR protocols
///
/// 5. **Custom Prompt** (if output style has custom content)
///    - Style-specific instructions
///
/// 6. **Environment Block** (always included)
///    - Working directory, platform, model info
#[derive(Debug, Clone)]
pub struct SystemPromptGenerator {
    style: OutputStyle,
    working_dir: Option<PathBuf>,
    model_name: String,
    model_id: String,
    require_cli_identity: bool,
}

impl Default for SystemPromptGenerator {
    fn default() -> Self {
        Self::new()
    }
}

impl SystemPromptGenerator {
    /// Create a new generator with default style.
    /// CLI identity is NOT required by default.
    pub fn new() -> Self {
        Self {
            style: default_style(),
            working_dir: None,
            model_name: "Claude".to_string(),
            model_id: DEFAULT_MODEL.to_string(),
            require_cli_identity: false,
        }
    }

    /// Create a generator that requires CLI identity.
    /// Use this when using Claude CLI OAuth authentication.
    pub fn with_cli_identity() -> Self {
        Self {
            style: default_style(),
            working_dir: None,
            model_name: "Claude".to_string(),
            model_id: DEFAULT_MODEL.to_string(),
            require_cli_identity: true,
        }
    }

    /// Set whether CLI identity is required.
    /// CLI identity MUST be included when using Claude CLI OAuth.
    pub fn require_cli_identity(mut self, required: bool) -> Self {
        self.require_cli_identity = required;
        self
    }

    /// Set the output style directly.
    pub fn with_style(mut self, style: OutputStyle) -> Self {
        self.style = style;
        self
    }

    /// Set the working directory for environment block.
    pub fn with_working_dir(mut self, dir: impl Into<PathBuf>) -> Self {
        self.working_dir = Some(dir.into());
        self
    }

    /// Set the model information.
    pub fn with_model(mut self, model_id: impl Into<String>) -> Self {
        let id = model_id.into();
        self.model_name = derive_model_name(&id);
        self.model_id = id;
        self
    }

    /// Set the model name explicitly.
    pub fn with_model_name(mut self, name: impl Into<String>) -> Self {
        self.model_name = name.into();
        self
    }

    /// Load and set an output style by name.
    ///
    /// Searches in priority order:
    /// 1. Project styles (.claude/output-styles/) - highest priority
    /// 2. User styles (~/.claude/output-styles/)
    /// 3. Built-in styles - lowest priority
    pub async fn with_style_name(mut self, name: &str) -> crate::Result<Self> {
        let builtins = InMemoryOutputStyleProvider::new()
            .with_items(builtin_styles())
            .with_priority(0)
            .with_source_type(OutputStyleSourceType::Builtin);

        let mut chain = ChainOutputStyleProvider::new().with(builtins);

        if let Some(ref working_dir) = self.working_dir {
            let project = file_output_style_provider()
                .with_project_path(working_dir)
                .with_priority(20)
                .with_source_type(OutputStyleSourceType::Project);
            chain = chain.with(project);
        }

        let user = file_output_style_provider()
            .with_user_path()
            .with_priority(10)
            .with_source_type(OutputStyleSourceType::User);
        chain = chain.with(user);

        if let Some(style) = chain.get(name).await? {
            self.style = style;
            Ok(self)
        } else {
            Err(crate::Error::Config(format!(
                "Output style '{}' not found",
                name
            )))
        }
    }

    /// Generate the system prompt.
    ///
    /// # Prompt Assembly Logic
    ///
    /// - **CLI Identity**: Only if `require_cli_identity: true` (CLI OAuth)
    /// - **Base System Prompt**: Always included
    /// - **Tool Usage Policy**: Always included
    /// - **Coding Instructions**: Only if `keep_coding_instructions: true`
    /// - **Custom Prompt**: Only if style has non-empty prompt
    /// - **Environment Block**: Always included
    pub fn generate(&self) -> String {
        let mut parts = Vec::new();

        // 1. CLI Identity (required for CLI OAuth, cannot be replaced)
        if self.require_cli_identity {
            parts.push(CLI_IDENTITY.to_string());
        }

        // 2. Base System Prompt (always)
        parts.push(BASE_SYSTEM_PROMPT.to_string());

        // 3. Tool Usage Policy (always)
        parts.push(TOOL_USAGE_POLICY.to_string());

        // 4. Coding Instructions (conditional)
        if self.style.keep_coding_instructions {
            parts.push(coding::coding_instructions(&self.model_name));
        }

        // 5. Custom Prompt (if present)
        if !self.style.prompt.is_empty() {
            parts.push(self.style.prompt.clone());
        }

        // 6. Environment Block (always)
        let is_git = is_git_repository(self.working_dir.as_deref());
        let platform = current_platform();
        let os_ver = os_version();

        parts.push(environment_block(
            self.working_dir.as_deref(),
            is_git,
            platform,
            &os_ver,
            &self.model_name,
            &self.model_id,
        ));

        parts.join("\n\n")
    }

    /// Generate the system prompt with additional dynamic context.
    ///
    /// This is used when rules or other dynamic content needs to be appended.
    pub fn generate_with_context(&self, additional_context: &str) -> String {
        let mut prompt = self.generate();
        if !additional_context.is_empty() {
            prompt.push_str("\n\n");
            prompt.push_str(additional_context);
        }
        prompt
    }

    /// Get the current output style.
    pub fn style(&self) -> &OutputStyle {
        &self.style
    }

    /// Check if coding instructions are included.
    pub fn has_coding_instructions(&self) -> bool {
        self.style.keep_coding_instructions
    }
}

/// Derive a friendly model name from model ID.
fn derive_model_name(model_id: &str) -> String {
    // Extract base model name from ID
    // e.g., "claude-sonnet-4-20250514" -> "Claude Sonnet 4"
    // e.g., "claude-opus-4-5-20251101" -> "Claude Opus 4.5"

    if model_id.contains("opus-4-5") || model_id.contains("opus-4.5") {
        "Claude Opus 4.5".to_string()
    } else if model_id.contains("opus-4") {
        "Claude Opus 4".to_string()
    } else if model_id.contains("sonnet-4-5") || model_id.contains("sonnet-4.5") {
        "Claude Sonnet 4.5".to_string()
    } else if model_id.contains("sonnet-4") {
        "Claude Sonnet 4".to_string()
    } else if model_id.contains("haiku-4-5") || model_id.contains("haiku-4.5") {
        "Claude Haiku 4.5".to_string()
    } else if model_id.contains("haiku-4") {
        "Claude Haiku 4".to_string()
    } else if model_id.contains("3.5") || model_id.contains("3-5") {
        if model_id.contains("sonnet") {
            "Claude 3.5 Sonnet".to_string()
        } else if model_id.contains("haiku") {
            "Claude 3.5 Haiku".to_string()
        } else if model_id.contains("opus") {
            "Claude 3.5 Opus".to_string()
        } else {
            "Claude 3.5".to_string()
        }
    } else {
        "Claude".to_string()
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::output_style::OutputStyleSourceType;

    #[test]
    fn test_generator_default_no_cli_identity() {
        let prompt = SystemPromptGenerator::new().generate();

        // CLI Identity should NOT be included by default
        assert!(!prompt.starts_with(CLI_IDENTITY));
        assert!(prompt.contains("Doing tasks")); // coding instructions
        assert!(prompt.contains("<env>")); // environment block
    }

    #[test]
    fn test_generator_with_cli_identity() {
        let prompt = SystemPromptGenerator::with_cli_identity().generate();

        // CLI Identity MUST be the first line
        assert!(prompt.starts_with(CLI_IDENTITY));
        assert!(prompt.contains("Doing tasks")); // coding instructions
        assert!(prompt.contains("<env>")); // environment block
    }

    #[test]
    fn test_generator_with_custom_style_keep_coding() {
        let style = OutputStyle::new("test", "Test style", "Custom instructions here")
            .with_source_type(OutputStyleSourceType::User)
            .with_keep_coding_instructions(true);

        let prompt = SystemPromptGenerator::with_cli_identity()
            .with_style(style)
            .generate();

        assert!(prompt.starts_with(CLI_IDENTITY));
        assert!(prompt.contains("Doing tasks")); // coding instructions kept
        assert!(prompt.contains("Custom instructions here")); // custom prompt
        assert!(prompt.contains("<env>")); // environment block
    }

    #[test]
    fn test_generator_with_custom_style_no_coding() {
        let style = OutputStyle::new("concise", "Be concise", "Keep responses short.")
            .with_source_type(OutputStyleSourceType::User)
            .with_keep_coding_instructions(false);

        let prompt = SystemPromptGenerator::with_cli_identity()
            .with_style(style)
            .generate();

        assert!(prompt.starts_with(CLI_IDENTITY)); // CLI Identity preserved
        assert!(!prompt.contains("Doing tasks")); // coding instructions NOT included
        assert!(prompt.contains("Keep responses short.")); // custom prompt
        assert!(prompt.contains("<env>")); // environment block
    }

    #[test]
    fn test_generator_with_working_dir() {
        let prompt = SystemPromptGenerator::new()
            .with_working_dir("/test/project")
            .generate();

        assert!(prompt.contains("/test/project"));
    }

    #[test]
    fn test_generator_with_model() {
        let prompt = SystemPromptGenerator::new()
            .with_model("claude-opus-4-5-20251101")
            .generate();

        assert!(prompt.contains("claude-opus-4-5-20251101"));
        assert!(prompt.contains("Claude Opus 4.5"));
    }

    #[test]
    fn test_derive_model_name() {
        assert_eq!(
            derive_model_name("claude-opus-4-5-20251101"),
            "Claude Opus 4.5"
        );
        assert_eq!(
            derive_model_name("claude-sonnet-4-20250514"),
            "Claude Sonnet 4"
        );
        assert_eq!(
            derive_model_name("claude-haiku-4-5-20251001"),
            "Claude Haiku 4.5"
        );
        assert_eq!(
            derive_model_name("claude-3-5-sonnet-20241022"),
            "Claude 3.5 Sonnet"
        );
    }

    #[test]
    fn test_generator_with_context() {
        let prompt = SystemPromptGenerator::new()
            .generate_with_context("# Dynamic Rules\nSome dynamic content");

        assert!(prompt.contains("# Dynamic Rules"));
        assert!(prompt.contains("Some dynamic content"));
    }

    #[test]
    fn test_has_coding_instructions() {
        let generator = SystemPromptGenerator::new();
        assert!(generator.has_coding_instructions());

        let style = OutputStyle::new("no-coding", "", "").with_keep_coding_instructions(false);
        let generator = SystemPromptGenerator::new().with_style(style);
        assert!(!generator.has_coding_instructions());
    }

    #[test]
    fn test_cli_identity_cannot_be_replaced_by_custom_prompt() {
        // Even with a custom prompt that tries to replace identity,
        // CLI Identity should still be first when required
        let style = OutputStyle::new(
            "custom",
            "Custom identity",
            "I am a different assistant.", // Trying to replace identity
        )
        .with_keep_coding_instructions(false);

        let prompt = SystemPromptGenerator::with_cli_identity()
            .with_style(style)
            .generate();

        // CLI Identity MUST be first, custom prompt comes after
        assert!(prompt.starts_with(CLI_IDENTITY));
        assert!(prompt.contains("I am a different assistant."));
    }
}