postit 0.2.3

Task manager on your CLI.
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
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130

# 📝 postit-rs

[![Coverage Status](https://coveralls.io/repos/github/keruDev/postit-rs/badge.svg?branch=master)](https://coveralls.io/github/keruDev/postit-rs?branch=master)
[![Build Status](https://github.com/keruDev/postit-rs/workflows/CI/badge.svg)](https://github.com/keruDev/postit-rs/actions)
[![Current Crates.io Version](https://img.shields.io/crates/v/postit.svg)](https://crates.io/crates/postit)
[![Docs.rs](https://img.shields.io/badge/postit-blue.svg?label=docs.rs)](https://docs.rs/postit/latest/postit/)

Dual-licensed under [Apache 2.0](LICENSE-APACHE) or [MIT](LICENSE-MIT).

postit is a simple CLI utility aimed to help you manage and keep track of your tasks.

> [!WARNING]
> Some commands may not work as expected in version `0.2.1` when using `csv`, `json` or `xml` formats.
> Please update to the latest version by running: `cargo install postit`.

## Index

Here is an index of this file to make it easier for you to navigate:

- [Getting started](#getting-started): describes installation and first steps.
- [From 0.1.x to 0.2.x](#from-01x-to-02x): brief migration guide.
- [Features](#features): postit's functionalities and new additions roadmap. 
- [Configuration](#configuration): describes configuration options.
- [Development](#development): things to take into account if you want to contribute to postit.

## Getting started

To install `postit`, just use:

```sh
cargo install postit
```

`postit` uses the path stored at the `POSTIT_ROOT` environment variable to
generate files inside it. If not set, this path will be `$HOME/.postit`.

You can set the `POSTIT_ROOT` environment variable to override the default value:

On Linux:

```sh
# ~/.bashrc

# Feel free to change this line
export POSTIT_ROOT="$HOME/.postit"
```  

On Windows:

```ps1
[Environment]::SetEnvironmentVariable("POSTIT_ROOT", "$env:USERPROFILE\.postit", "User")
```

The command below will generate `postit`'s configuration file inside the path
previously mentioned:

```sh
postit config init
```

Here is a list of useful commands to get started:
- `postit help`: a list of all possible commands.
- `postit docs`: documentation and use examples for every command.
- `postit flag`: documentation and use examples for flags.

## From 0.1.x to 0.2.x

The 0.1.x minor marked the beginning of postit's development, but the best is
yet to come. As of 0.1.x, postit featured csv and json file support, as well
as some basic commands to manage tasks and the configuration file.

By bumping the version to 0.2.x, it is intended to mark the first great step
of postit to becoming a more serious product.

To migrate from 0.1.x to 0.2.x, you'll need to change the `--path` flag to 
`--persister` (pretty simple, right?).

This minor will be focused on providing support for more database systems
(MongoDB or MySQL) along with some more file extensions (XML) and more commands
to make task management simpler.

Hope to cross paths in future versions :)

## Features

Although `postit` is still in early development, it is alive and keeps growing!
Here are some of its current features and some planned ones as well: 

Features:
- Commands and flags to manage tasks and files.
- Variety of supported persisters:
  - File extensions: `csv`, `json`, `xml`.
  - DB protocols: `sqlite`, `mongodb`, `mongodb+srv`.
- Configuration file to change postit's behavior (more info in the [Configuration](#configuration) section).

Roadmap:
- [x] XML support
- [x] MongoDB support
- [ ] MySQL support
- [ ] Tasks filtering and sorting

## Configuration

postit's behavior can be changed using the `.postit.toml` file.

You can check out its possible fields in the [docs](https://docs.rs/postit/latest/postit/struct.Config.html)
or by running the documentation command:

```sh
postit docs config
```

## Development

### Testing

To run postit's tests, use this command:
```sh
cargo test -- --test-threads=1
```

You can also use `tarpaulin`, configured in the `.tarpaulin.toml` file.
It is slower, but shows line coverage (not branch coverage):
```sh
cargo tarpaulin -- --test-threads=1
```

The reason why tests are run synchronously is to not overwrite existing files,
control the execution flow (creation and cleanup of temp files) and keep them
as lightweight as possible, as they don't use external dependencies.