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

//! The `dircat` prelude for convenient library use.
//!
//! This module re-exports the most commonly used types, traits, and functions
//! from the `dircat` library. By importing everything from this prelude, you can
//! easily get started with using `dircat` programmatically.
//!
//! # Examples
//!
//! ```
//! use dircat::prelude::*;
//! # fn main() -> Result<()> {
//!
//! // Now you can use ConfigBuilder, CancellationToken, etc. without full paths.
//! let config = ConfigBuilder::new().input_path(".").build()?;
//! let token = CancellationToken::new();
//! let result = execute(&config, &token, None)?;
//!
//! # Ok(())
//! # }
//! ```

pub use crate::cancellation::CancellationToken;
pub use crate::config::{
    Config, ConfigBuilder, DiscoveryConfig, OutputConfig, OutputDestination, ProcessingConfig,
};
pub use crate::core_types::{FileCounts, FileInfo};
pub use crate::discovery::discover_files;
pub use crate::errors::{Error, Result};
pub use crate::filtering::{
    check_process_last, is_file_type, is_likely_text, is_likely_text_from_buffer, is_lockfile,
    passes_extension_filters, passes_size_filter,
};
pub use crate::output::{MarkdownFormatter, OutputFormatter};
pub use crate::processing::process_files;
pub use crate::processing::{
    calculate_counts,
    filters::{
        remove_comments, remove_empty_lines, ContentFilter, RemoveCommentsFilter,
        RemoveEmptyLinesFilter,
    },
};
pub use crate::{execute, run, DircatResult};

// Also re-export key git utility functions if the feature is enabled.
#[cfg(feature = "git")]
pub use crate::git::{
    download_directory_via_api, get_repo, is_git_url, parse_clone_url, parse_github_folder_url, parse_github_folder_url_with_hint,
    ParsedGitUrl,
};