luhcore 0.0.1

the core library for the luh ecosystem
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

# luhcore

`luhcore` is a small utility crate providing core functionality commonly needed in my applications, including:

- **Terminal styling** via [`Colorise`], [`Style`], [`StyledText`], and [`Color`].
- **Platform directories** handling via [`dirs::AppDirs`].
- **Build and environment checks** like `is_ci()`, `is_debug_build()`, and `is_release_build()`.

## Modules

- [`color`]: Extension trait for coloring strings and styled text.
- [`style`]: Core style types (`Style`, `StyledText`, `Color`) and styling logic.
- [`dirs`]: Application directories handling (`AppDirs`) for config, cache, temp files, etc.

## Features

- **Terminal text styling**  
  Apply foreground/background colors, bold, underline, and dim effects using a convenient trait interface.

- **Environment detection**  
  Check if running in a CI environment, or whether the build is a debug or release build.

- **Cross-platform directories**  
  Create and manage app-specific config, cache, and temporary directories, including development temp files.

## Examples

### Terminal styling
```rust
use luhcore::Colorise;

println!("{}", "error".red().bold());
println!("{}", "warning".yellow().underline());
println!("{}", "success".green().on_white().dim());
```

### Environment detection
```rust
use luhcore::{is_ci, is_debug_build};

if is_ci() {
    println!("Running in CI environment");
}
if is_debug_build() {
    println!("Running in debug mode");
}
```

### Directories handling
```rust
use luhcore::dirs::AppDirs;

fn main() -> std::io::Result<()> {
    let dirs = AppDirs::for_app("luhcore")?;
    dirs.ensure_all()?;

    println!("Config dir: {}", dirs.config.display());
    println!("Cache dir:  {}", dirs.cache.display());
    println!("Temp dir:   {}", dirs.temp.display());

    let temp_file = dirs.dev_temp_file("example.txt");
    println!("Development temp file path: {}", temp_file.display());

    Ok(())
}
```

## Note
> made with love s.c 2025 :)