checklints 0.2.0

Check repositories against toml file(s) of constraints
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

use crate::types::RemoteFile;
use clap::Parser;
use std::path::PathBuf;

#[derive(Parser)]
pub struct Cli {
    /// Display more output
    #[clap(short, long)]
    pub(crate) verbose: bool,

    /// Additional checklist files (or directories of) to use
    #[clap(short, long = "check", value_name = "CHECK_FILE")]
    pub(crate) checks: Vec<PathBuf>,

    /// Directory of project to auit
    #[clap(value_name = "PROJECT_DIR")]
    pub project_dir: Option<PathBuf>,

    /// Do not read from cache
    #[clap(long)]
    pub(crate) no_read_cache: bool,

    /// Do not write to cache
    #[clap(long)]
    pub(crate) no_write_cache: bool,

    /// Do not try to read from or write to cache
    /// Implies 'no-read-cache' and 'no-write-cache'
    #[clap(short, long)]
    pub(crate) no_cache: bool,

    /// Delete cache file before running
    #[clap(long)]
    pub(crate) clear_cache: bool,

    /// Do not use user-wide checklists from ~/.config/checklist
    #[clap(long)]
    pub(crate) no_user_checklists: bool,

    /// Stop after the first failure
    /// (Default behavior is to run all checks, even if a previous check has failed)
    #[clap(long)]
    pub(crate) fail_fast: bool,

    /// Pull external checklist from remote
    #[clap(long)]
    pub(crate) external_checklist: Vec<RemoteFile>,

    /// Pull external template from remote
    #[clap(long)]
    pub(crate) external_template: Vec<RemoteFile>,
}

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

    #[test]
    fn verify_clap_args() {
        Cli::command().debug_assert();
    }
}