clerr 0.11.0

This library aids in command-line error reporting.
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
88
89
90
91
92
93
94
95
96
97
98
99

# clerr

[![Crates.io](https://img.shields.io/crates/v/clerr.svg)](https://crates.io/crates/clerr)
[![Docs.rs](https://docs.rs/clerr/badge.svg)](https://docs.rs/clerr)
[![License: MIT](https://img.shields.io/crates/l/clerr.svg)](https://opensource.org/licenses/MIT)

This library aids in command-line error reporting.

```toml
clerr = "0.11.0"
```

## Examples

Note: The output for each example would be colored text. This is not supported in Markdown files.

### Simple Report

```rust
use clerr::*;

let code: Code = Code::error("E001", "file not found");
let report: Report = Report::from(code);
eprintln!("{}", report);
```

```text
error[E001]: file not found
```

### Token Info

Highlight a specific token in a source line with a message, similar to `rustc` output.

```rust
use clerr::*;

let code: Code = Code::warning("W012", "unused variable");
let info: TokenInfo = TokenInfo {
    severity: Severity::Warning,
    file_name: "src/main.rs",
    line: 8,
    position: 9,
    line_text: "    let x = 42;",
    token_len: 1,
    message: "consider prefixing with `_`",
};
let report: Report = Report::from(code).with_entry(info);
eprintln!("{}", report);
```

```text
warning[W012]: unused variable
 --> src/main.rs [line=8, position=9]
  |
8 |     let x = 42;
  |         ^ --- consider prefixing with `_`
  |
```

### Properties

Display aligned key-value pairs under a report.

```rust
use clerr::*;

let props: Properties = Properties::default()
    .with_property("file", "/etc/config.yml")
    .with_property("expected", "utf-8")
    .with_property("found", "binary");
let code: Code = Code::error("E042", "invalid encoding");
let report: Report = Report::from(code).with_entry(props);
eprintln!("{}", report);
```

```text
error[E042]: invalid encoding
    file:      /etc/config.yml
    expected:  utf-8
    found:     binary
```

### Severity Levels

Three severity levels are available, each with a distinct color:

| Level     | Color        |
|-----------|--------------|
| `Error`   | BrightRed    |
| `Warning` | BrightYellow |
| `Info`    | BrightBlue   |

These colors are intentionally fixed for consistency and consideration for the colorblind.

## Issues & Contributing

See [ISSUES.md](https://github.com/nikdeapen/clerr/blob/master/ISSUES.md) for issues & future work and
[CONTRIBUTING.md](https://github.com/nikdeapen/clerr/blob/master/CONTRIBUTING.md) for guidelines.