batless 0.5.0

A non-blocking, LLM-friendly code viewer inspired by bat
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
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284

//! Integration tests that verify documented CLAUDE.md examples work correctly
//! These tests prevent documentation drift by testing actual documented commands

use std::io::Write;
use std::process::Command;
use tempfile::NamedTempFile;

fn create_test_file(content: &str, extension: &str) -> NamedTempFile {
    let mut file = tempfile::Builder::new()
        .suffix(extension)
        .tempfile()
        .unwrap();
    file.write_all(content.as_bytes()).unwrap();
    file
}

fn run_batless(args: &[&str]) -> std::process::Output {
    Command::new(env!("CARGO_BIN_EXE_batless"))
        .args(args)
        .output()
        .expect("Failed to execute batless")
}

#[test]
fn test_basic_file_viewing() {
    let file = create_test_file("fn main() {}\n", ".rs");
    let output = run_batless(&[file.path().to_str().unwrap()]);

    assert!(output.status.success());
    let stdout = String::from_utf8(output.stdout).unwrap();
    assert!(stdout.contains("main"));
}

#[test]
fn test_plain_mode() {
    let file = create_test_file("test content\n", ".txt");

    // Test --mode=plain
    let output = run_batless(&["--mode=plain", file.path().to_str().unwrap()]);
    assert!(output.status.success());

    // Test --plain shorthand
    let output = run_batless(&["--plain", file.path().to_str().unwrap()]);
    assert!(output.status.success());
}

#[test]
fn test_json_mode() {
    let file = create_test_file("test\n", ".txt");
    let output = run_batless(&["--mode=json", file.path().to_str().unwrap()]);

    assert!(output.status.success());
    let stdout = String::from_utf8(output.stdout).unwrap();
    let json: serde_json::Value = serde_json::from_str(&stdout).expect("valid json");

    assert!(json["file"].is_string());
    assert!(json["lines"].is_array());
}

#[test]
fn test_summary_mode() {
    let file = create_test_file("fn main() {}\nstruct User {}\n", ".rs");
    let output = run_batless(&["--mode=summary", file.path().to_str().unwrap()]);

    assert!(output.status.success());
}

#[test]
fn test_max_lines_limit() {
    let file = create_test_file("line1\nline2\nline3\nline4\nline5\n", ".txt");
    let output = run_batless(&["--max-lines=3", file.path().to_str().unwrap()]);

    assert!(output.status.success());
}

#[test]
fn test_max_bytes_limit() {
    let file = create_test_file("test content here\n", ".txt");
    // Need to also set max-lines to avoid conflict
    let output = run_batless(&[
        "--max-bytes=1024",
        "--max-lines=10",
        file.path().to_str().unwrap(),
    ]);

    assert!(output.status.success());
}

#[test]
fn test_combined_limits() {
    let file = create_test_file("line1\nline2\nline3\n", ".txt");
    let output = run_batless(&[
        "--max-lines=100",
        "--max-bytes=5000",
        file.path().to_str().unwrap(),
    ]);

    assert!(output.status.success());
}

#[test]
fn test_ai_profiles() {
    let file = create_test_file("test\n", ".py");

    // Test Claude profile
    let output = run_batless(&["--profile=claude", file.path().to_str().unwrap()]);
    assert!(output.status.success());

    // Test Copilot profile
    let output = run_batless(&["--profile=copilot", file.path().to_str().unwrap()]);
    assert!(output.status.success());

    // Test ChatGPT profile
    let output = run_batless(&["--profile=chatgpt", file.path().to_str().unwrap()]);
    assert!(output.status.success());
}

#[test]
fn test_json_with_tokens() {
    let file = create_test_file("test content\n", ".py");
    let output = run_batless(&[
        "--mode=json",
        "--include-tokens",
        file.path().to_str().unwrap(),
    ]);

    assert!(output.status.success());
    let stdout = String::from_utf8(output.stdout).unwrap();
    let json: serde_json::Value = serde_json::from_str(&stdout).expect("valid json");

    assert!(json["identifiers"].is_array());
    assert!(json["identifier_count"].is_number());
}

#[test]
fn test_json_with_summary() {
    let file = create_test_file("fn main() {}\n", ".rs");
    let output = run_batless(&["--mode=json", "--summary", file.path().to_str().unwrap()]);

    assert!(output.status.success());
    let stdout = String::from_utf8(output.stdout).unwrap();
    let json: serde_json::Value = serde_json::from_str(&stdout).expect("valid json");

    assert!(json["summary_lines"].is_array());
}

