shellchat 1.0.39

Transforms natural language into shell commands for execution or explanation.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94

use crate::common::check_or_truncate_max_os_shell;
use serde::Deserialize;
use std::fs;

#[derive(Debug, Deserialize, Clone)]
pub struct Prompts {
    pub explain: String,
    os_prompt: String,
    combinator_powershell: String,
    combinator_default: String,
    additional_instructions: String,
}

impl Prompts {
    pub fn from_yaml(file_path: &str) -> Self {
        let config_content =
            fs::read_to_string(file_path).expect("Failed to read the prompts file");
        Prompts::from_yaml_content(&config_content)
    }

    pub fn from_yaml_content(config_content: &str) -> Self {
        serde_yaml::from_str(config_content).expect("Failed to parse the prompts file")
    }

    pub fn shell_prompt(&self, os: &str, shell: &str) -> String {
        let combinator = if shell == "powershell" {
            &self.combinator_powershell
        } else {
            &self.combinator_default
        };
        format!(
            "{}\n{}\n{}",
            self.os_prompt
                .replace("{os}", check_or_truncate_max_os_shell(os))
                .replace("{shell}", check_or_truncate_max_os_shell(shell)),
            combinator,
            self.additional_instructions
        )
    }
}

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

    #[test]
    fn test_prompt_from_yaml() {
        let yaml_content = r#"
        explain: "Explain prompt"
        os_prompt: "Operating system prompt for {os} and {shell}"
        combinator_powershell: "PowerShell combinator"
        combinator_default: "Default combinator"
        additional_instructions: "Additional instructions"
        "#;

        let prompts = Prompts::from_yaml_content(yaml_content);
        assert_eq!(prompts.explain, "Explain prompt");
        assert_eq!(
            prompts.os_prompt,
            "Operating system prompt for {os} and {shell}"
        );
        assert_eq!(prompts.combinator_powershell, "PowerShell combinator");
        assert_eq!(prompts.combinator_default, "Default combinator");
        assert_eq!(prompts.additional_instructions, "Additional instructions");
    }

    #[test]
    fn test_shell_prompt() {
        let yaml_content = r#"
        explain: "Explain prompt"
        os_prompt: "Operating system prompt for {os} and {shell}"
        combinator_powershell: "PowerShell combinator"
        combinator_default: "Default combinator"
        additional_instructions: "Additional instructions"
        "#;

        let prompts = Prompts::from_yaml_content(yaml_content);

        let shell_prompt = prompts.shell_prompt("Windows", "powershell");
        assert!(shell_prompt.contains("Operating system prompt for Windows and powershell"));
        assert!(shell_prompt.contains("PowerShell combinator"));
        assert!(shell_prompt.contains("Additional instructions"));

        let shell_prompt = prompts.shell_prompt("Linux", "bash");
        assert!(shell_prompt.contains("Operating system prompt for Linux and bash"));
        assert!(shell_prompt.contains("Default combinator"));
        assert!(shell_prompt.contains("Additional instructions"));
    }
    #[test]
    fn test_prompt_from_yaml_file_not_found() {
        let result = std::panic::catch_unwind(|| Prompts::from_yaml("non_existent_file.yaml"));
        assert!(result.is_err());
    }
}