debtmap 0.16.4

Code complexity and technical debt analyzer
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

//! Input/output operations and file system abstractions.
//!
//! This module provides I/O utilities including file operations, output destinations,
//! and progress reporting. It follows the functional programming principle of keeping
//! I/O at system boundaries with pure computation in core modules.
//!
//! # Key Components
//!
//! - **File operations**: Read, write, and check file/directory existence
//! - **Output destinations**: Abstracted output targets (stdout, files, memory)
//! - **Coverage loaders**: Load test coverage data from LCOV files
//! - **Progress reporting**: Track analysis progress for user feedback
//! - **Directory walking**: Iterate over files in a directory tree

pub mod destinations;
pub mod effects;
pub mod output;
pub mod pattern_output;
pub mod progress;
pub mod real;
pub mod traits;
pub mod view_formatters;
pub mod walker;
pub mod writers;

// Re-export I/O traits for convenient access
pub use destinations::{
    FileDestination, MemoryDestination, OutputDestination, StderrDestination, StdoutDestination,
};
pub use real::{MemoryCache, NoOpCache, RealCoverageLoader, RealFileSystem};
pub use traits::{Cache, CoverageData, CoverageLoader, FileCoverage, FileSystem};

use anyhow::Result;
use std::fs;
use std::path::Path;

pub fn read_file(path: &Path) -> Result<String> {
    Ok(fs::read_to_string(path)?)
}

pub fn write_file(path: &Path, content: &str) -> Result<()> {
    fs::write(path, content)?;
    Ok(())
}

pub fn ensure_dir(path: &Path) -> Result<()> {
    if !path.exists() {
        fs::create_dir_all(path)?;
    }
    Ok(())
}

pub fn file_exists(path: &Path) -> bool {
    path.exists() && path.is_file()
}

pub fn dir_exists(path: &Path) -> bool {
    path.exists() && path.is_dir()
}