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

// src/output/formatter.rs

//! Provides helper functions for formatting parts of the output.

use crate::output::OutputConfig;
use std::path::Path;

/// Formats a path for display in headers or summary list.
///
/// This function ensures path separators are consistent (`/`) and applies
/// backticks for Markdown formatting if configured.
///
/// # Examples
/// ```
/// use dircat::output::formatter::format_path_for_display;
/// use dircat::OutputConfig;
/// use std::path::Path;
///
/// let opts_no_ticks = OutputConfig { backticks: false, filename_only_header: false, line_numbers: false, num_ticks: 3, summary: false, counts: false };
/// let opts_with_ticks = OutputConfig { backticks: true, filename_only_header: false, line_numbers: false, num_ticks: 3, summary: false, counts: false };
///
/// let path = Path::new("src/main.rs");
///
/// assert_eq!(format_path_for_display(path, &opts_no_ticks), "src/main.rs");
/// assert_eq!(format_path_for_display(path, &opts_with_ticks), "`src/main.rs`");
/// ```
pub fn format_path_for_display(path: &Path, opts: &OutputConfig) -> String {
    // Use '/' as separator for consistent display, even on Windows
    let path_str = path.to_string_lossy().replace('\\', "/");
    if opts.backticks {
        format!("`{}`", path_str)
    } else {
        path_str
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use std::path::Path;

    fn create_test_opts(backticks: bool) -> OutputConfig {
        let mut opts = crate::output::tests::create_mock_output_config(false, false, false, false);
        opts.backticks = backticks;
        opts
    }

    #[test]
    fn test_format_no_backticks() {
        let opts = create_test_opts(false);
        let path = Path::new("src/main.rs");
        assert_eq!(format_path_for_display(path, &opts), "src/main.rs");
    }

    #[test]
    fn test_format_with_backticks() {
        let opts = create_test_opts(true);
        let path = Path::new("src/main.rs");
        assert_eq!(format_path_for_display(path, &opts), "`src/main.rs`");
    }

    #[test]
    #[cfg(windows)]
    fn test_format_windows_path_separator() {
        let opts_no_ticks = create_test_opts(false);
        let opts_ticks = create_test_opts(true);
        let path = Path::new("src\\main.rs"); // Windows-style separator
        assert_eq!(format_path_for_display(path, &opts_no_ticks), "src/main.rs"); // Replaced with /
        assert_eq!(format_path_for_display(path, &opts_ticks), "`src/main.rs`");
        // Replaced with / and backticked
    }
}