klasp 0.4.0

Block AI coding agents on the same quality gates your humans hit. See https://github.com/klasp-dev/klasp
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

//! Helpers for adoption modes, specifically for the `chain` mode which is
//! not supported in v1 of this feature.
//!
//! See klasp-dev/klasp#97.

use crate::adopt::plan::AdoptionPlan;

/// Returns a multi-line message explaining that `--mode chain` is not yet
/// supported in v1, along with per-gate manual integration instructions.
///
/// The output is suitable for printing to stderr followed by `exit(2)`.
pub fn chain_unsupported_message(plan: &AdoptionPlan) -> String {
    let mut out = String::from(
        "chain mode is not supported in v1; use --mode mirror to write klasp.toml that \
         runs alongside existing gates, or follow the manual integration instructions below.\n",
    );

    let instructions: Vec<&str> = plan
        .findings
        .iter()
        .filter_map(|g| g.manual_chain_instructions.as_deref())
        .collect();

    if !instructions.is_empty() {
        out.push('\n');
        out.push_str("Manual integration instructions:\n");
        for instruction in instructions {
            out.push_str("  ");
            out.push_str(instruction);
            out.push('\n');
        }
    }

    out
}

#[cfg(test)]
mod tests {
    use std::path::PathBuf;

    use super::*;
    use crate::adopt::plan::{
        AdoptionPlan, ChainSupport, DetectedGate, GateType, HookStage, ProposedCheck,
        ProposedCheckSource, TriggerKind,
    };

    fn gate_with_instructions(instructions: &str) -> DetectedGate {
        DetectedGate {
            gate_type: GateType::Husky {
                hook: HookStage::PreCommit,
            },
            source_path: PathBuf::from(".husky/pre-commit"),
            proposed_checks: vec![ProposedCheck {
                name: "husky-pre-commit".to_string(),
                triggers: vec![TriggerKind::Commit],
                timeout_secs: 120,
                source: ProposedCheckSource::Shell {
                    command: "pnpm exec lint-staged".to_string(),
                },
            }],
            chain_support: ChainSupport::ManualOnly,
            manual_chain_instructions: Some(instructions.to_string()),
            warnings: vec![],
        }
    }

    fn gate_without_instructions() -> DetectedGate {
        DetectedGate {
            gate_type: GateType::PreCommitFramework,
            source_path: PathBuf::from(".pre-commit-config.yaml"),
            proposed_checks: vec![ProposedCheck {
                name: "pre-commit".to_string(),
                triggers: vec![TriggerKind::Commit],
                timeout_secs: 120,
                source: ProposedCheckSource::PreCommit {
                    hook_stage: None,
                    config_path: None,
                },
            }],
            chain_support: ChainSupport::ManualOnly,
            manual_chain_instructions: None,
            warnings: vec![],
        }
    }

    #[test]
    fn contains_rejection_sentence() {
        let plan = AdoptionPlan::default();
        let msg = chain_unsupported_message(&plan);
        assert!(msg.contains("chain mode is not supported in v1"));
        assert!(msg.contains("--mode mirror"));
    }

    #[test]
    fn empty_plan_has_no_manual_section() {
        let plan = AdoptionPlan::default();
        let msg = chain_unsupported_message(&plan);
        assert!(!msg.contains("Manual integration instructions:"));
    }

    #[test]
    fn gates_without_instructions_skipped() {
        let plan = AdoptionPlan {
            findings: vec![gate_without_instructions()],
        };
        let msg = chain_unsupported_message(&plan);
        assert!(!msg.contains("Manual integration instructions:"));
    }

    #[test]
    fn gates_with_instructions_shown() {
        let plan = AdoptionPlan {
            findings: vec![gate_with_instructions(
                "Append `klasp gate --agent codex --trigger commit \"$@\"` to .husky/pre-commit",
            )],
        };
        let msg = chain_unsupported_message(&plan);
        assert!(msg.contains("Manual integration instructions:"));
        assert!(msg.contains("Append `klasp gate"));
    }

    #[test]
    fn none_instructions_skipped_mixed() {
        let plan = AdoptionPlan {
            findings: vec![
                gate_without_instructions(),
                gate_with_instructions("Do X manually"),
                gate_without_instructions(),
            ],
        };
        let msg = chain_unsupported_message(&plan);
        assert!(msg.contains("Manual integration instructions:"));
        assert!(msg.contains("Do X manually"));
        // Exactly one instructions section
        assert_eq!(msg.matches("Manual integration instructions:").count(), 1);
    }
}