facti 0.2.3

Factorio mod tool
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

use std::path::PathBuf;

use clap::{Parser, Subcommand, ValueHint};
use url::Url;

use crate::logging::LogLevelFilter;

use self::{
    changelog::ChangelogArgs, completion::CompletionArgs, new::NewArgs, portal::PortalArgs,
    verbose::Verbosity,
};

pub mod changelog;
pub mod completion;
pub mod new;
pub mod portal;
mod verbose;

const ENV_CONFIG_PATH: &str = "FACTI_CONFIG";
const ENV_LOG_LEVEL: &str = "FACTI_LOG_LEVEL";
const ENV_API_KEY: &str = "FACTI_API_KEY";
const ENV_API_KEY_FILE: &str = "FACTI_API_KEY_FILE";
const ENV_PORTAL_BASE_URL: &str = "FACTI_PORTAL_BASE_URL";
const ENV_GAME_BASE_URL: &str = "FACTI_GAME_BASE_URL";

#[derive(Parser, Debug)]
#[command(author, version, about)]
pub struct Cli {
    #[clap(flatten)]
    pub verbose: Verbosity,

    /// Specifies desired logging level.
    ///
    /// If this option is specified, the verbosity (-v) and quiet (-q) flags
    /// will be ignored.
    #[arg(
        short,
        long,
        env = ENV_LOG_LEVEL,
        alias = "log-level-filter",
        global = true
    )]
    pub log_level: Option<LogLevelFilter>,

    /// Override config file path.
    ///
    /// When specified, will use this config file instead of looking in the
    /// default locations.
    #[arg(short, long, env = ENV_CONFIG_PATH, value_hint = ValueHint::FilePath)]
    pub config: Option<PathBuf>,

    /// Set API key to use.
    #[arg(short = 'k', long, env = ENV_API_KEY, value_hint = ValueHint::Other)]
    pub api_key: Option<String>,

    /// Read API key from stdin.
    ///
    /// This can be useful as a way to avoid having your API key end up
    /// in your shell history.
    #[arg(long, conflicts_with_all = &["api_key", "api_key_file"])]
    pub api_key_stdin: bool,

    /// Read API key from file.
    ///
    /// The specified file should contain nothing but the API key.
    ///
    /// This can be useful as a way to avoid having your API key end up
    /// in your shell history.
    #[arg(long, env = ENV_API_KEY_FILE, value_hint = ValueHint::FilePath, conflicts_with_all = &["api_key", "api_key_stdin"])]
    pub api_key_file: Option<PathBuf>,

    /// Override the base URL to the Factorio mod portal API.
    ///
    /// The default base URL is <https://mods.factorio.com/api/>.
    #[arg(long, env = ENV_PORTAL_BASE_URL, value_hint = ValueHint::Url)]
    pub portal_base_url: Option<Url>,

    /// Override the base URL to the Factorio game API.
    ///
    /// The default base URL is <https://factorio.com/api/>.
    #[arg(long, env = ENV_GAME_BASE_URL, value_hint = ValueHint::Url)]
    pub game_base_url: Option<Url>,

    #[command(subcommand)]
    pub command: Commands,
}

#[derive(Subcommand, Debug)]
pub enum Commands {
    Portal(PortalArgs),

    #[command(visible_alias = "init")]
    New(Box<NewArgs>),

    Changelog(ChangelogArgs),

    Completion(CompletionArgs),

    /// Do nothing.
    ///
    /// Used for debugging.
    #[cfg(debug_assertions)]
    #[command(name = "noop", visible_alias = "nop")]
    NoOp,

    /// Print log messages for all log levels.
    ///
    /// Used for debugging.
    #[cfg(debug_assertions)]
    #[command(name = "logtest")]
    LogTest,
}

impl Cli {
    pub fn log_level_filter(&self) -> Option<LogLevelFilter> {
        if let Some(ll) = self.log_level {
            return Some(ll);
        }
        match self.verbose.is_given() {
            true => Some(self.verbose.log_level_filter().into()),
            false => None,
        }
    }
}