tokf 0.2.33

Config-driven CLI tool that compresses command output before it reaches an LLM context
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
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
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216

use std::path::Path;

use crate::runner;

/// Install the Cursor `preToolUse` hook.
///
/// # Errors
///
/// Returns an error if file I/O fails.
pub fn install(global: bool, tokf_bin: &str, install_context: bool) -> anyhow::Result<()> {
    let (hook_dir, cursor_dir) = super::resolve_paths(global, ".cursor")?;
    let hooks_json_path = cursor_dir.join("hooks.json");
    let rules_dir = cursor_dir.join("rules");
    install_to(
        &hook_dir,
        &hooks_json_path,
        &rules_dir,
        tokf_bin,
        install_context,
    )
}

/// Core install logic with explicit paths (testable).
pub(crate) fn install_to(
    hook_dir: &Path,
    hooks_json_path: &Path,
    rules_dir: &Path,
    tokf_bin: &str,
    install_context: bool,
) -> anyhow::Result<()> {
    let hook_script = hook_dir.join("cursor-pre-tool-use.sh");
    super::write_hook_shim(hook_dir, &hook_script, tokf_bin, "--format cursor")?;
    patch_hooks_json(hooks_json_path, &hook_script)?;

    eprintln!("[tokf] Cursor hook installed");
    eprintln!("[tokf]   script: {}", hook_script.display());
    eprintln!("[tokf]   hooks: {}", hooks_json_path.display());

    if install_context {
        super::write_context_doc(rules_dir)?;
        eprintln!("[tokf]   context: {}", rules_dir.join("TOKF.md").display());
    }

    Ok(())
}

/// Patch Cursor hooks.json to register the `beforeShellExecution` hook.
///
/// Cursor uses a different structure from Claude Code / Gemini — each hook entry
/// is a flat object with `type` and `command` at the top level (rather than nested
/// in a `hooks` array), and the event name is `beforeShellExecution` (not
/// `preToolUse`).
fn patch_hooks_json(hooks_json_path: &Path, hook_script: &Path) -> anyhow::Result<()> {
    let mut config: serde_json::Value = if hooks_json_path.exists() {
        let content = std::fs::read_to_string(hooks_json_path)?;
        serde_json::from_str(&content).map_err(|e| {
            anyhow::anyhow!("corrupt hooks.json at {}: {e}", hooks_json_path.display())
        })?
    } else {
        serde_json::json!({ "version": 1 })
    };

    let hook_command = runner::shell_escape(
        hook_script
            .to_str()
            .ok_or_else(|| anyhow::anyhow!("hook script path is not valid UTF-8"))?,
    );

    let tokf_hook_entry = serde_json::json!({
        "type": "command",
        "command": hook_command
    });

    let hooks = config
        .as_object_mut()
        .ok_or_else(|| anyhow::anyhow!("hooks.json is not an object"))?
        .entry("hooks")
        .or_insert_with(|| serde_json::json!({}));

    let before_shell = hooks
        .as_object_mut()
        .ok_or_else(|| anyhow::anyhow!("hooks.json hooks is not an object"))?
        .entry("beforeShellExecution")
        .or_insert_with(|| serde_json::json!([]));

    let arr = before_shell
        .as_array_mut()
        .ok_or_else(|| anyhow::anyhow!("hooks.beforeShellExecution is not an array"))?;

    // Remove existing tokf entries (idempotent install)
    arr.retain(|entry| {
        let is_tokf = entry
            .get("command")
            .and_then(serde_json::Value::as_str)
            .is_some_and(|cmd| cmd.contains("tokf") && cmd.contains("hook"));
        !is_tokf
    });

    arr.push(tokf_hook_entry);

    if let Some(parent) = hooks_json_path.parent() {
        std::fs::create_dir_all(parent)?;
    }
    let json = serde_json::to_string_pretty(&config)?;
    let tmp_path = hooks_json_path.with_extension("json.tmp");
    std::fs::write(&tmp_path, &json)?;
    std::fs::rename(&tmp_path, hooks_json_path)?;

    Ok(())
}