#[test]
fn test_language_override() {
    let file = create_test_file("test\n", ".unknown");
    let output = run_batless(&["--language=python", file.path().to_str().unwrap()]);

    assert!(output.status.success());
}

#[test]
fn test_theme_selection() {
    let file = create_test_file("test\n", ".py");
    let output = run_batless(&["--theme=base16-ocean.dark", file.path().to_str().unwrap()]);

    assert!(output.status.success());
}

#[test]
fn test_list_languages() {
    let output = run_batless(&["--list-languages"]);

    assert!(output.status.success());
    let stdout = String::from_utf8(output.stdout).unwrap();
    assert!(stdout.contains("Rust") || stdout.contains("Python"));
}

#[test]
fn test_list_themes() {
    let output = run_batless(&["--list-themes"]);

    assert!(output.status.success());
    let stdout = String::from_utf8(output.stdout).unwrap();
    assert!(!stdout.is_empty());
}

#[test]
fn test_line_numbers_with_plain() {
    let file = create_test_file("line1\nline2\nline3\n", ".txt");

    // Test -n with --plain
    let output = run_batless(&["-n", "--plain", file.path().to_str().unwrap()]);
    assert!(output.status.success());
    let stdout = String::from_utf8(output.stdout).unwrap();
    assert!(stdout.contains("1\t") || stdout.contains("     1\t"));

    // Test --number with --mode=plain
    let output = run_batless(&["--number", "--mode=plain", file.path().to_str().unwrap()]);
    assert!(output.status.success());
    let stdout = String::from_utf8(output.stdout).unwrap();
    assert!(stdout.contains("1\t") || stdout.contains("     1\t"));
}

#[test]
fn test_number_nonblank_with_plain() {
    let file = create_test_file("line1\n\nline3\n", ".txt");

    // Test -b with --plain
    let output = run_batless(&["-b", "--plain", file.path().to_str().unwrap()]);
    assert!(output.status.success());
    let stdout = String::from_utf8(output.stdout).unwrap();

    // Should have line numbers for non-blank lines
    assert!(stdout.contains("1\t") || stdout.contains("     1\t"));
}

#[test]
fn test_line_numbers_without_plain_no_numbers() {
    let file = create_test_file("line1\nline2\n", ".txt");

    // Line numbers without --plain should not show line numbers
    let output = run_batless(&["-n", file.path().to_str().unwrap()]);
    assert!(output.status.success());
    let stdout = String::from_utf8(output.stdout).unwrap();

    // Should NOT contain numbered format
    // (with highlighting, no line numbers are shown)
    assert!(!stdout.contains("     1\tline1"));
}

#[test]
fn test_pattern_flag_rejected() {
    let file = create_test_file("test\n", ".txt");
    let output = run_batless(&["--pattern", "TODO", file.path().to_str().unwrap()]);

    // Should exit with error (exit code 1)
    assert!(!output.status.success());
    let stderr = String::from_utf8(output.stderr).unwrap();
    assert!(stderr.contains("pattern searching") || stderr.contains("search tools"));
}

#[test]
fn test_list_flag_rejected() {
    let output = run_batless(&["--list"]);

    // Should exit with error (exit code 1)
    assert!(!output.status.success());
    let stderr = String::from_utf8(output.stderr).unwrap();
    assert!(stderr.contains("list files") || stderr.contains("file listing"));
}

#[test]
fn test_range_flag_rejected() {
    let file = create_test_file("test\n", ".txt");
    let output = run_batless(&["-r", "10:50", file.path().to_str().unwrap()]);

    // Should error on unknown flag
    assert!(!output.status.success());
    let stderr = String::from_utf8(output.stderr).unwrap();
    assert!(stderr.contains("unexpected argument") || stderr.contains("error"));
}

#[test]
fn test_unbuffered_flag_ignored() {
    let file = create_test_file("test\n", ".txt");
    let output = run_batless(&["--plain", "--unbuffered", file.path().to_str().unwrap()]);

    // Should succeed (flag ignored for compatibility)
    assert!(output.status.success());
}

#[test]
fn test_version_flag() {
    let output = run_batless(&["--version"]);

    assert!(output.status.success());
    let stdout = String::from_utf8(output.stdout).unwrap();
    assert!(stdout.contains("batless"));
}

#[test]
fn test_version_json_flag() {
    let output = run_batless(&["--version-json"]);

    assert!(output.status.success());
    let stdout = String::from_utf8(output.stdout).unwrap();
    let json: serde_json::Value = serde_json::from_str(&stdout).expect("valid json");

    assert!(json["version"].is_string());
}