pace_core 0.19.0

pace-core - library to support timetracking on the command line
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

#[cfg(feature = "clap")]
use clap::Parser;

use crate::{
    constants::PACE_DOCS_URL,
    constants::{PACE_CONFIG_DOCS_URL, PACE_DEV_DOCS_URL},
    error::{PaceResult, UserMessage},
};

/// `docs` subcommand options
#[derive(Debug, Clone)]
#[cfg_attr(feature = "clap", derive(Parser))]
#[cfg_attr(
        feature = "clap", clap(group = clap::ArgGroup::new("documentation").multiple(false)))]
pub struct DocsCommandOptions {
    /// Open the development documentation
    #[cfg_attr(feature = "clap", clap(short, long, group = "documentation"))]
    dev: bool,

    /// Open the config documentation
    #[cfg_attr(feature = "clap", clap(short, long, group = "documentation"))]
    config: bool,
}

impl DocsCommandOptions {
    /// Handles the `docs` subcommand
    ///
    /// # Errors
    ///
    /// Returns an error if the browser could not be opened
    ///
    /// # Returns
    ///
    /// Returns a `UserMessage` with the information about the opened documentation
    /// that can be displayed to the user
    #[tracing::instrument(skip(self))]
    pub fn handle_docs(&self) -> PaceResult<UserMessage> {
        // If no flag is set, open the regular documentation
        let user_string = if !self.dev && !self.config {
            open::that(PACE_DOCS_URL)?;

            format!("Opening the user documentation at {PACE_DOCS_URL}")
        } else if self.config {
            // Open the config documentation
            open::that(PACE_CONFIG_DOCS_URL)?;

            format!("Opening the configuration documentation at {PACE_CONFIG_DOCS_URL}")
        } else if self.dev {
            // Open the development documentation
            open::that(PACE_DEV_DOCS_URL)?;

            format!("Opening the development documentation at {PACE_DEV_DOCS_URL}")
        } else {
            "No documentation to open".to_string()
        };

        Ok(UserMessage::new(user_string))
    }
}