mdrefcheck 0.2.1

A CLI tool to validate references in markdown files.
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

use std::path::PathBuf;

use clap::Parser;
use clap_verbosity_flag::{InfoLevel, Verbosity};
use regex::Regex;

/// CLI configuration for mdrefcheck
#[derive(Parser, Debug)]
#[command(name = "mdrefcheck", about = "Check markdown references.", version)]
pub struct CliConfig {
    /// Paths to check
    #[arg(required = true, value_name = "PATH")]
    pub paths: Vec<PathBuf>,

    /// Regex patterns to exclude from link validation
    #[arg(long, short, value_name = "REGEX")]
    pub ignore: Vec<Regex>,

    /// Paths to not check. Excluded files can be parsed though if they are referred.
    #[arg(long, short, value_name = "PATH")]
    pub exclude: Vec<PathBuf>,

    /// Disable standard ignore filters (gitignore, hidden files, etc.)
    #[arg(long)]
    pub no_ignore: bool,

    // -q, --quiet   (decreases verbosity)
    // -v, --verbose (increases verbosity, up to 2 times for 'trace')
    #[command(flatten)]
    pub verbosity: Verbosity<InfoLevel>,
}