cli-toolbox 0.8.0

Utility library for working with cli output ergonomically
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

# cli-toolbox

Utility library for working with ```cli``` output ergonomically.

This is not a logging alternative, it's intended to produce output for end user consumption.

It handles three levels of verbosity that can be set dynamically at runtime:

* Quite - no output
* Terse - used to provide minimal user output
* Verbose - used to provide elaborated and/or additional user output

### Output Macros


* `debug!` - conditionally compiled console debugging output - [`debug`]

* `report!` - conditional console output according to verbosity level - [`debug`|`release`]

\* _debug! is intended to be used during application development_

\* _all other debugging and telemetry output is most likely better served with a logging library_

### Conditional Code


* `eval!` - conditional code execution according to verbosity level - [`debug`|`release`]

* `release!` - conditional code execution according to verbosity level - [`release`]

## Resources

* [Docs](https://docs.rs/cli-toolbox/0.8.0/cli_toolbox/) for more detailed information
* [Examples](https://github.com/Nejat/cli-toolbox-rs/tree/v0.8.0/examples) to see it in action

## Usage


Each macro is gated by a feature.

No feature is mutually exclusive and can be combined as needed.

* `debug!` macro

```toml
[dependencies]
cli-toolbox = { version = "0.8", features = ["debug"] }
```

* `eval!` macro

```toml
[dependencies]
cli-toolbox = { version = "0.8", features = ["eval"] }
verbosity = "0.1"
```

* `release!` macro

```toml
[dependencies]
cli-toolbox = { version = "0.8", features = ["release"] }
verbosity = "0.1"
```

* `report!` macro

```toml
[dependencies]
cli-toolbox = { version = "0.8", features = ["report"] }
verbosity = "0.1"
```

## Roadmap


* [ ] ...

## Implemented

* [x] ```debug!``` macro
* [x] ```eval!``` macro
* [x] ```release!``` macro
* [x] ```report!``` macro