#[cfg(test)]
#[allow(clippy::unwrap_used, clippy::expect_used)]
mod tests {
    use super::*;
    use tempfile::TempDir;

    #[test]
    fn install_to_creates_files() {
        let dir = TempDir::new().unwrap();
        let hook_dir = dir.path().join(".tokf/hooks");
        let hooks_json = dir.path().join(".cursor/hooks.json");
        let rules_dir = dir.path().join(".cursor/rules");

        install_to(&hook_dir, &hooks_json, &rules_dir, "tokf", false).unwrap();

        assert!(hook_dir.join("cursor-pre-tool-use.sh").exists());
        assert!(hooks_json.exists());

        let content = std::fs::read_to_string(&hooks_json).unwrap();
        let value: serde_json::Value = serde_json::from_str(&content).unwrap();
        assert_eq!(value["version"], 1);
        assert!(value["hooks"]["beforeShellExecution"].is_array());
        assert!(
            value["hooks"]["beforeShellExecution"][0]
                .get("matcher")
                .is_none(),
            "beforeShellExecution entries should not have a matcher"
        );
    }

    #[test]
    fn install_to_is_idempotent() {
        let dir = TempDir::new().unwrap();
        let hook_dir = dir.path().join(".tokf/hooks");
        let hooks_json = dir.path().join(".cursor/hooks.json");
        let rules_dir = dir.path().join(".cursor/rules");

        install_to(&hook_dir, &hooks_json, &rules_dir, "tokf", false).unwrap();
        install_to(&hook_dir, &hooks_json, &rules_dir, "tokf", false).unwrap();

        let content = std::fs::read_to_string(&hooks_json).unwrap();
        let value: serde_json::Value = serde_json::from_str(&content).unwrap();
        let arr = value["hooks"]["beforeShellExecution"].as_array().unwrap();
        assert_eq!(arr.len(), 1, "should have one entry after double install");
    }

    #[test]
    fn hook_shim_has_cursor_format_flag() {
        let dir = TempDir::new().unwrap();
        let hook_dir = dir.path().join("hooks");
        let hook_script = hook_dir.join("cursor-pre-tool-use.sh");

        super::super::write_hook_shim(&hook_dir, &hook_script, "tokf", "--format cursor").unwrap();

        let content = std::fs::read_to_string(&hook_script).unwrap();
        assert!(
            content.contains("--format cursor"),
            "shim should use --format cursor, got: {content}"
        );
    }

    #[test]
    fn install_creates_context_doc() {
        let dir = TempDir::new().unwrap();
        let hook_dir = dir.path().join(".tokf/hooks");
        let hooks_json = dir.path().join(".cursor/hooks.json");
        let rules_dir = dir.path().join(".cursor/rules");

        install_to(&hook_dir, &hooks_json, &rules_dir, "tokf", true).unwrap();

        assert!(rules_dir.join("TOKF.md").exists());
        let content = std::fs::read_to_string(rules_dir.join("TOKF.md")).unwrap();
        assert!(content.contains("🗜️"));
    }

    #[test]
    fn install_preserves_existing_hooks() {
        let dir = TempDir::new().unwrap();
        let hooks_json = dir.path().join("hooks.json");
        let hook = dir.path().join("hook.sh");

        std::fs::write(
            &hooks_json,
            r#"{
  "version": 1,
  "hooks": {
    "beforeShellExecution": [
      {
        "type": "command",
        "command": "/other/tool.sh"
      }
    ]
  }
}"#,
        )
        .unwrap();

        patch_hooks_json(&hooks_json, &hook).unwrap();

        let content = std::fs::read_to_string(&hooks_json).unwrap();
        let value: serde_json::Value = serde_json::from_str(&content).unwrap();
        let arr = value["hooks"]["beforeShellExecution"].as_array().unwrap();
        assert_eq!(arr.len(), 2, "should have both hooks");
    }
}