Skip to main content

spar/
config.rs

1//! Configuration, and the agent presets that make a new CLI a data change
2//! rather than a code change.
3//!
4//! Presets are compiled into the binary. That is not an optimisation: a
5//! `cargo install`ed binary has no source tree beside it, so a preset read from
6//! a relative path would work for the author and fail for everyone else. Files
7//! on disk still win over the built in copies, so a preset can be overridden or
8//! a new one added without rebuilding.
9
10use std::collections::BTreeMap;
11use std::path::{Path, PathBuf};
12
13use serde::{Deserialize, Serialize};
14use toml::Value;
15
16use crate::error::Result;
17use crate::proc::{expand_tilde, home_dir};
18use crate::style::Style;
19use crate::{bail, spar_err};
20
21/// Presets that ship inside the binary.
22pub const BUILTIN_PRESETS: &[(&str, &str)] = &[
23    ("aider", include_str!("../presets/aider.toml")),
24    ("claude", include_str!("../presets/claude.toml")),
25    ("codex", include_str!("../presets/codex.toml")),
26    ("cursor", include_str!("../presets/cursor.toml")),
27    ("gemini", include_str!("../presets/gemini.toml")),
28];
29
30// ---------------------------------------------------------------------------
31// Agents
32// ---------------------------------------------------------------------------
33
34/// One element of a command template: a bare argument, or a group that is
35/// dropped whole when its placeholder is unset.
36#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq)]
37#[serde(untagged)]
38pub enum CommandPart {
39    One(String),
40    Group(Vec<String>),
41}
42
43impl CommandPart {
44    pub fn args(&self) -> &[String] {
45        match self {
46            CommandPart::One(s) => std::slice::from_ref(s),
47            CommandPart::Group(v) => v,
48        }
49    }
50}
51
52/// How to read the answer out of what a CLI printed.
53#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
54#[serde(rename_all = "lowercase")]
55pub enum OutputMode {
56    /// Everything on stdout is the answer.
57    Text,
58    /// Same as text; named separately because it reads better in a preset.
59    Json,
60    /// An event stream, one JSON object per line.
61    Jsonl,
62}
63
64/// Where the style rules go when a CLI has a system prompt flag.
65#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
66#[serde(rename_all = "lowercase")]
67pub enum SystemVia {
68    /// Prepended to the prompt.
69    Prompt,
70    /// Passed through the `{system}` placeholder.
71    Placeholder,
72}
73
74fn default_timeout() -> u64 {
75    crate::proc::DEFAULT_TIMEOUT_SECS
76}
77
78fn default_output() -> OutputMode {
79    OutputMode::Text
80}
81
82fn default_system_via() -> SystemVia {
83    SystemVia::Prompt
84}
85
86/// Everything needed to drive one CLI. An agent is data, not a class:
87/// supporting a new tool is a preset file.
88#[derive(Debug, Clone, Serialize, Deserialize)]
89#[serde(deny_unknown_fields)]
90pub struct AgentSpec {
91    #[serde(skip)]
92    pub name: String,
93    pub command: Vec<CommandPart>,
94    #[serde(default)]
95    pub model: Option<String>,
96    #[serde(default)]
97    pub effort: Option<String>,
98    /// This agent's own schedule, which wins over the shared one.
99    ///
100    /// Effort words are each CLI's own vocabulary, so one string for both
101    /// agents is a value that has to be legal in two languages at once. This is
102    /// where a schedule says `ultra` to codex and `high` to claude.
103    #[serde(default)]
104    pub effort_schedule: EffortSchedule,
105    #[serde(default = "default_output")]
106    pub output: OutputMode,
107    /// For `jsonl`: the event fields that identify the agent's own message.
108    #[serde(default)]
109    pub message_match: BTreeMap<String, String>,
110    /// For `jsonl`: the dotted path to the text inside a matching event.
111    #[serde(default)]
112    pub message_path: Option<String>,
113    /// Extra places to look for the binary when it is not on PATH.
114    #[serde(default)]
115    pub search_paths: Vec<String>,
116    #[serde(default = "default_system_via")]
117    pub system_via: SystemVia,
118    #[serde(default = "default_timeout")]
119    pub timeout: u64,
120    /// A stand in for when this agent cannot answer at all: a CLI that is down,
121    /// out of quota, or refusing the request on policy grounds.
122    ///
123    /// Declared as a nested table rather than by naming a third agent, because
124    /// spar takes exactly two and a backup is not a third opinion. It never
125    /// reviews alongside the pair, it only answers in place of the one that
126    /// failed, so the alternation the design rests on is unchanged.
127    ///
128    /// Built by `build_spec` from the `[agents.NAME.fallback]` table, never
129    /// deserialized directly, so a preset of its own still resolves.
130    #[serde(skip)]
131    pub fallback: Option<Box<AgentSpec>>,
132
133    // -- hints, inert at runtime -----------------------------------------
134    //
135    // Written into a generated config as comments so nobody has to guess what
136    // to put in `model` or `effort`. Deliberately never validated against: a
137    // CLI's options drift, and a stale allow list that refuses a model which
138    // actually works would be worse than no hint at all.
139    /// Model names this CLI is known to accept.
140    #[serde(default)]
141    pub models: Vec<String>,
142    /// Effort levels this CLI is known to accept.
143    #[serde(default)]
144    pub efforts: Vec<String>,
145    /// Where to check the current list, when spar cannot enumerate it.
146    #[serde(default)]
147    pub options_note: Option<String>,
148}
149
150impl AgentSpec {
151    /// The model as configured, normalised. An unset and an empty value both
152    /// mean "let the CLI pick", because `render` drops the flag either way.
153    pub fn model_key(&self) -> String {
154        self.model.as_deref().unwrap_or("").trim().to_string()
155    }
156
157    pub fn describe(&self) -> String {
158        format!(
159            "{}/{}",
160            self.model.as_deref().unwrap_or("default model"),
161            self.effort.as_deref().unwrap_or("default effort")
162        )
163    }
164}
165
166// ---------------------------------------------------------------------------
167// Loop and style blocks
168// ---------------------------------------------------------------------------
169
170/// Where an out of scope finding goes. On your own repository an issue is the
171/// right home. On a large repository that is not yours it is somebody else's
172/// notification and somebody else's triage queue.
173#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
174#[serde(rename_all = "lowercase")]
175pub enum Followups {
176    Issues,
177    Local,
178    None,
179}
180
181impl std::fmt::Display for Followups {
182    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
183        f.write_str(match self {
184            Followups::Issues => "issues",
185            Followups::Local => "local",
186            Followups::None => "none",
187        })
188    }
189}
190
191/// Whether a pull request spar opens starts as a draft, and when it stops being
192/// one.
193///
194/// A draft says the work is not for a person yet, which is exactly true while
195/// two agents are still arguing about it. `UntilApproved` makes that state mean
196/// something and clear itself: the loop marks the pull request ready the moment
197/// it has no blocking findings left. `Always` is for somebody who promotes
198/// every pull request by hand and wants spar to keep out of it.
199#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
200#[serde(rename_all = "snake_case")]
201pub enum Drafts {
202    /// Open ordinary pull requests. The default, and what spar has always done.
203    Never,
204    /// Open as a draft, and mark it ready when the review converges.
205    UntilApproved,
206    /// Open as a draft and leave it that way.
207    Always,
208}
209
210impl std::fmt::Display for Drafts {
211    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
212        f.write_str(match self {
213            Drafts::Never => "never",
214            Drafts::UntilApproved => "until_approved",
215            Drafts::Always => "always",
216        })
217    }
218}
219
220/// How much of its own working spar narrates into a pull request thread.
221///
222/// The agents never read the PR: they receive findings through their prompts,
223/// so nothing in the loop depends on any of this being posted. It exists purely
224/// for the person who reads the thread later, which is why the default is the
225/// outcome rather than the play by play.
226#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
227#[serde(rename_all = "lowercase")]
228pub enum PrComments {
229    /// One comment when the run finishes, and only if it has something to say.
230    Outcome,
231    /// A comment per review and per response, as it happens. An audit trail,
232    /// at the cost of a thread nobody wants to read.
233    Rounds,
234    /// Never comment on a pull request. Everything goes to the terminal.
235    None,
236}
237
238impl std::fmt::Display for PrComments {
239    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
240        f.write_str(match self {
241            PrComments::Outcome => "outcome",
242            PrComments::Rounds => "rounds",
243            PrComments::None => "none",
244        })
245    }
246}
247
248/// Where resume state lives. Local keeps the PR clean and costs no API calls;
249/// writing to the PR only buys anything if a run might be resumed from a
250/// different checkout.
251#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
252#[serde(rename_all = "lowercase")]
253pub enum StateStore {
254    Local,
255    Pr,
256    Both,
257}
258
259impl StateStore {
260    pub fn writes_local(self) -> bool {
261        matches!(self, StateStore::Local | StateStore::Both)
262    }
263    pub fn writes_pr(self) -> bool {
264        matches!(self, StateStore::Pr | StateStore::Both)
265    }
266}
267
268/// Whose comments `spar checkin` will act on, and whose comments under an issue
269/// reach a prompt.
270///
271/// The default is not timidity. Acting on a comment means a commit pushed to a
272/// branch because somebody typed a sentence, and `authorAssociation` is one
273/// field GitHub already returns on every comment endpoint that says whether
274/// they can write to this repository at all. Everybody is still answered in
275/// words either way; this governs only whether a comment can produce a commit.
276#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
277#[serde(rename_all = "lowercase")]
278pub enum Trust {
279    /// Anybody GitHub says can write here: OWNER, MEMBER, COLLABORATOR.
280    Write,
281    /// Anybody at all. Both agents still have to agree before anything changes.
282    Anyone,
283}
284
285impl std::fmt::Display for Trust {
286    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
287        f.write_str(match self {
288            Trust::Write => "write",
289            Trust::Anyone => "anyone",
290        })
291    }
292}
293
294impl Trust {
295    /// Whether a comment from somebody with this association may produce a
296    /// commit.
297    pub fn may_act_on(self, association: &str) -> bool {
298        match self {
299            Trust::Anyone => true,
300            Trust::Write => matches!(
301                association.trim().to_uppercase().as_str(),
302                "OWNER" | "MEMBER" | "COLLABORATOR"
303            ),
304        }
305    }
306}
307
308/// Which call is about to be made.
309///
310/// The schedule used to be two keys, `round_1` and `rest`, chosen by a round
311/// number that most of these calls do not have. Triage of the whole queue, the
312/// implement call, the follow-up screen, the check-in judge and the split
313/// proposer were all "round 1", so `round_1 = "ultra"` put every one of them at
314/// ultra, which is neither what the name says nor what anybody wants to pay
315/// for.
316#[derive(Debug, Clone, Copy, PartialEq, Eq)]
317pub enum Call {
318    /// Both agents, over the whole queue, once per wave.
319    Triage,
320    /// Writing the first draft.
321    Implement,
322    /// A review round. The first is the deep one.
323    Review(u32),
324    /// The author answering a review.
325    Respond(u32),
326    /// The closing merge-safety pass.
327    Close,
328    /// The follow-up screen, one call for the whole queue.
329    Screen,
330    /// A check-in call: the judge is round 1, the checker round 2.
331    Checkin(u32),
332    /// A split call: the proposer is round 1, the checker round 2.
333    Split(u32),
334    /// A brainstorm round: both agents diverge in round 1, cross in the
335    /// middle rounds, and converge in the last.
336    Brainstorm(u32),
337    /// A second look at a reviewed pull request after commits or replies.
338    Recheck,
339}
340
341impl Call {
342    /// The schedule key this call reads.
343    pub fn key(self) -> &'static str {
344        match self {
345            Call::Triage => "triage",
346            Call::Implement => "implement",
347            Call::Review(round) if round <= 1 => "review_1",
348            Call::Review(_) => "review_rest",
349            Call::Respond(_) => "respond",
350            Call::Close => "close",
351            Call::Screen => "screen",
352            Call::Checkin(_) => "checkin",
353            Call::Split(_) => "split",
354            Call::Brainstorm(_) => "brainstorm",
355            Call::Recheck => "recheck",
356        }
357    }
358
359    /// What the two key schedule would have used, so a config written before
360    /// the keys existed behaves exactly as it did.
361    fn legacy_round(self) -> u32 {
362        match self {
363            Call::Triage | Call::Implement | Call::Screen => 1,
364            Call::Review(round) | Call::Respond(round) => round,
365            Call::Checkin(round) | Call::Split(round) | Call::Brainstorm(round) => round,
366            Call::Close | Call::Recheck => 2,
367        }
368    }
369
370    /// Every kind, for `doctor` to check a configuration against.
371    pub fn every() -> [Call; 11] {
372        [
373            Call::Triage,
374            Call::Implement,
375            Call::Review(1),
376            Call::Review(2),
377            Call::Recheck,
378            Call::Respond(1),
379            Call::Close,
380            Call::Screen,
381            Call::Checkin(1),
382            Call::Split(1),
383            Call::Brainstorm(1),
384        ]
385    }
386}
387
388#[derive(Debug, Clone, Default, Serialize, Deserialize)]
389#[serde(deny_unknown_fields)]
390pub struct EffortSchedule {
391    /// The deep first review.
392    ///
393    /// Kept, and still read by every call that has no key of its own, so an
394    /// existing config keeps working exactly as it did.
395    pub round_1: Option<String>,
396    /// Every round after the first, and the closing pass. Both are asked a
397    /// narrower question than the first review, so neither buys its depth again.
398    pub rest: Option<String>,
399    /// Both agents, over the whole queue. The most expensive call in a run, and
400    /// the one the two key schedule never mentioned.
401    pub triage: Option<String>,
402    pub implement: Option<String>,
403    pub review_1: Option<String>,
404    pub review_rest: Option<String>,
405    pub respond: Option<String>,
406    pub close: Option<String>,
407    pub screen: Option<String>,
408    pub checkin: Option<String>,
409    pub split: Option<String>,
410    /// Every brainstorm round. Diverging is the deep call and the later rounds
411    /// answer narrower questions, but they read the same key: a brainstorm is
412    /// cheap next to a run, and one word for it is enough.
413    pub brainstorm: Option<String>,
414    /// A second look at a reviewed pull request: a delta and a list of claims
415    /// to check, so it sits with the later review rounds and reads
416    /// `review_rest` when it has no word of its own.
417    pub recheck: Option<String>,
418}
419
420/// A schedule entry that was actually written, blank meaning unset.
421fn set(value: &Option<String>) -> Option<String> {
422    value.clone().filter(|s| !s.trim().is_empty())
423}
424
425impl EffortSchedule {
426    /// What this schedule says about one call, if anything.
427    pub fn get(&self, call: Call) -> Option<String> {
428        let value = match call.key() {
429            "triage" => &self.triage,
430            "implement" => &self.implement,
431            "review_1" => &self.review_1,
432            "review_rest" => &self.review_rest,
433            "respond" => &self.respond,
434            "close" => &self.close,
435            "screen" => &self.screen,
436            "checkin" => &self.checkin,
437            "brainstorm" => &self.brainstorm,
438            "recheck" => {
439                return set(&self.recheck).or_else(|| set(&self.review_rest));
440            }
441            _ => &self.split,
442        };
443        set(value)
444    }
445
446    /// What the old two key schedule would have said.
447    fn legacy(&self, call: Call) -> Option<String> {
448        let value = if call.legacy_round() <= 1 {
449            &self.round_1
450        } else {
451            &self.rest
452        };
453        value.clone().filter(|s| !s.trim().is_empty())
454    }
455}
456
457/// A command spar runs itself, before it pushes.
458///
459/// A string is split on whitespace, which covers `cargo test` and `npm test`.
460/// A list is taken as it is, for anything that needs an argument with a space
461/// in it. No shell either way: spar runs the program, so nothing here is
462/// interpreted.
463#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
464#[serde(untagged)]
465pub enum CheckCommand {
466    Line(String),
467    Argv(Vec<String>),
468}
469
470impl Default for CheckCommand {
471    /// An empty list, which is both "nothing to run" and a value that survives
472    /// a round trip through TOML, unlike a unit variant.
473    fn default() -> Self {
474        CheckCommand::Argv(Vec::new())
475    }
476}
477
478impl CheckCommand {
479    pub fn argv(&self) -> Vec<String> {
480        match self {
481            CheckCommand::Line(line) => line.split_whitespace().map(str::to_string).collect(),
482            CheckCommand::Argv(argv) => argv
483                .iter()
484                .map(|a| a.trim().to_string())
485                .filter(|a| !a.is_empty())
486                .collect(),
487        }
488    }
489
490    pub fn is_set(&self) -> bool {
491        !self.argv().is_empty()
492    }
493
494    /// How the command reads in a log line or a pull request body.
495    pub fn describe(&self) -> String {
496        self.argv().join(" ")
497    }
498}
499
500/// Every field takes its value from `LoopCfg::default()` when a config does not
501/// mention it, rather than from a per-field function saying the same thing in a
502/// second place. Two places is how a default goes stale.
503#[derive(Debug, Clone, Serialize, Deserialize)]
504#[serde(default, deny_unknown_fields)]
505pub struct LoopCfg {
506    /// Review rounds one invocation may spend asking for changes. A run that
507    /// spends the full budget may use one closing pass, which is not a round.
508    pub max_rounds: u32,
509    pub auto_merge: bool,
510    pub first_implementor: Option<String>,
511    pub base_branch: String,
512    pub worktrees: bool,
513    pub keep_worktrees: bool,
514    pub state_store: StateStore,
515    pub branch_prefix: String,
516    pub followups: Followups,
517    /// File a non-blocking finding as a follow-up.
518    ///
519    /// Off by default, and this is the setting that stops a run breeding. A
520    /// thorough reviewer always finds improvements, and turning each one into a
521    /// tracker item made a single issue spawn ten, which spawned more: mean
522    /// offspring above one never terminates. Not gating a merge is not the same
523    /// as being worth somebody's triage queue.
524    pub file_non_blocking: bool,
525    /// Most follow-ups one run may record before it stops and says what it
526    /// dropped. A backstop, not a target.
527    pub max_followups: usize,
528    /// Most parts `spar split` will make out of one issue or pull request.
529    ///
530    /// A backstop, not a target, in the shape of `max_followups`. There is no
531    /// setting to turn splitting off: it is a command somebody types, and a
532    /// setting to disable a command nobody has to run only ever confuses. There
533    /// is no mechanical threshold either, because a floor on files changed
534    /// would split a forty file rename and hold back a three file mess.
535    pub max_split_parts: usize,
536    /// Nits stay in the PR thread by default. A filed nit is somebody else's
537    /// notification: a run on a production codebase once opened an issue titled
538    /// "Log wording".
539    pub file_nits: bool,
540    /// Close an issue that both agents independently declined, after posting
541    /// the shared reasoning. One agent's opinion is never enough.
542    pub close_skipped: bool,
543    /// Ask both agents to triage at the same time. They only read during
544    /// triage, so there is nothing to serialise.
545    pub parallel_triage: bool,
546    /// Ignore issues and pull requests numbered below this when spar is picking
547    /// for itself. 0 is no floor.
548    ///
549    /// A repository that has been going a while carries a tail of old issues
550    /// nobody is going to reach, and since spar takes the lowest numbered open
551    /// items it walks straight into them. A number you name explicitly is still
552    /// honoured: naming it is the point.
553    pub min_number: i64,
554    /// Waves of newly filed follow-ups to fold back into the same run, rather
555    /// than leaving them for the next one.
556    ///
557    /// Off by default because it multiplies what a run costs, and because each
558    /// wave can file follow-ups of its own. Every wave is triaged like any
559    /// other issue, so both agents still have to agree it is worth doing.
560    pub absorb_new_issues: u32,
561    /// Turn the checklist in a tracking issue into issues, and work them.
562    ///
563    /// Off by default, for the reason `file_non_blocking` is: a tracker exists
564    /// to contain many things, so this is the shape of feature that multiplies.
565    /// `max_tracker_children` caps it, a child that triage calls a tracker is
566    /// held rather than decomposed in turn, and both agents still gate every
567    /// child at triage.
568    ///
569    /// The trigger is the checklist, never a judgement about what the parts
570    /// are. Writing `- [ ]` lines is something a person does on purpose, which
571    /// makes this opt in per issue as well as per repository.
572    pub decompose_trackers: bool,
573    /// Most items from one tracker's checklist that one run may take on. A cap,
574    /// not a target, and what it left is named out loud.
575    pub max_tracker_children: usize,
576    /// Whether a pull request spar opens starts as a draft.
577    pub drafts: Drafts,
578    /// Extra instructions handed to both agents with every request.
579    ///
580    /// For what a person wants of this repository that the code cannot say and
581    /// spar has no setting for: how far to go, what not to touch, what not to
582    /// wait on. A CLI reads its own conventions file already, CLAUDE.md or
583    /// AGENTS.md, but each reads only its own, and two agents given different
584    /// standing instructions are not the pair this design rests on.
585    ///
586    /// Subordinate to the request and to the schema, which is said in the
587    /// header they arrive under: they change how the work is done, never what
588    /// was asked for or the shape of the answer.
589    pub instructions: String,
590    /// The most of one issue, its body and the comments on it, that reaches a
591    /// prompt. Past it the oldest comments go first, then the body's tail.
592    ///
593    /// Sized so that no issue a person wrote is ever cut. It was 2000 for
594    /// triage and 6000 for implement, silently, and both were small enough to
595    /// clip an ordinary bug report: an agent given half an issue judges and
596    /// implements the half it saw and has no way to know the rest existed.
597    /// When this does fire it is said out loud, in the log and in the prompt.
598    pub max_issue_chars: usize,
599    /// The most every issue together, bodies and comments, may add to one
600    /// triage prompt.
601    ///
602    /// Triage reads the whole queue at once, so the only unbounded thing here
603    /// is the queue. Past this, whole issues are left for the next run rather
604    /// than every issue being shortened: a verdict is posted on the issue and
605    /// can close it, so judging one on part of its body is worse than not
606    /// reaching it yet.
607    pub max_triage_chars: usize,
608    /// Whose comments `spar checkin` will act on, and whose comments under an
609    /// issue reach the prompts that implement, triage, and review it.
610    ///
611    /// One setting, because both are the same question: whether what somebody
612    /// typed can become a commit. The person who filed an issue is read under
613    /// it whatever this says, since they wrote the body.
614    pub checkin_trust: Trust,
615    /// Mark a review thread resolved when spar made the change it asked for.
616    ///
617    /// A thread spar disagreed with is left open whatever this says: the person
618    /// who raised it has not had their say yet, and it is their thread.
619    pub checkin_resolve: bool,
620    /// Most unanswered comments spar answers on one pull request in a run.
621    ///
622    /// A backstop against a long argument being read back to somebody, not a
623    /// target. What it held back is said out loud.
624    pub max_checkin_comments: usize,
625    /// A command spar runs in the worktree after an editing call committed and
626    /// before the branch is pushed. Unset means nothing is run.
627    ///
628    /// The design's rule is that a prompt is not a permission and every claim
629    /// an agent makes is checked mechanically where it can be. "I ran the
630    /// tests" was the one claim nothing checked: the schema records it, and
631    /// spar pushed and opened the pull request on the agent's word. This is not
632    /// waiting on CI, which is expensive and somebody else's machine. It is one
633    /// command, before the push, that fails closed.
634    pub check: CheckCommand,
635    pub effort_schedule: EffortSchedule,
636}
637
638impl Default for LoopCfg {
639    fn default() -> Self {
640        Self {
641            max_rounds: 3,
642            auto_merge: false,
643            first_implementor: None,
644            base_branch: "main".into(),
645            worktrees: true,
646            keep_worktrees: false,
647            state_store: StateStore::Local,
648            branch_prefix: String::new(),
649            followups: Followups::Local,
650            file_non_blocking: false,
651            max_followups: 5,
652            max_split_parts: 4,
653            file_nits: false,
654            close_skipped: true,
655            parallel_triage: true,
656            min_number: 0,
657            absorb_new_issues: 0,
658            decompose_trackers: false,
659            max_tracker_children: 5,
660            drafts: Drafts::Never,
661            instructions: String::new(),
662            max_issue_chars: 60_000,
663            max_triage_chars: 200_000,
664            checkin_trust: Trust::Write,
665            checkin_resolve: true,
666            max_checkin_comments: 20,
667            check: CheckCommand::default(),
668            effort_schedule: EffortSchedule::default(),
669        }
670    }
671}
672
673#[derive(Debug, Clone, Serialize, Deserialize)]
674#[serde(default, deny_unknown_fields)]
675pub struct StyleCfg {
676    pub ban_em_dash: bool,
677    pub ban_ai_attribution: bool,
678    pub terse: bool,
679    pub max_detail_chars: usize,
680    pub max_summary_chars: usize,
681    pub max_body_chars: usize,
682    /// A filed issue's body. Far larger than a PR comment's on purpose: a
683    /// comment is read with the diff in front of you, an issue is picked up
684    /// cold months later by somebody who needs the whole story.
685    pub max_issue_body_chars: usize,
686    pub max_title_chars: usize,
687    pub pr_comments: PrComments,
688}
689
690impl Default for StyleCfg {
691    /// Taken from `Style`, which is where the budgets are decided, rather than
692    /// written out again here.
693    ///
694    /// They were written out again here, and they drifted. The functions
695    /// supplying them to serde were still named `d90`, `d200`, `d320`, `d900`
696    /// and `d4000` while returning 140, 2000, 6000, 8000 and 20000, and the
697    /// config `spar init` generated offered the old numbers as though they
698    /// were current. Uncommenting one of those lines to see what it did cut
699    /// every comment spar posts to a fifth of its length.
700    fn default() -> Self {
701        let style = Style::default();
702        Self {
703            ban_em_dash: style.ban_em_dash,
704            ban_ai_attribution: style.ban_ai_attribution,
705            terse: style.terse,
706            max_detail_chars: style.max_detail_chars,
707            max_summary_chars: style.max_summary_chars,
708            max_body_chars: style.max_body_chars,
709            max_issue_body_chars: style.max_issue_body_chars,
710            max_title_chars: style.max_title_chars,
711            pr_comments: style.pr_comments,
712        }
713    }
714}
715
716impl StyleCfg {
717    pub fn to_style(&self) -> Style {
718        Style {
719            ban_em_dash: self.ban_em_dash,
720            ban_ai_attribution: self.ban_ai_attribution,
721            terse: self.terse,
722            max_detail_chars: self.max_detail_chars,
723            max_summary_chars: self.max_summary_chars,
724            max_body_chars: self.max_body_chars,
725            max_issue_body_chars: self.max_issue_body_chars,
726            max_title_chars: self.max_title_chars,
727            pr_comments: self.pr_comments,
728        }
729    }
730}
731
732// ---------------------------------------------------------------------------
733// Listening
734// ---------------------------------------------------------------------------
735
736/// What `spar listen` does with a pull request somebody put in front of you.
737#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
738#[serde(rename_all = "lowercase")]
739pub enum ReviewOrIgnore {
740    /// Review it, with a verdict when `verdicts` is on.
741    Review,
742    /// Say so in the log and do nothing.
743    Ignore,
744}
745
746impl std::fmt::Display for ReviewOrIgnore {
747    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
748        f.write_str(match self {
749            ReviewOrIgnore::Review => "review",
750            ReviewOrIgnore::Ignore => "ignore",
751        })
752    }
753}
754
755/// What `spar listen` does when somebody speaks on a pull request you wrote.
756/// GitHub will not let the same account approve it, so the choice is between
757/// `spar checkin` with and without the power to push.
758#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
759#[serde(rename_all = "lowercase")]
760pub enum OwnPr {
761    /// `spar checkin`: a change both agents agree on is pushed, behind
762    /// `checkin_trust`.
763    Checkin,
764    /// `spar checkin --reply-only`: answered in words, nothing pushed.
765    Reply,
766    /// Say so in the log and do nothing.
767    Ignore,
768}
769
770impl std::fmt::Display for OwnPr {
771    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
772        f.write_str(match self {
773            OwnPr::Checkin => "checkin",
774            OwnPr::Reply => "reply",
775            OwnPr::Ignore => "ignore",
776        })
777    }
778}
779
780/// What `spar listen` watches for and what it does about it. As with `LoopCfg`,
781/// every field takes its value from `ListenCfg::default()` when a config does
782/// not mention it.
783#[derive(Debug, Clone, Serialize, Deserialize)]
784#[serde(default, deny_unknown_fields)]
785pub struct ListenCfg {
786    /// Seconds between polls of GitHub's notifications for the repository.
787    /// GitHub says how often it will answer, and the larger of the two is used.
788    pub interval: u64,
789    /// Seconds between sweeps of the open pull requests. A push raises no
790    /// notification for a reviewer, so the sweep is what notices a reviewed
791    /// pull request moving.
792    pub sweep: u64,
793    /// Seconds an item has to stay quiet before spar acts on it, so a push and
794    /// three replies in the same minute cost one recheck rather than four.
795    pub settle: u64,
796    /// Most seconds an item may keep settling before it is acted on anyway.
797    pub max_wait: u64,
798    /// Rechecks one pull request gets before a person has to run `spar review`
799    /// on it again. A cap against two bots arguing, not a target. 0 turns
800    /// automatic rechecks off.
801    pub max_rechecks: u32,
802    pub on_review_requested: ReviewOrIgnore,
803    pub on_assigned: ReviewOrIgnore,
804    pub on_own_pr: OwnPr,
805    /// Whether a review `spar listen` starts submits a formal verdict, approve
806    /// or request changes, rather than a comment. A recheck always does.
807    pub verdicts: bool,
808}
809
810impl Default for ListenCfg {
811    fn default() -> Self {
812        Self {
813            interval: 60,
814            sweep: 300,
815            settle: 120,
816            max_wait: 900,
817            max_rechecks: 5,
818            on_review_requested: ReviewOrIgnore::Review,
819            on_assigned: ReviewOrIgnore::Review,
820            on_own_pr: OwnPr::Checkin,
821            verdicts: true,
822        }
823    }
824}
825
826// ---------------------------------------------------------------------------
827// The whole config
828// ---------------------------------------------------------------------------
829
830#[derive(Debug, Clone)]
831pub struct Config {
832    /// In declaration order, which is what `first_implementor` defaults to.
833    pub agents: Vec<AgentSpec>,
834    pub loop_cfg: LoopCfg,
835    pub style: Style,
836    pub listen: ListenCfg,
837    /// Resolved: never empty, always one of the configured agents. Under the
838    /// alternating policy this is who goes first on the first issue.
839    pub first_implementor: String,
840    /// Whether the first implementor swaps from issue to issue.
841    pub alternate_first: bool,
842    /// Where this config was read from, for error messages.
843    pub source: Option<PathBuf>,
844}
845
846impl Config {
847    pub fn agent_names(&self) -> Vec<String> {
848        self.agents.iter().map(|a| a.name.clone()).collect()
849    }
850
851    pub fn has_agent(&self, name: &str) -> bool {
852        self.agents.iter().any(|a| a.name == name)
853    }
854
855    pub fn spec(&self, name: &str) -> Result<&AgentSpec> {
856        self.agents.iter().find(|a| a.name == name).ok_or_else(|| {
857            spar_err!(
858                "no agent named '{name}' ({})",
859                self.agent_names().join(", ")
860            )
861        })
862    }
863
864    /// The other agent. With exactly two configured, custody alternates by
865    /// definition.
866    pub fn other(&self, name: &str) -> String {
867        let names = self.agent_names();
868        if names.first().map(String::as_str) == Some(name) {
869            names.get(1).cloned().unwrap_or_else(|| name.to_string())
870        } else {
871            names.first().cloned().unwrap_or_else(|| name.to_string())
872        }
873    }
874
875    /// What effort one agent is asked for on one call.
876    ///
877    /// Four places, most specific first: this agent's own schedule, the shared
878    /// schedule, the old `round_1`/`rest` pair, and the agent's plain `effort`.
879    /// The per agent layer is what makes a schedule expressible at all when the
880    /// two CLIs do not share a vocabulary: `ultra` is not a value the claude
881    /// preset accepts, and `max` means different things to each.
882    pub fn effort_for(&self, spec: &AgentSpec, call: Call) -> Option<String> {
883        spec.effort_schedule
884            .get(call)
885            .or_else(|| self.loop_cfg.effort_schedule.get(call))
886            .or_else(|| self.loop_cfg.effort_schedule.legacy(call))
887            .or_else(|| spec.effort.clone())
888    }
889
890    /// Round 1 gets the deep pass; later rounds only see a small delta, and a
891    /// full ultra review of a three line delta is money on fire.
892    pub fn effort_for_round(&self, spec: &AgentSpec, round: u32) -> Option<String> {
893        self.effort_for(spec, Call::Review(round))
894    }
895
896    /// Who writes the first draft of the nth issue this run works.
897    ///
898    /// Fixed unless the policy is to alternate, in which case it swaps every
899    /// issue, so both models author and both models review first over a queue.
900    pub fn first_implementor_for(&self, nth: usize) -> String {
901        if !self.alternate_first || nth % 2 == 0 {
902            return self.first_implementor.clone();
903        }
904        self.other(&self.first_implementor)
905    }
906
907    /// What to print when somebody asks who goes first.
908    pub fn first_implementor_policy(&self) -> String {
909        if self.alternate_first {
910            format!("alternating, {} first", self.first_implementor)
911        } else {
912            self.first_implementor.clone()
913        }
914    }
915
916    pub fn base_branch(&self) -> &str {
917        &self.loop_cfg.base_branch
918    }
919}
920
921#[derive(Debug, Deserialize)]
922#[serde(deny_unknown_fields)]
923struct RawConfig {
924    #[serde(default)]
925    agents: toml::Table,
926    #[serde(default)]
927    #[serde(rename = "loop")]
928    loop_cfg: Option<LoopCfg>,
929    #[serde(default)]
930    style: Option<StyleCfg>,
931    #[serde(default)]
932    listen: Option<ListenCfg>,
933}
934
935// ---------------------------------------------------------------------------
936// Presets
937// ---------------------------------------------------------------------------
938
939/// Directories searched for preset overrides, nearest first.
940///
941/// Deliberately *not* a bare `presets/`. spar runs from inside the user's own
942/// repository, where `presets/` is a perfectly ordinary directory name for
943/// something unrelated (sampler configs, prompt libraries, editor themes), and
944/// a stray `presets/claude.toml` shadowing the built in preset produces a
945/// baffling failure: `spar init` reports Claude Code as missing while it sits
946/// on PATH. Overrides live somewhere that names spar.
947pub fn preset_dirs() -> Vec<PathBuf> {
948    let mut dirs = Vec::new();
949    if let Some(custom) = std::env::var_os("SPAR_PRESET_DIR") {
950        dirs.push(PathBuf::from(custom));
951    }
952    dirs.push(PathBuf::from(".spar").join("presets"));
953    if let Some(home) = home_dir() {
954        dirs.push(home.join(".config").join("spar").join("presets"));
955    }
956    dirs
957}
958
959/// Every preset name available, built in and on disk, sorted.
960pub fn available_presets() -> Vec<String> {
961    let mut names: Vec<String> = BUILTIN_PRESETS.iter().map(|(n, _)| n.to_string()).collect();
962    for dir in preset_dirs() {
963        if let Ok(entries) = std::fs::read_dir(&dir) {
964            for entry in entries.flatten() {
965                let path = entry.path();
966                if path.extension().and_then(|e| e.to_str()) == Some("toml") {
967                    if let Some(stem) = path.file_stem().and_then(|s| s.to_str()) {
968                        names.push(stem.to_string());
969                    }
970                }
971            }
972        }
973    }
974    names.sort();
975    names.dedup();
976    names
977}
978
979/// Parse a whole TOML document into a `Value`.
980///
981/// `"...".parse::<Value>()` parses a single TOML *value*, not a document, so it
982/// rejects the first comment line of every preset.
983fn parse_document(text: &str, what: &str) -> Result<Value> {
984    let table: toml::Table =
985        toml::from_str(text).map_err(|e| spar_err!("{what} is not valid TOML: {e}"))?;
986    Ok(Value::Table(table))
987}
988
989/// Load a preset. A file on disk wins over the built in copy of the same name,
990/// so a drifting CLI can be corrected without waiting for a release.
991pub fn load_preset(name: &str) -> Result<Value> {
992    for dir in preset_dirs() {
993        let path = dir.join(format!("{name}.toml"));
994        if path.is_file() {
995            let text = std::fs::read_to_string(&path)
996                .map_err(|e| spar_err!("could not read preset {}: {e}", path.display()))?;
997            return parse_document(&text, &format!("preset {}", path.display()));
998        }
999    }
1000    for (builtin, text) in BUILTIN_PRESETS {
1001        if *builtin == name {
1002            return parse_document(text, &format!("built in preset {name}"));
1003        }
1004    }
1005    Err(spar_err!(
1006        "unknown preset '{name}'. Available: {}",
1007        available_presets().join(", ")
1008    ))
1009}
1010
1011/// Deep merge, with `over` winning. Used so a config block can override one
1012/// field of a preset without restating the whole command template.
1013fn merge(base: &Value, over: &Value) -> Value {
1014    match (base, over) {
1015        (Value::Table(b), Value::Table(o)) => {
1016            let mut out = b.clone();
1017            for (key, value) in o {
1018                let merged = match out.get(key) {
1019                    Some(existing) => merge(existing, value),
1020                    None => value.clone(),
1021                };
1022                out.insert(key.clone(), merged);
1023            }
1024            Value::Table(out)
1025        }
1026        _ => over.clone(),
1027    }
1028}
1029
1030fn build_spec(name: &str, raw: &Value) -> Result<AgentSpec> {
1031    let table = raw
1032        .as_table()
1033        .ok_or_else(|| spar_err!("agent '{name}' must be a table"))?;
1034
1035    let merged = match table.get("preset").and_then(Value::as_str) {
1036        Some(preset) => merge(&load_preset(preset)?, raw),
1037        None => raw.clone(),
1038    };
1039
1040    let mut merged_table = merged
1041        .as_table()
1042        .cloned()
1043        .ok_or_else(|| spar_err!("agent '{name}' must be a table"))?;
1044    merged_table.remove("preset");
1045    // Lifted out before the spec is deserialized: a fallback is a whole agent,
1046    // preset and all, and only this function knows how to resolve a preset.
1047    let fallback_raw = merged_table.remove("fallback");
1048
1049    if !merged_table.contains_key("command") {
1050        bail!(
1051            "agent '{name}' has no command and no preset. Set one of them, or pick a preset: {}",
1052            available_presets().join(", ")
1053        );
1054    }
1055
1056    let mut spec: AgentSpec = Value::Table(merged_table)
1057        .try_into()
1058        .map_err(|e| spar_err!("agent '{name}': {e}"))?;
1059    spec.name = name.to_string();
1060
1061    if spec.command.is_empty() {
1062        bail!("agent '{name}' has an empty command");
1063    }
1064    if matches!(spec.command.first(), Some(CommandPart::Group(_))) {
1065        bail!("agent '{name}': the first command element must be the program name, not a group");
1066    }
1067    if spec.output == OutputMode::Jsonl && spec.message_path.as_deref().unwrap_or("").is_empty() {
1068        bail!(
1069            "agent '{name}': output = \"jsonl\" needs a message_path saying where the answer lives"
1070        );
1071    }
1072
1073    if let Some(raw) = fallback_raw {
1074        if !raw.is_table() {
1075            bail!(
1076                "agent '{name}': fallback is a whole agent, so write it as a table:\n                   [agents.{name}.fallback]\n  preset = \"cursor\""
1077            );
1078        }
1079        // Named for the env override it answers to, SPAR_<NAME>_FALLBACK_BIN,
1080        // and so a log line says which agent stood in for which.
1081        let backup = build_spec(&format!("{name}-fallback"), &raw)?;
1082        if backup.fallback.is_some() {
1083            bail!(
1084                "agent '{name}': a fallback may not have a fallback of its own. Each one costs \
1085                 another full timeout on a call that has already failed once."
1086            );
1087        }
1088        spec.fallback = Some(Box::new(backup));
1089    }
1090
1091    Ok(spec)
1092}
1093
1094// ---------------------------------------------------------------------------
1095// Loading
1096// ---------------------------------------------------------------------------
1097
1098/// One option the parser accepts, with the value it takes when unset.
1099#[derive(Debug, Clone)]
1100pub struct OptionInfo {
1101    pub section: &'static str,
1102    pub key: String,
1103    pub default: String,
1104}
1105
1106/// Every option a config file may set, with its default.
1107///
1108/// Derived from the defaults themselves rather than written out by hand, so an
1109/// option added to the code cannot go missing here. That is what lets `doctor`
1110/// tell somebody upgrading which settings are new since they wrote their file.
1111pub fn known_options() -> Vec<OptionInfo> {
1112    fn lines<T: Serialize>(section: &'static str, value: &T) -> Vec<OptionInfo> {
1113        toml::to_string(value)
1114            .unwrap_or_default()
1115            .lines()
1116            .filter_map(|line| line.split_once(" = "))
1117            .map(|(key, default)| OptionInfo {
1118                section,
1119                key: key.trim().to_string(),
1120                default: default.trim().to_string(),
1121            })
1122            .collect()
1123    }
1124    let mut out = lines("loop", &LoopCfg::default());
1125    out.extend(lines("style", &StyleCfg::default()));
1126    out.extend(lines(
1127        "loop.effort_schedule",
1128        &EffortSchedule {
1129            round_1: Some("high".into()),
1130            rest: Some("low".into()),
1131            triage: Some("low".into()),
1132            implement: Some("high".into()),
1133            review_1: Some("high".into()),
1134            review_rest: Some("low".into()),
1135            respond: Some("high".into()),
1136            close: Some("low".into()),
1137            screen: Some("low".into()),
1138            checkin: Some("high".into()),
1139            split: Some("high".into()),
1140            brainstorm: Some("high".into()),
1141            recheck: Some("low".into()),
1142        },
1143    ));
1144    out.extend(lines("listen", &ListenCfg::default()));
1145    out
1146}
1147
1148/// Whether a config file mentions an option at all, set or commented out.
1149pub fn mentions(config_text: &str, key: &str) -> bool {
1150    config_text.lines().any(|line| {
1151        let bare = line.trim_start().trim_start_matches('#').trim_start();
1152        bare.starts_with(&format!("{key} ")) || bare.starts_with(&format!("{key}="))
1153    })
1154}
1155
1156/// Options this config file has never heard of, which is what somebody who
1157/// upgraded wants to know.
1158pub fn unmentioned_options(config_text: &str) -> Vec<OptionInfo> {
1159    known_options()
1160        .into_iter()
1161        .filter(|o| !mentions(config_text, &o.key))
1162        .collect()
1163}
1164
1165pub const CONFIG_NAMES: &[&str] = &["spar.toml", ".spar.toml"];
1166
1167/// Find a config: an explicit path, then the working directory, then
1168/// `~/.config/spar/spar.toml`.
1169pub fn find_config(explicit: Option<&Path>) -> Result<Option<PathBuf>> {
1170    if let Some(path) = explicit {
1171        if !path.is_file() {
1172            bail!("config not found: {}", path.display());
1173        }
1174        return Ok(Some(path.to_path_buf()));
1175    }
1176    for name in CONFIG_NAMES {
1177        let path = PathBuf::from(name);
1178        if path.is_file() {
1179            return Ok(Some(path));
1180        }
1181    }
1182    if let Some(home) = home_dir() {
1183        let path = home.join(".config").join("spar").join("spar.toml");
1184        if path.is_file() {
1185            return Ok(Some(path));
1186        }
1187    }
1188    Ok(None)
1189}
1190
1191pub fn load(explicit: Option<&Path>) -> Result<Config> {
1192    let Some(path) = find_config(explicit)? else {
1193        bail!(
1194            "no spar.toml found. Run `spar init` to generate one from the CLIs you have installed."
1195        );
1196    };
1197    let text = std::fs::read_to_string(&path)
1198        .map_err(|e| spar_err!("could not read {}: {e}", path.display()))?;
1199    let mut cfg = parse(&text).map_err(|e| spar_err!("{}: {e}", path.display()))?;
1200    cfg.source = Some(path);
1201    Ok(cfg)
1202}
1203
1204pub fn parse(text: &str) -> Result<Config> {
1205    let raw: RawConfig = toml::from_str(text)?;
1206
1207    if raw.agents.len() != 2 {
1208        bail!(
1209            "spar needs exactly two agents, found {}. The whole design is one reviewing the other.",
1210            raw.agents.len()
1211        );
1212    }
1213
1214    let mut agents = Vec::new();
1215    for (name, value) in raw.agents.iter() {
1216        agents.push(build_spec(name, value)?);
1217    }
1218
1219    let loop_cfg = raw.loop_cfg.unwrap_or_default();
1220    let style = raw.style.unwrap_or_default().to_style();
1221    let listen = raw.listen.unwrap_or_default();
1222
1223    if loop_cfg.max_rounds == 0 {
1224        bail!("max_rounds must be at least 1");
1225    }
1226    if listen.settle > listen.max_wait {
1227        bail!(
1228            "[listen] settle ({}) cannot be longer than max_wait ({}): an item that kept \
1229             changing would never be acted on. Raise max_wait or lower settle.",
1230            listen.settle,
1231            listen.max_wait
1232        );
1233    }
1234    if listen.interval == 0 || listen.sweep == 0 {
1235        bail!(
1236            "[listen] interval and sweep are seconds between polls and must be at least 1. \
1237             Polling never goes below 15 seconds whatever they say."
1238        );
1239    }
1240    // A draft cannot be merged, so merging one means promoting it first, which
1241    // is the one thing `always` asks spar not to do. Refusing is better than
1242    // picking a winner: either setting alone is coherent and only somebody who
1243    // set both can say which they meant.
1244    if loop_cfg.auto_merge && loop_cfg.drafts == Drafts::Always {
1245        bail!(
1246            "auto_merge cannot be on with drafts = \"always\": merging a draft means marking it \
1247             ready, which is what \"always\" asks spar not to do. Use drafts = \"until_approved\" \
1248             to have it promoted when the review converges, or turn auto_merge off."
1249        );
1250    }
1251
1252    // "alternate" is not an agent name, it is a policy: whoever is not the
1253    // agent that wrote the last first draft. Roles alternate within a pull
1254    // request and never between them, so over a queue of twenty issues one
1255    // model writes every first draft and the other reviews every one of them.
1256    // A model's blind spots as an author are systematic, and the ones the pair
1257    // shares go through every time.
1258    let alternate = loop_cfg
1259        .first_implementor
1260        .as_deref()
1261        .is_some_and(|name| name.trim().eq_ignore_ascii_case("alternate"));
1262    let first = match &loop_cfg.first_implementor {
1263        Some(name) if !name.trim().is_empty() && !alternate => name.trim().to_string(),
1264        _ => agents[0].name.clone(),
1265    };
1266    if !agents.iter().any(|a| a.name == first) {
1267        bail!(
1268            "first_implementor '{first}' is not a configured agent ({})",
1269            agents
1270                .iter()
1271                .map(|a| a.name.as_str())
1272                .collect::<Vec<_>>()
1273                .join(", ")
1274        );
1275    }
1276
1277    Ok(Config {
1278        agents,
1279        loop_cfg,
1280        style,
1281        listen,
1282        first_implementor: first,
1283        alternate_first: alternate,
1284        source: None,
1285    })
1286}
1287
1288/// Resolve a configured search path, expanding a leading `~`.
1289pub fn resolve_search_path(raw: &str) -> PathBuf {
1290    expand_tilde(raw)
1291}
1292
1293#[cfg(test)]
1294mod tests {
1295    use super::*;
1296
1297    const TWO_AGENTS: &str = r#"
1298[agents.claude]
1299preset = "claude"
1300model = "fable"
1301
1302[agents.codex]
1303preset = "codex"
1304model = "gpt-5.6-sol"
1305"#;
1306
1307    // -- fallback --------------------------------------------------------
1308
1309    #[test]
1310    fn a_fallback_is_a_whole_agent_with_its_own_preset() {
1311        let text = format!(
1312            "{TWO_AGENTS}\n[agents.codex.fallback]\npreset = \"cursor\"\nmodel = \"kimi-k3\"\n"
1313        );
1314        let cfg = parse(&text).expect("parses");
1315        // Still a pair. A backup is not a third opinion.
1316        assert_eq!(2, cfg.agents.len());
1317        let codex = cfg.spec("codex").expect("codex");
1318        let backup = codex.fallback.as_ref().expect("fallback");
1319        assert_eq!("codex-fallback", backup.name);
1320        assert_eq!(Some("kimi-k3"), backup.model.as_deref());
1321        assert_eq!(
1322            Some(&CommandPart::One("cursor-agent".into())),
1323            backup.command.first()
1324        );
1325    }
1326
1327    #[test]
1328    fn the_agent_without_a_fallback_does_not_grow_one() {
1329        let cfg = parse(TWO_AGENTS).expect("parses");
1330        assert!(cfg.agents.iter().all(|a| a.fallback.is_none()));
1331    }
1332
1333    #[test]
1334    fn a_fallback_may_not_have_one_of_its_own() {
1335        let text = format!(
1336            "{TWO_AGENTS}\n[agents.codex.fallback]\npreset = \"cursor\"\n\
1337             [agents.codex.fallback.fallback]\npreset = \"gemini\"\n"
1338        );
1339        let err = parse(&text).expect_err("rejected");
1340        assert!(err.message().contains("may not have a fallback"), "{err}");
1341    }
1342
1343    #[test]
1344    fn a_fallback_written_as_a_string_says_what_it_should_be() {
1345        let text = "[agents.claude]\npreset = \"claude\"\n\n\
1346                    [agents.codex]\npreset = \"codex\"\nfallback = \"cursor\"\n";
1347        let err = parse(text).expect_err("rejected");
1348        assert!(err.message().contains("[agents.codex.fallback]"), "{err}");
1349    }
1350
1351    /// A block that names one setting keeps the defaults for every setting it
1352    /// did not name. That is what the container level serde default buys: each
1353    /// field used to carry its own default function repeating a number that
1354    /// also lived in `Default`, and the two copies stopped agreeing.
1355    #[test]
1356    fn a_partial_block_keeps_the_defaults_it_did_not_name() {
1357        let text = format!("{TWO_AGENTS}\n[loop]\nmax_rounds = 9\n\n[style]\nterse = false\n");
1358        let cfg = parse(&text).expect("parses");
1359
1360        assert_eq!(9, cfg.loop_cfg.max_rounds);
1361        assert_eq!(LoopCfg::default().followups, cfg.loop_cfg.followups);
1362        assert_eq!(LoopCfg::default().close_skipped, cfg.loop_cfg.close_skipped);
1363
1364        assert!(!cfg.style.terse);
1365        assert_eq!(Style::default().max_body_chars, cfg.style.max_body_chars);
1366        assert_eq!(Style::default().max_title_chars, cfg.style.max_title_chars);
1367    }
1368
1369    /// The budgets are decided in `Style` and read from there by the config
1370    /// layer. When they were written out in both places they drifted, and the
1371    /// generated config offered the older set for months.
1372    #[test]
1373    fn the_config_layer_does_not_keep_its_own_copy_of_the_budgets() {
1374        assert_eq!(Style::default(), StyleCfg::default().to_style());
1375    }
1376
1377    // -- drafts ------------------------------------------------------------
1378
1379    #[test]
1380    fn pull_requests_are_not_drafts_unless_asked_for() {
1381        assert_eq!(Drafts::Never, parse(TWO_AGENTS).unwrap().loop_cfg.drafts);
1382    }
1383
1384    #[test]
1385    fn each_draft_setting_parses() {
1386        for (text, want) in [
1387            ("never", Drafts::Never),
1388            ("until_approved", Drafts::UntilApproved),
1389            ("always", Drafts::Always),
1390        ] {
1391            let cfg = parse(&format!("{TWO_AGENTS}\n[loop]\ndrafts = \"{text}\"\n"))
1392                .unwrap_or_else(|e| panic!("{text}: {e}"));
1393            assert_eq!(want, cfg.loop_cfg.drafts, "{text}");
1394        }
1395    }
1396
1397    /// Merging a draft means marking it ready, which is the one thing `always`
1398    /// asks spar not to do. Either setting alone is coherent, so refusing beats
1399    /// picking a winner between them.
1400    #[test]
1401    fn auto_merge_and_a_permanent_draft_are_refused_together() {
1402        let text = format!("{TWO_AGENTS}\n[loop]\nauto_merge = true\ndrafts = \"always\"\n");
1403        let err = parse(&text).expect_err("refused");
1404        assert!(err.message().contains("auto_merge"), "{err}");
1405        assert!(
1406            err.message().contains("until_approved"),
1407            "says the way out: {err}"
1408        );
1409    }
1410
1411    /// The pairing that does make sense: the draft clears when the review
1412    /// converges, and then it can merge.
1413    #[test]
1414    fn auto_merge_is_fine_with_a_draft_that_clears() {
1415        let text =
1416            format!("{TWO_AGENTS}\n[loop]\nauto_merge = true\ndrafts = \"until_approved\"\n");
1417        assert!(parse(&text).is_ok());
1418    }
1419
1420    #[test]
1421    fn every_builtin_preset_parses() {
1422        for (name, _) in BUILTIN_PRESETS {
1423            let value = load_preset(name).unwrap_or_else(|e| panic!("{name}: {e}"));
1424            assert!(value.get("command").is_some(), "{name} has no command");
1425        }
1426    }
1427
1428    #[test]
1429    fn every_builtin_preset_builds_a_spec() {
1430        for (name, _) in BUILTIN_PRESETS {
1431            let raw = parse_document(&format!("preset = \"{name}\""), "test").unwrap();
1432            build_spec(name, &raw).unwrap_or_else(|e| panic!("{name}: {e}"));
1433        }
1434    }
1435
1436    /// `--allowedTools` is variadic, so the separate form swallows the
1437    /// following positional prompt unless another flag happens to sit between
1438    /// them. The equals form is not cosmetic.
1439    #[test]
1440    fn claude_preset_uses_the_equals_form_for_allowed_tools() {
1441        let spec = build_spec(
1442            "claude",
1443            &parse_document("preset = \"claude\"", "test").unwrap(),
1444        )
1445        .unwrap();
1446        let flat: Vec<&String> = spec.command.iter().flat_map(|p| p.args()).collect();
1447        assert!(flat.iter().any(|a| a.starts_with("--allowedTools=")));
1448        assert!(!flat.iter().any(|a| a.as_str() == "--allowedTools"));
1449    }
1450
1451    #[test]
1452    fn codex_preset_declares_where_its_answer_lives() {
1453        let spec = build_spec(
1454            "codex",
1455            &parse_document("preset = \"codex\"", "test").unwrap(),
1456        )
1457        .unwrap();
1458        assert_eq!(OutputMode::Jsonl, spec.output);
1459        assert_eq!(Some("item.text"), spec.message_path.as_deref());
1460        assert!(!spec.message_match.is_empty());
1461    }
1462
1463    /// ChatGPT 26.924 moved the bundled CLI from `Resources/codex` to
1464    /// `Resources/codex-cli/bin/codex`. An app not yet updated still has the
1465    /// old one, so both are searched, the current layout first.
1466    #[test]
1467    fn codex_preset_looks_where_either_chatgpt_layout_keeps_the_cli() {
1468        let spec = build_spec(
1469            "codex",
1470            &parse_document("preset = \"codex\"", "test").unwrap(),
1471        )
1472        .unwrap();
1473        let at = |path: &str| spec.search_paths.iter().position(|p| p == path);
1474        let current = at("/Applications/ChatGPT.app/Contents/Resources/codex-cli/bin");
1475        let older = at("/Applications/ChatGPT.app/Contents/Resources");
1476        assert!(current.is_some(), "{:?}", spec.search_paths);
1477        assert!(older.is_some(), "{:?}", spec.search_paths);
1478        assert!(current < older, "{:?}", spec.search_paths);
1479    }
1480
1481    #[test]
1482    fn agent_order_follows_declaration_order() {
1483        let cfg = parse(TWO_AGENTS).unwrap();
1484        assert_eq!(vec!["claude", "codex"], cfg.agent_names());
1485        assert_eq!("claude", cfg.first_implementor);
1486    }
1487
1488    #[test]
1489    fn other_alternates() {
1490        let cfg = parse(TWO_AGENTS).unwrap();
1491        assert_eq!("codex", cfg.other("claude"));
1492        assert_eq!("claude", cfg.other("codex"));
1493    }
1494
1495    #[test]
1496    fn a_config_block_overrides_one_preset_field() {
1497        let cfg = parse(TWO_AGENTS).unwrap();
1498        let claude = cfg.spec("claude").unwrap();
1499        assert_eq!(Some("fable"), claude.model.as_deref());
1500        assert!(claude.command.len() > 1, "the preset command survived");
1501    }
1502
1503    #[test]
1504    fn exactly_two_agents_are_required() {
1505        let one = "[agents.claude]\npreset = \"claude\"\n";
1506        assert!(parse(one).unwrap_err().to_string().contains("exactly two"));
1507    }
1508
1509    #[test]
1510    fn an_unknown_agent_option_is_named() {
1511        let text = "[agents.a]\ncommand = [\"x\"]\nwidget = 3\n[agents.b]\ncommand = [\"y\"]\n";
1512        let err = parse(text).unwrap_err().to_string();
1513        assert!(err.contains("widget"), "{err}");
1514    }
1515
1516    #[test]
1517    fn an_unknown_loop_option_is_named() {
1518        let text = format!("{TWO_AGENTS}\n[loop]\nmax_round = 4\n");
1519        let err = parse(&text).unwrap_err().to_string();
1520        assert!(err.contains("max_round"), "{err}");
1521    }
1522
1523    #[test]
1524    fn an_unknown_listen_option_is_named() {
1525        let text = format!("{TWO_AGENTS}\n[listen]\ninterval_secs = 30\n");
1526        let err = parse(&text).unwrap_err().to_string();
1527        assert!(err.contains("interval_secs"), "{err}");
1528    }
1529
1530    #[test]
1531    fn a_listen_block_keeps_the_defaults_it_did_not_name() {
1532        let text = format!("{TWO_AGENTS}\n[listen]\nsweep = 30\n");
1533        let cfg = parse(&text).expect("parses");
1534        assert_eq!(30, cfg.listen.sweep);
1535        assert_eq!(ListenCfg::default().interval, cfg.listen.interval);
1536        assert_eq!(ListenCfg::default().settle, cfg.listen.settle);
1537        assert_eq!(OwnPr::Checkin, cfg.listen.on_own_pr);
1538        assert!(cfg.listen.verdicts);
1539
1540        let bare = parse(TWO_AGENTS).unwrap();
1541        assert_eq!(60, bare.listen.interval);
1542        assert_eq!(300, bare.listen.sweep);
1543        assert_eq!(120, bare.listen.settle);
1544        assert_eq!(900, bare.listen.max_wait);
1545        assert_eq!(5, bare.listen.max_rechecks);
1546        assert_eq!(ReviewOrIgnore::Review, bare.listen.on_review_requested);
1547        assert_eq!(ReviewOrIgnore::Review, bare.listen.on_assigned);
1548    }
1549
1550    #[test]
1551    fn settle_longer_than_max_wait_is_refused_with_a_reason() {
1552        let text = format!("{TWO_AGENTS}\n[listen]\nsettle = 1000\nmax_wait = 900\n");
1553        let err = parse(&text).unwrap_err().to_string();
1554        assert!(err.contains("settle"), "{err}");
1555        assert!(err.contains("Raise max_wait"), "{err}");
1556
1557        let text = format!("{TWO_AGENTS}\n[listen]\ninterval = 0\n");
1558        let err = parse(&text).unwrap_err().to_string();
1559        assert!(err.contains("at least 1"), "{err}");
1560    }
1561
1562    #[test]
1563    fn each_listen_action_word_parses() {
1564        for (text, want) in [
1565            ("review", ReviewOrIgnore::Review),
1566            ("ignore", ReviewOrIgnore::Ignore),
1567        ] {
1568            let cfg = parse(&format!(
1569                "{TWO_AGENTS}\n[listen]\non_review_requested = \"{text}\"\non_assigned = \"{text}\"\n"
1570            ))
1571            .unwrap();
1572            assert_eq!(want, cfg.listen.on_review_requested);
1573            assert_eq!(want, cfg.listen.on_assigned);
1574            assert_eq!(text, want.to_string());
1575        }
1576        for (text, want) in [
1577            ("checkin", OwnPr::Checkin),
1578            ("reply", OwnPr::Reply),
1579            ("ignore", OwnPr::Ignore),
1580        ] {
1581            let cfg = parse(&format!("{TWO_AGENTS}\n[listen]\non_own_pr = \"{text}\"\n")).unwrap();
1582            assert_eq!(want, cfg.listen.on_own_pr);
1583            assert_eq!(text, want.to_string());
1584        }
1585        let err = parse(&format!("{TWO_AGENTS}\n[listen]\non_own_pr = \"push\"\n"))
1586            .unwrap_err()
1587            .to_string();
1588        assert!(err.contains("on_own_pr") || err.contains("push"), "{err}");
1589    }
1590
1591    #[test]
1592    fn a_recheck_reads_its_own_key_before_review_rest_and_falls_back_to_it() {
1593        let text = format!(
1594            "{TWO_AGENTS}\n[loop.effort_schedule]\nreview_rest = \"low\"\nrecheck = \"high\"\n"
1595        );
1596        let cfg = parse(&text).unwrap();
1597        let spec = cfg.spec("claude").unwrap();
1598        assert_eq!(
1599            Some("high".to_string()),
1600            cfg.effort_for(spec, Call::Recheck)
1601        );
1602
1603        let text = format!("{TWO_AGENTS}\n[loop.effort_schedule]\nreview_rest = \"low\"\n");
1604        let cfg = parse(&text).unwrap();
1605        let spec = cfg.spec("claude").unwrap();
1606        assert_eq!(Some("low".to_string()), cfg.effort_for(spec, Call::Recheck));
1607
1608        let text = format!(
1609            "{TWO_AGENTS}\n[loop.effort_schedule]\nround_1 = \"ultra\"\nrest = \"medium\"\n"
1610        );
1611        let cfg = parse(&text).unwrap();
1612        let spec = cfg.spec("claude").unwrap();
1613        assert_eq!(
1614            Some("medium".to_string()),
1615            cfg.effort_for(spec, Call::Recheck)
1616        );
1617    }
1618
1619    #[test]
1620    fn every_call_kind_is_in_every() {
1621        let every = Call::every();
1622        assert_eq!(11, every.len());
1623        assert!(every.contains(&Call::Recheck));
1624        assert_eq!("recheck", Call::Recheck.key());
1625    }
1626
1627    #[test]
1628    fn an_agent_with_no_command_and_no_preset_is_rejected() {
1629        let text = "[agents.a]\nmodel = \"x\"\n[agents.b]\ncommand = [\"y\"]\n";
1630        let err = parse(text).unwrap_err().to_string();
1631        assert!(err.contains("no command and no preset"), "{err}");
1632    }
1633
1634    #[test]
1635    fn jsonl_without_a_message_path_is_rejected() {
1636        let text =
1637            "[agents.a]\ncommand = [\"x\"]\noutput = \"jsonl\"\n[agents.b]\ncommand = [\"y\"]\n";
1638        let err = parse(text).unwrap_err().to_string();
1639        assert!(err.contains("message_path"), "{err}");
1640    }
1641
1642    /// One agent wrote every first draft, so half the pair's diversity went
1643    /// unused: a model's blind spots as an author are systematic, and the ones
1644    /// the two share go through every time.
1645    /// The one claim a report makes that nothing else checks.
1646    #[test]
1647    fn a_check_is_read_as_an_argv_either_way_it_is_written() {
1648        let line = format!("{TWO_AGENTS}\n[loop]\ncheck = \"cargo test --all\"\n");
1649        let cfg = parse(&line).unwrap();
1650        assert!(cfg.loop_cfg.check.is_set());
1651        assert_eq!(vec!["cargo", "test", "--all"], cfg.loop_cfg.check.argv());
1652        assert_eq!("cargo test --all", cfg.loop_cfg.check.describe());
1653
1654        let listed =
1655            format!("{TWO_AGENTS}\n[loop]\ncheck = [\"npm\", \"run\", \"test -- --ci\"]\n");
1656        let cfg = parse(&listed).unwrap();
1657        assert_eq!(
1658            vec!["npm", "run", "test -- --ci"],
1659            cfg.loop_cfg.check.argv(),
1660            "a list is taken as it is, spaces and all"
1661        );
1662
1663        // Unset is the default, and runs nothing.
1664        let bare = parse(TWO_AGENTS).unwrap();
1665        assert!(!bare.loop_cfg.check.is_set());
1666        assert!(bare.loop_cfg.check.argv().is_empty());
1667    }
1668
1669    #[test]
1670    fn alternating_swaps_the_author_from_issue_to_issue() {
1671        let text = format!("{TWO_AGENTS}\n[loop]\nfirst_implementor = \"alternate\"\n");
1672        let cfg = parse(&text).unwrap();
1673
1674        assert!(cfg.alternate_first);
1675        assert_eq!(
1676            "claude", cfg.first_implementor,
1677            "declaration order still leads"
1678        );
1679        assert_eq!("claude", cfg.first_implementor_for(0));
1680        assert_eq!("codex", cfg.first_implementor_for(1));
1681        assert_eq!("claude", cfg.first_implementor_for(2));
1682        assert!(cfg.first_implementor_policy().contains("alternating"));
1683    }
1684
1685    /// Naming an agent still pins it, which is what --first does for a run.
1686    #[test]
1687    fn a_named_first_implementor_never_swaps() {
1688        let text = format!("{TWO_AGENTS}\n[loop]\nfirst_implementor = \"codex\"\n");
1689        let cfg = parse(&text).unwrap();
1690        assert!(!cfg.alternate_first);
1691        for nth in 0..4 {
1692            assert_eq!("codex", cfg.first_implementor_for(nth));
1693        }
1694        assert_eq!("codex", cfg.first_implementor_policy());
1695    }
1696
1697    #[test]
1698    fn first_implementor_must_name_a_configured_agent() {
1699        let text = format!("{TWO_AGENTS}\n[loop]\nfirst_implementor = \"nobody\"\n");
1700        let err = parse(&text).unwrap_err().to_string();
1701        assert!(err.contains("not a configured agent"), "{err}");
1702    }
1703
1704    #[test]
1705    fn defaults_are_the_conservative_ones() {
1706        let cfg = parse(TWO_AGENTS).unwrap();
1707        assert!(
1708            !cfg.loop_cfg.auto_merge,
1709            "auto_merge must be off by default"
1710        );
1711        assert!(cfg.loop_cfg.worktrees);
1712        assert!(
1713            !cfg.loop_cfg.file_nits,
1714            "a filed nit is somebody else's triage queue"
1715        );
1716        assert_eq!(3, cfg.loop_cfg.max_rounds);
1717        assert_eq!(
1718            Followups::Local,
1719            cfg.loop_cfg.followups,
1720            "the tracker is somebody's queue; the default must not write to it"
1721        );
1722        assert!(
1723            !cfg.loop_cfg.file_non_blocking,
1724            "a suggestion is not a tracker item"
1725        );
1726        assert_eq!(StateStore::Local, cfg.loop_cfg.state_store);
1727        assert!(cfg.style.terse);
1728    }
1729
1730    #[test]
1731    fn effort_schedule_splits_round_one_from_the_rest() {
1732        let text =
1733            format!("{TWO_AGENTS}\n[loop.effort_schedule]\nround_1 = \"ultra\"\nrest = \"high\"\n");
1734        let cfg = parse(&text).unwrap();
1735        let spec = cfg.spec("claude").unwrap();
1736        assert_eq!(Some("ultra".into()), cfg.effort_for_round(spec, 1));
1737        assert_eq!(Some("high".into()), cfg.effort_for_round(spec, 2));
1738        assert_eq!(Some("high".into()), cfg.effort_for_round(spec, 9));
1739    }
1740
1741    /// The schedule is one string handed to whichever agent holds the round,
1742    /// and the two CLIs do not share a vocabulary.
1743    ///
1744    /// The README's own example pairs round_1 = "ultra" with a claude agent at
1745    /// effort = "high", and ultra is not a value the claude preset accepts, so
1746    /// the first review failed at the CLI whenever claude reviewed first.
1747    #[test]
1748    fn an_agent_can_carry_its_own_schedule_in_its_own_words() {
1749        let text = format!(
1750            "{TWO_AGENTS}\n[agents.claude.effort_schedule]\nreview_1 = \"xhigh\"\n\n\
1751             [loop.effort_schedule]\nreview_1 = \"ultra\"\n"
1752        );
1753        let cfg = parse(&text).unwrap();
1754        assert_eq!(
1755            Some("xhigh".into()),
1756            cfg.effort_for(cfg.spec("claude").unwrap(), Call::Review(1)),
1757            "the agent's own schedule has to win"
1758        );
1759        assert_eq!(
1760            Some("ultra".into()),
1761            cfg.effort_for(cfg.spec("codex").unwrap(), Call::Review(1))
1762        );
1763    }
1764
1765    /// Every call used to read round_1 or rest by a round number most of them
1766    /// do not have, so round_1 = "ultra" put triage over the whole queue, the
1767    /// implement call and the follow-up screen at ultra too.
1768    #[test]
1769    fn each_kind_of_call_reads_its_own_key_and_falls_back_to_the_old_pair() {
1770        let text = format!(
1771            "{TWO_AGENTS}\n[loop.effort_schedule]\nround_1 = \"ultra\"\nrest = \"low\"\n\
1772             triage = \"minimal\"\n"
1773        );
1774        let cfg = parse(&text).unwrap();
1775        let spec = cfg.spec("claude").unwrap();
1776
1777        assert_eq!(Some("minimal".into()), cfg.effort_for(spec, Call::Triage));
1778        // No key of its own: exactly what the two key schedule did.
1779        for call in [Call::Implement, Call::Review(1), Call::Screen] {
1780            assert_eq!(Some("ultra".into()), cfg.effort_for(spec, call), "{call:?}");
1781        }
1782        for call in [Call::Review(2), Call::Close, Call::Respond(3)] {
1783            assert_eq!(Some("low".into()), cfg.effort_for(spec, call), "{call:?}");
1784        }
1785    }
1786
1787    #[test]
1788    fn effort_falls_back_to_the_agents_own_setting() {
1789        let text = format!("{TWO_AGENTS}effort = \"low\"\n");
1790        let cfg = parse(&text).unwrap();
1791        let spec = cfg.spec("codex").unwrap();
1792        assert_eq!(Some("low".into()), cfg.effort_for_round(spec, 1));
1793    }
1794
1795    #[test]
1796    fn an_unset_model_and_an_empty_model_normalise_the_same() {
1797        let a = AgentSpec {
1798            name: "a".into(),
1799            command: vec![CommandPart::One("x".into())],
1800            model: None,
1801            effort: None,
1802            effort_schedule: EffortSchedule::default(),
1803            output: OutputMode::Text,
1804            message_match: BTreeMap::new(),
1805            message_path: None,
1806            search_paths: vec![],
1807            system_via: SystemVia::Prompt,
1808            timeout: 60,
1809            fallback: None,
1810            models: vec![],
1811            efforts: vec![],
1812            options_note: None,
1813        };
1814        let b = AgentSpec {
1815            model: Some("  ".into()),
1816            ..a.clone()
1817        };
1818        assert_eq!(a.model_key(), b.model_key());
1819    }
1820
1821    #[test]
1822    fn max_rounds_zero_is_rejected() {
1823        let text = format!("{TWO_AGENTS}\n[loop]\nmax_rounds = 0\n");
1824        assert!(parse(&text).is_err());
1825    }
1826
1827    #[test]
1828    fn an_inline_command_needs_no_preset() {
1829        let text = r#"
1830[agents.custom]
1831command = ["mytool", ["-m", "{model}"], "--prompt", "{prompt}"]
1832output = "text"
1833
1834[agents.other]
1835command = ["othertool", "{prompt}"]
1836"#;
1837        let cfg = parse(text).unwrap();
1838        assert_eq!(4, cfg.spec("custom").unwrap().command.len());
1839    }
1840
1841    #[test]
1842    fn style_budgets_are_configurable() {
1843        let text = format!("{TWO_AGENTS}\n[style]\nterse = false\nmax_detail_chars = 40\n");
1844        let cfg = parse(&text).unwrap();
1845        assert!(!cfg.style.terse);
1846        assert_eq!(40, cfg.style.max_detail_chars);
1847    }
1848}