twodo 0.1.0

This a simple todo list application in terminal
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

#![deny(missing_docs)]

use std::path::PathBuf;

use clap::{Args, Parser, Subcommand};

/// Twodo CLI
#[derive(Parser, Debug)]
#[command(author, version, about, long_about = None)]
pub struct Cli {
    /// Operation for twodo
    #[command(subcommand)]
    pub op: Option<Op>,
}

/// Operations on twodos
#[derive(Subcommand, Debug)]
pub enum Op {
    /// List all twodo
    List(ListArg),

    /// Add a twodo
    Add(AddArg),

    /// Complete a twodo
    Done,

    /// Edit a twodo
    Edit(EditArg),

    /// Delete a twodo
    Delete(DeleteArg),
}

/// List arguments for twodo
#[derive(Debug, Default, Args)]
pub struct ListArg {
    /// Output format
    #[arg(short, long)]
    output: Option<bool>,

    /// Number of twodo to list
    #[arg(short)]
    number: Option<usize>,
}

/// Add arguments for twodo
#[derive(Args, Debug)]
pub struct AddArg {
    /// Title of twodo
    pub title: String,

    /// Description for twodo
    #[arg(short, long, requires = "title")]
    pub description: Option<String>,
}

/// Edit arguments for twodo
#[derive(Debug, Args)]
pub struct EditArg {
    /// Id of twodo to edit
    pub id: i64,

    /// Title of twodo
    #[arg(short, long)]
    pub title: Option<String>,

    /// Description of twodo
    #[arg(short, long)]
    pub description: Option<String>,
}

/// Delete arguments for twodo
#[derive(Debug, Args)]
pub struct DeleteArg {
    /// Id of twodo to delete
    pub id: i64,
}

// region:    --- Tests

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn verify_cli() {
        use clap::CommandFactory;
        Cli::command().debug_assert();
    }
}

// endregion: --- Tests