episko_cli 1.3.1

Cli for the episko project
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

//! # CLI settings
//!
//! This module contains the cli settings of the program.
//!
//! ## Arguments
//! The first given argument is one of the commands. The second is a file or, in case of create, there is the possibility to pass flags.

use camino::Utf8PathBuf;
use clap::{ArgAction, Args, Parser, Subcommand};

pub mod prompts;

/// CLI interface of Episko
#[derive(Parser)]
#[command(version, about, long_about = None)]
#[command(propagate_version = true)]
pub struct Cli {
    #[command(subcommand)]
    pub command: Commands,
}

#[derive(Subcommand)]
pub enum Commands {
    /// Create a new manifest file
    Create(CreateArgs),
    /// Remove a given file from the filesystem and the program
    Remove { file: Utf8PathBuf },
    /// Cache an unknown manifest file for future use
    Cache { file: Utf8PathBuf },
    /// Validate a manually changed or potentially corrupted file
    Validate { file: Utf8PathBuf },
}

#[derive(Args, Clone, Default)]
pub struct CreateArgs {
    /// Create the file with given data without the interactive mode
    #[arg(short, long, action=ArgAction::SetTrue)]
    pub non_interactive: bool,
    /// Directory of the project
    #[arg(short, long)]
    pub directory: Option<Utf8PathBuf>,
    /// Title of the project
    #[arg(short, long)]
    pub title: Option<String>,
    /// Categories of the project (space seperated), syntax: <CATEGORY> ...
    #[arg(short, long, value_parser, num_args = 1..)]
    pub categories: Vec<String>,
    /// Languages of the project (space seperated), syntax: <NAME>:<VERSION> ...
    #[arg(short, long, value_parser, num_args = 1..)]
    pub languages: Vec<String>,
    /// Preferred IDE of the project, syntax: <NAME>:<VERSION>
    #[arg(short, long)]
    pub preferred_ide: Option<String>,
    /// Build systems of the project (space seperated), syntax: <NAME>:<VERSION> ...
    #[arg(short, long, value_parser, num_args = 1..)]
    pub build_systems: Vec<String>,
    /// Description of the project
    #[arg(short = 'D', long)]
    pub description: Option<String>,
    /// Repository URL of the project
    #[arg(short, long)]
    pub repository_url: Option<String>,
}

#[cfg(test)]
pub mod tests {
    /// Skip a test if stdout is used.
    /// See test documentation in [`cli::prompts`] for more information
    ///
    /// # Panics
    /// Skips the test by calling the corresponding panic to count it as "pass".
    pub fn skip_if_stdout() {
        if atty::is(atty::Stream::Stdout) {
            eprintln!("Skipping test with stdout when not using nextest...");
            panic!("IO error: not a terminal");
        }
    }
}