retcon 1.1.0

Turn messy development commits into clean, logical history. Because you knew what you were doing the whole time.
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

//! History specification types.
//!
//! The spec is a TOML file that serves as both the plan AND execution state.
//! As retcon works, it appends to the `history` field of each commit.

use serde::{Deserialize, Serialize};

/// The complete history specification.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct HistorySpec {
    /// Branch containing all changes (the messy history)
    pub source: String,

    /// Upstream branch this will merge into (e.g., `origin/main`)
    pub remote: String,

    /// New branch to create with reconstructed history
    pub cleaned: String,

    /// Commits to create, in order
    #[serde(rename = "commit")]
    pub commits: Vec<CommitSpec>,
}

/// A single logical commit to reconstruct.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct CommitSpec {
    /// The commit message (first line)
    pub message: String,

    /// Guidance for the LLM on what changes belong in this commit
    #[serde(default)]
    pub hints: Option<String>,

    /// Execution history - herodotus appends entries as it works
    #[serde(default)]
    pub history: Vec<HistoryEntry>,
}

/// An entry in a commit's execution history.
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "snake_case")]
pub enum HistoryEntry {
    /// Execution started on this commit (may have partial changes in working dir)
    Started,

    /// A commit was created (main or WIP fix)
    CommitCreated(String),

    /// LLM assessed it cannot proceed - needs human intervention
    Stuck(String),

    /// Human resolved a stuck state - describes what changed
    Resolved(String),

    /// Pre-configured response to send to the LLM on stuck - auto-resolves
    Response(String),

    /// This logical commit is done
    Complete,
}

impl HistorySpec {
    /// Parse a history spec from TOML content.
    pub fn from_toml(content: &str) -> Result<Self, toml::de::Error> {
        toml::from_str(content)
    }

    /// Serialize the spec back to TOML.
    pub fn to_toml(&self) -> Result<String, toml::ser::Error> {
        toml::to_string_pretty(self)
    }

    /// Find the index of the first commit that isn't complete.
    ///
    /// Returns `None` if all commits are complete.
    #[must_use]
    pub fn next_pending_commit(&self) -> Option<usize> {
        self.commits.iter().position(|c| !c.is_complete())
    }
}

impl CommitSpec {
    /// Check if this commit is complete.
    #[must_use]
    pub fn is_complete(&self) -> bool {
        matches!(self.history.last(), Some(HistoryEntry::Complete))
    }

    /// Check if this commit is stuck and awaiting human resolution.
    ///
    /// Returns `true` if the last entry is `Stuck`. Returns `false` if
    /// the human has added a `Resolved` entry after the `Stuck`.
    #[must_use]
    pub fn is_stuck(&self) -> bool {
        matches!(self.history.last(), Some(HistoryEntry::Stuck(_)))
    }

    /// Check if this commit was started but interrupted (e.g., Ctrl-C).
    #[must_use]
    pub fn is_started(&self) -> bool {
        matches!(self.history.last(), Some(HistoryEntry::Started))
    }

    /// Check if this commit was stuck but has been resolved by a human.
    ///
    /// Returns `true` if the last entry is `Resolved` or `Response`.
    #[must_use]
    pub fn is_resolved(&self) -> bool {
        matches!(
            self.history.last(),
            Some(HistoryEntry::Resolved(_) | HistoryEntry::Response(_))
        )
    }

    /// Get the resolution note if this commit was resolved.
    #[must_use]
    pub fn resolution_note(&self) -> Option<&str> {
        match self.history.last() {
            Some(HistoryEntry::Resolved(note) | HistoryEntry::Response(note)) => Some(note),
            _ => None,
        }
    }
}