beautiful-md 0.2.0

A CLI tool to format and beautify 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
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

//! Command-line interface for beautiful-md.

use clap::{Parser, Subcommand};
use std::path::PathBuf;

/// A CLI tool to format and beautify Markdown files.
#[derive(Parser, Debug)]
#[command(name = "beautiful-md")]
#[command(author, version, about, long_about = None)]
#[allow(clippy::struct_excessive_bools)]
pub struct Cli {
    /// Subcommand to execute
    #[command(subcommand)]
    pub command: Option<Commands>,

    /// Input file(s) or glob pattern
    #[arg(value_name = "FILE")]
    pub files: Vec<PathBuf>,

    /// Configuration file path
    #[arg(short, long, value_name = "FILE")]
    pub config: Option<PathBuf>,

    /// Modify files in-place
    #[arg(short, long)]
    pub in_place: bool,

    /// Output file (only for single input file)
    #[arg(short, long, value_name = "FILE")]
    pub output: Option<PathBuf>,

    /// Write to stdout (default when not --in-place)
    #[arg(long)]
    pub stdout: bool,

    /// Process files matching glob pattern
    #[arg(short, long)]
    pub glob: bool,

    /// Verbose output
    #[arg(short, long)]
    pub verbose: bool,

    /// Check mode: exit with error if files need formatting
    #[arg(long)]
    pub check: bool,

    /// Dry run: analyze files and report issues without modifying them
    #[arg(long)]
    pub dry_run: bool,
}

/// Subcommands for beautiful-md.
#[derive(Subcommand, Debug)]
pub enum Commands {
    /// Format markdown file(s)
    Format {
        /// Files to format
        files: Vec<PathBuf>,

        /// Modify files in-place
        #[arg(short, long)]
        in_place: bool,
    },

    /// Generate a default configuration file
    Config {
        /// Output path for config file
        #[arg(default_value = ".beautiful-md.toml")]
        output: PathBuf,
    },

    /// Check if files need formatting
    Check {
        /// Files to check
        files: Vec<PathBuf>,
    },
}

impl Cli {
    /// Create a new CLI instance from command-line arguments.
    pub fn parse_args() -> Self {
        Self::parse()
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_cli_parsing() {
        let cli = Cli::parse_from(["beautiful-md", "test.md"]);
        assert_eq!(cli.files.len(), 1);
        assert!(!cli.in_place);
    }

    #[test]
    fn test_cli_in_place() {
        let cli = Cli::parse_from(["beautiful-md", "--in-place", "test.md"]);
        assert!(cli.in_place);
    }
}