taboc 0.2.105

A table of contents generator for markdown documents.
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

/*!
Contains the CLI Argument Parsing struct ([`Opt`]).

Refer to the [`clap`] and [`clio`] crates.
*/

use crate::prelude::*;
use clap::ArgAction;

/// A table of contents generator for markdown documents written in Rust.
#[derive(Parser, Clone, Debug)]
pub struct Opt {
    /// The target file.
    #[clap(value_parser, default_value = "./README.md")]
    pub input: Input,
    /// Use to override the existing table of contents in [INPUT].
    #[clap(long, action=ArgAction::SetTrue)]
    pub update_existing: bool,
    /// Use to only print the table of contents to stdout. If not set it'll try to update the file
    /// directly.
    #[clap(long, action=ArgAction::SetTrue)]
    pub no_file_update: bool,
    /// Use to not consider uncommited git changes.
    #[cfg(feature = "git")]
    #[clap(long, action=ArgAction::SetTrue)]
    pub allow_dirty: bool,
    /// Don't check for changes on your Version Control System.
    #[cfg(feature = "git")]
    #[clap(long, action=ArgAction::SetTrue)]
    pub no_vcs: bool,
    /// Max heading depth for the table of contents.
    #[clap(long, default_value = "6")]
    pub max_depth: usize,
}