vik 0.1.2

Vik is an issue-driven coding workflow automation tool.
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
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169

//! `agents:` section of the Workflow Definition.
//!
//! Each map entry parses into an [`AgentProfileSchema`] holding a runtime
//! tag, a model name, and an opaque `args` mapping. The agent module owns
//! the typed param structs because adapters define what they accept; the
//! config layer is intentionally the lower layer that imports them, so
//! adding a new runtime never forces a config-side change.
//!
//! ```yaml
//! agents:
//!   codex:
//!     runtime: codex
//!     model: gpt-5.5
//!     args:
//!       --config:
//!         - model_reasoning_effort=high
//! ```

use std::fmt::Display;
use std::ops::Deref;
use std::ops::DerefMut;

use indexmap::IndexMap;
use serde::{Deserialize, Serialize};

use super::WorkflowSchema;
use super::diagnose::*;

#[derive(Debug, Clone, Copy, Serialize, Deserialize)]
#[serde(rename_all = "snake_case")]
pub enum AgentRuntime {
  Codex,
  ClaudeCode,
}

impl AsRef<str> for AgentRuntime {
  fn as_ref(&self) -> &str {
    match self {
      AgentRuntime::Codex => "codex",
      AgentRuntime::ClaudeCode => "claude_code",
    }
  }
}

impl Display for AgentRuntime {
  fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
    write!(f, "{}", self.as_ref())
  }
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct AgentProfileSchema {
  pub runtime: AgentRuntime,
  /// Interpretation is runtime-specific: a Codex model name like `gpt-5.5`,
  /// a Claude alias like `opus`, etc. Vik does not validate the value.
  pub model: String,

  /// Forwarded verbatim to the spawn command. Kept as `serde_yaml::Mapping`
  /// (not a typed struct) so each runtime can accept its own flag set
  /// without expanding this schema.
  #[serde(default, skip_serializing_if = "serde_yaml::Mapping::is_empty")]
  pub args: serde_yaml::Mapping,

  #[serde(flatten)]
  unknown_fields: serde_yaml::Mapping,
}

#[cfg(test)]
impl AgentProfileSchema {
  pub fn new(runtime: AgentRuntime, model: String) -> Self {
    Self {
      runtime,
      model,
      args: serde_yaml::Mapping::new(),
      unknown_fields: serde_yaml::Mapping::new(),
    }
  }

  pub fn with_args(mut self, args: serde_yaml::Mapping) -> Self {
    self.args = args;
    self
  }
}

#[derive(Debug, Clone, Serialize, Deserialize, Default)]
pub struct AgentProfilesSchema(IndexMap<String, AgentProfileSchema>);

impl Diagnose for AgentProfileSchema {
  fn diagnose(&self, _: &WorkflowSchema) -> Diagnostics {
    let mut diagnostics = Diagnostics::new();

    diagnostics.error_if_empty_str("model", &self.model);
    diagnostics.warn_unknown_fields(&self.unknown_fields);

    diagnostics
  }
}

impl Diagnose for AgentProfilesSchema {
  fn diagnose(&self, workflow: &WorkflowSchema) -> Diagnostics {
    let mut diagnostics = Diagnostics::new();

    diagnostics.error_if_empty_map_here(self.is_empty());
    self.0.iter().for_each(|(profile_name, profile)| {
      diagnostics.extends_with_pointer(profile_name, profile.diagnose(workflow));
    });

    diagnostics
  }
}

impl Deref for AgentProfilesSchema {
  type Target = IndexMap<String, AgentProfileSchema>;

  fn deref(&self) -> &Self::Target {
    &self.0
  }
}

impl DerefMut for AgentProfilesSchema {
  fn deref_mut(&mut self) -> &mut Self::Target {
    &mut self.0
  }
}

#[cfg(test)]
mod tests {
  use crate::config::WorkflowSchema;
  use crate::config::diagnose::Diagnose;
  use crate::config::diagnose::DiagnosticCode;

  use super::*;

  #[test]
  fn agent_runtime_uses_snake_case_yaml_values() {
    let codex: AgentRuntime = serde_yaml::from_str("codex").expect("codex runtime parses");
    let claude_code: AgentRuntime = serde_yaml::from_str("claude_code").expect("claude code runtime parses");

    assert!(matches!(codex, AgentRuntime::Codex));
    assert!(matches!(claude_code, AgentRuntime::ClaudeCode));
    assert_eq!(
      serde_yaml::to_string(&AgentRuntime::ClaudeCode).expect("runtime serializes"),
      "claude_code\n"
    );
  }

  #[test]
  fn agent_profile_defaults_args_and_warns_unknown_fields() {
    let profile: AgentProfileSchema = serde_yaml::from_str(
      r#"
runtime: codex
model: gpt-5.5
typo: true
"#,
    )
    .expect("profile parses");

    let diagnostics = profile.diagnose(&WorkflowSchema::default());

    assert!(profile.args.is_empty());
    assert!(!diagnostics.has_errors());
    assert!(
      diagnostics
        .warnings
        .iter()
        .any(|diag| diag.pointer == "typo" && matches!(diag.code, DiagnosticCode::UnknownField))
    );
  }
}