gen-mdbook-summary 0.0.9

A tool to generate SUMMARY.md for mdbook project
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
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132

use std::process::exit;

use clap::Args;
use clap::Parser;
use gen_mdbook_summary::Ignore;
use gen_mdbook_summary::SummaryItem;
use log::error;
use log::info;

use indoc::indoc;

pub const IGNORE_FILE: &str = ".gmsignore";

#[derive(Parser)]
#[command(version, about, long_about = None)]
pub struct Cli2 {
    #[command(subcommand)]
    pub cmd: Option<Cmd>,
    #[command(flatten)]
    pub gen_args: GenArgs,
}

#[derive(Clone, clap::Subcommand)]
pub enum Cmd {
    /// initialize the .gmsignore file
    /// This file is the default ignore file for the summary generator,
    /// it will be used to ignore files that should not be included in the summary.
    /// You can modify it to suit your needs.
    /// If you want to use a different ignore file, you can specify it with the --ignore option.
    #[command(about = "initialize the .gmsignore file")]
    Init,
    /// generate the summary file
    Gen(GenArgs),
}

#[derive(Args, Clone, Debug)]
pub struct GenArgs {
    /// Optional name to operate on
    #[arg(short, long, default_value = "src")]
    pub dir: String,
    /// specify the output file
    #[arg(short, long)]
    pub output: Option<String>,
    /// if organize the items in order
    #[arg(short, long, default_value = "true")]
    pub sort: bool,
    #[arg(
        short,
        long,
        default_value = IGNORE_FILE,
        help = "specify the ignore file ,using .gitignore grammar,
    matched files will be ignored."
    )]
    pub ignore: String,
}

#[derive(Parser, Debug)]
#[command(version, about, long_about = None)]
pub struct Cli {
    /// Optional name to operate on
    #[arg(short, long, default_value = "src")]
    pub dir: String,
    /// specify the output file
    #[arg(short, long)]
    pub output: Option<String>,
    /// if organize the items in order
    #[arg(short, long, default_value = "true")]
    pub sort: bool,
    #[arg(
        short,
        long,
        default_value = IGNORE_FILE,
        help = "specify the ignore file ,using .gitignore grammar,
    matched files will be ignored."
    )]
    pub ignore: String,
}

pub fn handle_gen(gen_args: &GenArgs) -> anyhow::Result<()> {
    let ignore = Ignore::new(&gen_args.dir, &gen_args.ignore).unwrap_or_else(|e| {
        error!("{}", e);
        exit(-1);
    });
    info!("{:?}", &ignore);

    // 使用绝对路径作为 base_dir
    let base_dir = std::path::Path::new(&gen_args.dir).canonicalize()?;
    let mut summary = SummaryItem::new(&gen_args.dir, &ignore, &base_dir).unwrap_or_else(|e| {
        error!("{}", e);
        exit(-1);
    });
    info!("{:?}", &summary);
    if gen_args.sort {
        info!("sort the summary");
        summary.sort();
    }
    match summary.gen_summary() {
        Ok(summary) => {
            if let Some(output) = &gen_args.output {
                info!("output SUMMARY.md to {}", output);
                if let Err(e) = std::fs::write(output, summary) {
                    error!("{}", e);
                    exit(-1);
                }
            } else {
                println!("{}", summary);
            }
        }
        Err(e) => {
            panic!("{}", e);
        }
    }
    Ok(())
}

pub fn handle_init() -> anyhow::Result<()> {
    std::fs::write(
        IGNORE_FILE,
        indoc! {r##"
            book.toml
            .gitignore
            book
            *.doc
            *.pdf
            *.png
            *.xlsx
            *.pptx
            *.jpg
        "##},
    )?;
    Ok(())
}