structconf 0.5.0

Combine clap and rust-ini into a single procedural macro
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
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

//! This example is the configuration file that was going to be used for Vidify
//! (https://github.com/vidify/vidify).
//!
//! The config file resides at "vidify/config.ini" inside your user's config
//! directory, but it can also be specified with `--config-file`.
//!
//! It includes custom types with `FromStr` and `ToString`, which are
//! automatically derived with the crate `strum`.

#![allow(dead_code)]

use strum_macros::{Display, EnumString};

#[derive(Debug, Display, EnumString)]
pub enum API {
    MPRIS,
    Windows,
    MacOS,
    SpotifyWeb,
}

#[derive(Debug, Display, EnumString)]
pub enum Player {
    Mpv,
    External,
}

use structconf::{clap, Error, StructConf};

#[derive(Debug, StructConf)]
pub struct Config {
    #[conf(help = "Display debug messages")]
    debug: bool,

    #[conf(no_file, help = "The config file path")]
    conf_file: Option<String>,

    #[conf(
        negated_arg,
        long = "no_lyrics",
        short = "n",
        help = "Do not print lyrics"
    )]
    lyrics: bool,

    #[conf(help = "Open the app in fullscreen mode")]
    fullscreen: bool,

    #[conf(no_short, help = "Activate the dark mode")]
    dark_mode: bool,

    #[conf(no_short, help = "The window will stay on top of all apps")]
    stay_on_top: bool,

    #[conf(help = "The source music player used. Read the installation guide \
           for a list with the available APIs")]
    api: Option<API>,

    #[conf(help = "The output video player. Read the installation guide for \
           a list with the available players")]
    player: Option<Player>,

    #[conf(
        no_short,
        help = "Enable automatic audio synchronization. Read the \
           installation guide for more information. Note: this feature is \
           still in development"
    )]
    audiosync: bool,

    #[conf(no_short, help = "Manual tweaking value for audiosync in milliseconds")]
    audiosync_calibration: i32,

    #[conf(
        no_short,
        help = "Custom boolean flags used when opening mpv, with dashes and \
           separated by spaces"
    )]
    mpv_flags: String,

    #[conf(
        no_short,
        help = "The client ID for the Spotify Web API. Check the guide to \
           learn how to obtain yours",
        section = "SpotifyWeb"
    )]
    client_id: Option<String>,

    #[conf(
        no_short,
        help = "The client secret for the Spotify Web API. Check the install \
           guide to learn how to obtain yours",
        section = "SpotifyWeb"
    )]
    client_secret: Option<String>,

    #[conf(
        no_short,
        help = "The redirect URI used for the Spotify Web API",
        section = "SpotifyWeb"
    )]
    redirect_uri: String,

    #[conf(no_short, no_long, section = "SpotifyWeb")]
    refresh_token: Option<String>,
}

/// Initializes the application's configuration structure. The config file
/// will be at the user's default config path, or whichever is specified
/// by `--config-file`.
fn init_config() -> Result<Config, Error> {
    let app = clap::App::new("vidify")
        .version(clap::crate_version!())
        .author(clap::crate_authors!());
    let args = Config::parse_args(app);
    let path = match args.value_of("config_path") {
        Some(path) => path.to_string(),
        None => {
            let mut path = dirs::config_dir().expect("Couldn't find user's config path");
            path.extend(["vidify", "config.ini"].iter());
            path.to_string_lossy().into_owned()
        }
    };
    Config::parse_file(&args, &path)
}

pub fn main() {
    let config = init_config();
    println!("Config options: {:#?}", config);
}