dircat 0.5.0

High-performance Rust utility that concatenates and displays directory contents, similar to the C++ DirCat.
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

// tests/filter_gitignore.rs

mod common;

use assert_cmd::prelude::*;
use common::dircat_cmd; // Import assert_paths helper if it exists, otherwise keep predicates
use predicates::prelude::*;
use std::fs;
use std::io::Write;
use tempfile::tempdir;

#[test]
fn test_respects_gitignore_by_default() -> Result<(), Box<dyn std::error::Error>> {
    let temp = tempdir()?;
    let gitignore_path = temp.path().join(".gitignore");
    let git_dir = temp.path().join(".git"); // Ensure .git is treated as a directory
    let target_dir = temp.path().join("target");
    fs::create_dir_all(&git_dir)?; // Create .git as a directory
    fs::create_dir_all(&target_dir)?;

    // Create .gitignore
    let mut file = fs::File::create(gitignore_path)?;
    let gitignore_content = "target/\n*.log\n";
    write!(file, "{}", gitignore_content)?;
    drop(file); // Ensure file is closed

    // Create files
    let src_content = "Source";
    let obj_content = "Object";
    let log_content = "Log";
    fs::write(temp.path().join("src.rs"), src_content)?;
    fs::write(target_dir.join("debug.o"), obj_content)?;
    fs::write(temp.path().join("app.log"), log_content)?;

    // Use predicates for direct output check
    dircat_cmd()
        // No -t flag, should respect .gitignore
        .current_dir(temp.path())
        .assert()
        .success()
        .stdout(predicate::str::contains("## File: src.rs")) // Keep source header
        .stdout(predicate::str::contains(src_content)) // Keep source content
        .stdout(predicate::str::contains("## File: target/debug.o").not()) // Ignore target/ header
        .stdout(predicate::str::contains(obj_content).not()) // Ignore target/ content
        .stdout(predicate::str::contains("## File: app.log").not()) // Ignore *.log header
        .stdout(predicate::str::contains(log_content).not()) // Ignore *.log content
        // Also ensure .gitignore and .git are not listed (hidden files ignored by default)
        .stdout(predicate::str::contains("## File: .gitignore").not())
        .stdout(predicate::str::contains("## File: .git").not());

    temp.close()?;
    Ok(())
}

#[test]
fn test_no_gitignore_flag() -> Result<(), Box<dyn std::error::Error>> {
    let temp = tempdir()?;
    let gitignore_path = temp.path().join(".gitignore");
    let git_dir = temp.path().join(".git"); // Ensure .git is treated as a directory
    let target_dir = temp.path().join("target");
    fs::create_dir_all(&git_dir)?; // Create .git as a directory
    fs::create_dir_all(&target_dir)?;

    // Create .gitignore
    let mut file = fs::File::create(gitignore_path)?;
    let gitignore_content = "target/\n*.log\n";
    write!(file, "{}", gitignore_content)?;
    drop(file);

    // Create files
    let src_content = "Source";
    let obj_content = "Object";
    let log_content = "Log";
    fs::write(temp.path().join("src.rs"), src_content)?;
    fs::write(target_dir.join("debug.o"), obj_content)?;
    fs::write(temp.path().join("app.log"), log_content)?;
    // Also write the .gitignore content itself to check if it's included with -t
    fs::write(temp.path().join(".gitignore"), gitignore_content)?;

    dircat_cmd()
        .arg("-t") // Ignore .gitignore AND hidden files
        .current_dir(temp.path())
        .assert()
        .success()
        .stdout(predicate::str::contains("## File: src.rs")) // Keep source header
        .stdout(predicate::str::contains(src_content)) // Keep source content
        .stdout(predicate::str::contains("## File: target/debug.o")) // Keep target/ header
        .stdout(predicate::str::contains(obj_content)) // Keep target/ content
        .stdout(predicate::str::contains("## File: app.log")) // Keep *.log header
        .stdout(predicate::str::contains(log_content)) // Keep *.log content
        // With -t, hidden files like .gitignore should be included
        .stdout(predicate::str::contains("## File: .gitignore")) // Keep .gitignore header
        .stdout(predicate::str::contains(gitignore_content)); // Keep .gitignore content

    temp.close()?;
    Ok(())
}

#[test]
fn test_respects_hidden_files_by_default() -> Result<(), Box<dyn std::error::Error>> {
    let temp = tempdir()?;
    let hidden_content = "Hidden";
    let visible_content = "Visible";
    fs::write(temp.path().join(".hidden.txt"), hidden_content)?;
    fs::write(temp.path().join("visible.txt"), visible_content)?;

    dircat_cmd()
        // No -t flag, should skip hidden files
        .current_dir(temp.path())
        .assert()
        .success()
        .stdout(predicate::str::contains("## File: visible.txt")) // Keep visible header
        .stdout(predicate::str::contains(visible_content)) // Keep visible content
        .stdout(predicate::str::contains("## File: .hidden.txt").not()) // Ignore hidden header
        .stdout(predicate::str::contains(hidden_content).not()); // Ignore hidden content

    temp.close()?;
    Ok(())
}

#[test]
fn test_no_gitignore_includes_hidden_files() -> Result<(), Box<dyn std::error::Error>> {
    let temp = tempdir()?;
    let hidden_content = "Hidden";
    let visible_content = "Visible";
    fs::write(temp.path().join(".hidden.txt"), hidden_content)?;
    fs::write(temp.path().join("visible.txt"), visible_content)?;

    dircat_cmd()
        .arg("-t") // -t should also disable the default hidden file filter
        .current_dir(temp.path())
        .assert()
        .success()
        .stdout(predicate::str::contains("## File: visible.txt")) // Keep visible header
        .stdout(predicate::str::contains(visible_content)) // Keep visible content
        .stdout(predicate::str::contains("## File: .hidden.txt")) // Should include hidden header
        .stdout(predicate::str::contains(hidden_content)); // Should include hidden content

    temp.close()?;
    Ok(())
}