zola_chrono 0.4.0

Tool to set dates for zola pages based on git history
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

//! Stores Command Line Interface (cli)  configuration
use clap::Parser;

#[derive(Parser, Clone, Eq, PartialEq, Ord, PartialOrd, Debug, Default)]
#[command(
    author,
    version,
    about,
    long_about = "Updates the `date` and `updated` fields of the pages front matter
    1. `date` should be the original publish date (Must exist and be today or earlier).
    2. `updated` should only be set if `date` is not equal to the last commit date, if it needs to be set it should match the last commit date
"
)]
/// Stores the configurations acquired via the command line
pub struct Cli {
    #[arg(value_name = "PATH", default_value = ".")]
    /// The root folder to start at
    ///
    /// Usually you want to point this to the content folder of the zola repo. It is required for it to be in a repository with a clean working tree.
    pub root_path: String,

    /// If set will not prompt for confirmation before running
    #[arg(long, short)]
    pub unattended: bool,

    /// If set will not modify any files and only report how many files would have been changed
    ///
    /// Return codes in this mode: (0) No files would have been changed (1) Error Occurred (2) Files would have been changed
    #[arg(long = "check", short = 'c')]
    pub should_check_only: bool,

    /// Allows changes to be made even if there are dirty files in the vcs. WARNING: This means that there will be no easy way to undo changes made
    ///
    /// Prefer at least staging files if possible over using this option. Only provided in case users really prefer not needing to stage their files.
    #[arg(long)]
    pub allow_dirty: bool,
}

#[cfg(test)]
mod tests {

    #[test]
    fn verify_cli() {
        // Source: https://docs.rs/clap/latest/clap/_derive/_tutorial/index.html#testing
        // My understanding it reports most development errors without additional effort
        use clap::CommandFactory;
        super::Cli::command().debug_assert()
    }
}