tangra 1.3.0

🪵 A lightweight and easy to use Rust logging library
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
84
85
86
87

<div align="center">

# tangra.rs

[![Crates.io Badge](https://img.shields.io/crates/v/tangra.svg)](https://crates.io/crates/tangra)
[![CI Badge](https://github.com/kkrypt0nn/tangra.rs/actions/workflows/ci.yml/badge.svg)](https://github.com/kkrypt0nn/tangra.rs/actions)
[![Dependency Status Badge](https://deps.rs/repo/github/kkrypt0nn/tangra.rs/status.svg)](https://deps.rs/repo/github/kkrypt0nn/tangra.rs)

[![Discord Server Badge](https://img.shields.io/discord/739934735387721768?logo=discord)](https://discord.gg/mTBrXyWxAF)
[![Last Commit Badge](https://img.shields.io/github/last-commit/kkrypt0nn/tangra.rs)](https://github.com/kkrypt0nn/tangra.rs/commits/main)
[![Conventional Commits Badge](https://img.shields.io/badge/Conventional%20Commits-1.0.0-%23FE5196?logo=conventionalcommits&logoColor=white)](https://conventionalcommits.org/en/v1.0.0/)

</div>

---

A lightweight and easy to use Rust logging library that includes logging functionalities with different levels and
custom
formatting. It can also be used as a library to simply format the various messages you print in the terminal.

## Showcase

### macOS

![macOS Showcase](https://raw.githubusercontent.com/kkrypt0nn/tangra.rs/main/assets/macos.png)

### Linux

![Linux Showcase](https://raw.githubusercontent.com/kkrypt0nn/tangra.rs/main/assets/linux.png)

### Windows

![Windows Showcase](https://raw.githubusercontent.com/kkrypt0nn/tangra.rs/main/assets/windows.png)

## Installation

If you want to use this library for one of your projects, you can install it like any other Go library

```shell
cargo add tangra
```

## Customizing

### Prefix

The prefix, what comes before the message, can be changed with the `set_prefix` method on a `Logger` structure.

> The default prefix is `$[datetime] $[level:color]$[level:name]$[reset]: `

### Placeholders

There are formatting placeholders that will be replaced in both the message and the prefix that can be
seen [here](PLACEHOLDERS.md).

[For example](examples), logging the following message

```
$[fg:red]$[effect:blink]$[effect:bold]$[sys:username] says hello!
```

Will print a red blinking message in bold that says `<username> says hello!`, where `<username>` is the username on your
system.

### Styling

You can choose whether you want to style your messages or not with the `SetStyling` method on a `Logger` structure.
Styling includes foreground colors, background colors and special effects such as bold, and others - see
the [`terminal.rs`](src/terminal.rs) file.

> **Note**: The styling will **not** apply to the message if it is not supported by the terminal.

### Log File

Logs can also be written inside a log file with styling removed. [For example](examples/file.rs):

```rs
fn main() {
    let mut logger = tangra::Logger::new();
    logger.set_log_file_path("example.log");
    logger.debug("$[fg:red]$[effect:blink]$[effect:bold]$[sys:username] says hello!");
}
```

## License

This library was made with 💜 by Krypton and is under the [MIT](LICENSE.md) license.