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
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139

use clap::{Args, Subcommand, ValueHint};
use facti_api::blocking::ApiClient;
use facti_lib::FactorioVersion;

/// Interact with the Factorio mod portal.
///
/// You can search for mods and show details for a specific mod.
#[derive(Args, Debug)]
pub struct PortalArgs {
    /// Output results as JSON.
    ///
    /// Tip: You can use jq to work with JSON!
    #[arg(short, long)]
    pub json: bool,

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

#[derive(Subcommand, Debug)]
pub enum PortalCommands {
    /// Search for mods.
    Search(PortalSearchArgs),

    /// Show details about a specific mod.
    Show(PortalShowArgs),
}

#[derive(clap::Args, Debug)]
pub struct PortalSearchArgs {
    /// Include deprecated mods in the search results.
    ///
    /// Default is to not include deprecated mods.
    #[arg(short, long)]
    pub deprecated: bool,

    /// Page number you would like to show.
    #[arg(short, long, default_value_t = 1)]
    pub page: u32,

    /// The amount of results to show, specify 'max' for maximum possible.
    #[arg(short = 'n', long = "size", value_name = "SIZE")]
    pub page_size: Option<facti_api::data::pagination::PageSize>,

    /// The property to sort results by, defaults to name if not given.
    ///
    /// Any of the following are valid:
    ///  - name
    ///  - created or created_at
    ///  - updated or updated_at
    #[arg(short, long = "sort", value_name = "SORT")]
    pub sort_mode: Option<facti_api::data::sorting::SortMode>,

    /// Select whether to sort ascending or descending, default is descending.
    ///
    /// It accepts the following:
    ///  - ascending or asc
    ///  - descending or desc
    #[arg(short = 'o', long = "order", value_name = "ORDER")]
    pub sort_order: Option<facti_api::data::sorting::SortOrder>,

    /// Only return non-deprecated mods compatible with the specified Factorio version.
    ///
    /// Specifying this together with --deprecated will result in the deprecated
    /// flag not having any effect.
    ///
    /// The version must be given in the format of MAJOR.MINOR.
    #[arg(short, long)]
    pub factorio_version: Option<FactorioVersion>,

    /// Limit the results to mods matching the given names.
    #[arg(value_hint = ValueHint::Other)]
    pub names: Vec<String>,
}

#[derive(clap::Args, Debug)]
pub struct PortalShowArgs {
    /// If given, will show more details about the mod.
    #[arg(short, long)]
    pub full: bool,

    pub name: String,
}

impl PortalArgs {
    pub fn run(&self, client: &ApiClient) -> anyhow::Result<()> {
        match &self.command {
            PortalCommands::Search(args) => args.run(client, self.json),
            PortalCommands::Show(args) => args.run(client, self.json),
        }
    }
}

impl PortalSearchArgs {
    pub fn run(&self, client: &ApiClient, json: bool) -> anyhow::Result<()> {
        let query = facti_api::data::portal::SearchQuery {
            hide_deprecated: !self.deprecated,
            page: self.page,
            page_size: self.page_size,
            sort: self.sort_mode,
            sort_order: self.sort_order,
            version: self.factorio_version,
            namelist: match &self.names {
                names if names.is_empty() => None,
                names => Some(names.to_vec()),
            },
        };

        let response = client.search(&query)?;

        if json {
            println!("{}", serde_json::to_string_pretty(&response)?);
        } else {
            for item in response.results {
                println!("{}", item);
            }
        }

        Ok(())
    }
}

impl PortalShowArgs {
    pub fn run(&self, client: &ApiClient, json: bool) -> anyhow::Result<()> {
        let response = if self.full {
            client.info_full(&self.name)?
        } else {
            client.info_short(&self.name)?
        };

        if json {
            println!("{}", serde_json::to_string_pretty(&response)?);
        } else {
            println!("{}", response);
        }

        Ok(())
    }
}