codewhale-tui 0.9.8

Terminal UI for open-source and open-weight coding models
Documentation 
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
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140

//! The input contracts the model sees: the canonical union schema, and the
//! per-action schemas the hidden legacy aliases still advertise.

use serde_json::{Value, json};

/// The union schema for the canonical `github` tool: `action` plus every
/// field any allowed action reads. `read_only` drops the write fields so the
/// Plan-mode surface cannot even describe a mutation.
pub(super) fn canonical_schema(allowed_actions: &[&str], read_only: bool) -> Value {
    let actions: Vec<&str> = allowed_actions.to_vec();
    let mut properties = serde_json::Map::new();
    properties.insert(
        "action".to_string(),
        json!({
            "type": "string",
            "enum": actions,
            "description": "Action to perform."
        }),
    );
    properties.insert(
        "number".to_string(),
        json!({ "type": "integer", "minimum": 1, "description": "Issue/PR number (all actions)." }),
    );
    properties.insert(
        "include_comments".to_string(),
        json!({ "type": "boolean", "default": true, "description": "(action=issue_context)" }),
    );
    properties.insert(
        "include_diff".to_string(),
        json!({ "type": "boolean", "default": false, "description": "(action=pr_context)" }),
    );
    if !read_only {
        properties.insert(
            "target".to_string(),
            json!({ "type": "string", "enum": ["issue", "pr"], "description": "(action=comment)" }),
        );
        properties.insert(
            "body".to_string(),
            json!({ "type": "string", "description": "Comment body (action=comment)." }),
        );
        properties.insert(
            "evidence".to_string(),
            json!({
                "type": "object",
                "description": "Evidence object (action=comment/close_*). Close actions require files_changed, tests_run, final_status.",
                "properties": {
                    "files_changed": { "type": "array", "items": { "type": "string" } },
                    "tests_run": { "type": "array", "items": { "type": "string" } },
                    "commits": { "type": "array", "items": { "type": "string" } },
                    "final_status": { "type": "string" }
                }
            }),
        );
        properties.insert(
            "acceptance_criteria".to_string(),
            json!({ "type": "array", "items": { "type": "string" }, "minItems": 1, "description": "(action=close_issue/close_pr)" }),
        );
        properties.insert(
            "comment".to_string(),
            json!({ "type": "string", "description": "Optional closing comment (action=close_issue/close_pr)." }),
        );
        properties.insert(
            "allow_dirty".to_string(),
            json!({ "type": "boolean", "default": false, "description": "(action=close_issue/close_pr)" }),
        );
        properties.insert(
            "dry_run".to_string(),
            json!({ "type": "boolean", "default": false, "description": "(action=comment/close_issue/close_pr)" }),
        );
    }
    json!({
        "type": "object",
        "properties": properties,
        "additionalProperties": false
    })
}

/// The exact schema the legacy per-action tool exposed, kept so hidden alias
/// registrations report an identical contract to the pre-unification tools.
pub(super) fn legacy_action_schema(action: &str) -> Value {
    match action {
        "issue_context" => json!({
            "type": "object",
            "properties": {
                "number": { "type": "integer", "minimum": 1 },
                "include_comments": { "type": "boolean", "default": true }
            },
            "required": ["number"],
            "additionalProperties": false
        }),
        "pr_context" => json!({
            "type": "object",
            "properties": {
                "number": { "type": "integer", "minimum": 1 },
                "include_diff": { "type": "boolean", "default": false }
            },
            "required": ["number"],
            "additionalProperties": false
        }),
        "comment" => json!({
            "type": "object",
            "properties": {
                "target": { "type": "string", "enum": ["issue", "pr"] },
                "number": { "type": "integer", "minimum": 1 },
                "body": { "type": "string" },
                "evidence": { "type": "object" },
                "dry_run": { "type": "boolean", "default": false }
            },
            "required": ["target", "number", "body", "evidence"],
            "additionalProperties": false
        }),
        // close_issue / close_pr share the close schema.
        _ => close_input_schema(),
    }
}

fn close_input_schema() -> Value {
    json!({
        "type": "object",
        "properties": {
            "number": { "type": "integer", "minimum": 1 },
            "acceptance_criteria": { "type": "array", "items": { "type": "string" }, "minItems": 1 },
            "evidence": {
                "type": "object",
                "properties": {
                    "files_changed": { "type": "array", "items": { "type": "string" } },
                    "tests_run": { "type": "array", "items": { "type": "string" } },
                    "commits": { "type": "array", "items": { "type": "string" } },
                    "final_status": { "type": "string" }
                },
                "required": ["files_changed", "tests_run", "final_status"]
            },
            "comment": { "type": "string" },
            "allow_dirty": { "type": "boolean", "default": false },
            "dry_run": { "type": "boolean", "default": false }
        },
        "required": ["number", "acceptance_criteria", "evidence"],
        "additionalProperties": false
    })
}