dircat 1.0.1

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

#![cfg(feature = "git")]
mod common;

use assert_cmd::prelude::*;
use common::dircat_cmd;
use predicates::prelude::*;
use tempfile::tempdir;

/// Tests downloading a specific folder from a public remote repository via the API.
/// This is a slow, network-dependent test.
/// To run: `cargo test -- --ignored git_api_download`
#[test]
#[ignore = "requires network access and is slow"]
fn test_api_download_public_directory() -> Result<(), Box<dyn std::error::Error>> {
    // This public repo has a `go/` directory containing `example.go`.
    let repo_folder_url = "https://github.com/git-fixtures/basic/tree/master/go";

    let temp_cache = tempdir()?;

    dircat_cmd()
        .arg(repo_folder_url)
        .env("DIRCAT_TEST_CACHE_DIR", temp_cache.path())
        .assert()
        .success()
        // Check for file inside the 'go' directory
        .stdout(predicate::str::contains("## File: example.go"))
        .stdout(predicate::str::contains("package harvesterd"))
        // Check that files from the root directory are NOT included
        .stdout(predicate::str::contains("## File: CHANGELOG").not())
        .stdout(predicate::str::contains("## File: LICENSE").not());

    Ok(())
}

/// Tests downloading a single file from a public remote repository via a blob URL.
/// This is a slow, network-dependent test.
#[test]
#[ignore = "requires network access and is slow"]
fn test_api_download_public_blob_url() -> Result<(), Box<dyn std::error::Error>> {
    // This public repo has a `go/` directory containing `example.go`.
    let repo_blob_url = "https://github.com/git-fixtures/basic/blob/master/go/example.go";

    let temp_cache = tempdir()?;

    dircat_cmd()
        .arg(repo_blob_url)
        .env("DIRCAT_TEST_CACHE_DIR", temp_cache.path())
        .assert()
        .success()
        // Check for the specific file
        .stdout(predicate::str::contains("## File: go/example.go"))
        .stdout(predicate::str::contains("package harvesterd"))
        // Check that other files from the repository are NOT included
        .stdout(predicate::str::contains("## File: CHANGELOG").not())
        .stdout(predicate::str::contains("## File: LICENSE").not());

    Ok(())
}

/// Tests that the URL parser correctly rejects a path that contains a reserved
/// GitHub keyword (like 'issues', 'pull', 'releases') as its first segment.
/// This is a known limitation we are asserting.
#[test]
#[ignore = "requires network access and is slow"]
fn test_sloppy_url_with_reserved_keyword_is_not_parsed_as_folder(
) -> Result<(), Box<dyn std::error::Error>> {
    // This "sloppy" URL (missing /tree/) should be rejected by the folder parser because 'releases' is a reserved keyword.
    // dircat will then treat it as a generic git URL and attempt to clone it, which will fail.
    let repo_folder_url = "https://github.com/some-user/some-repo/releases/v1.0";

    let temp_cache = tempdir()?;

    dircat_cmd()
        .arg(repo_folder_url)
        .env("DIRCAT_TEST_CACHE_DIR", temp_cache.path())
        .assert()
        .failure()
        // The error should indicate it failed to clone, because the folder parser rejected it
        // and it was then treated as a generic (but invalid) clone URL.
        .stderr(predicate::str::contains("Failed to clone repository"));

    Ok(())
}