emmylua_doc_cli 0.14.0

A command-line tool for generating lua documentation.
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

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

#[derive(Debug, Parser)]
#[command(version)]
pub struct CmdArgs {
    /// Configuration file paths.
    /// If not provided, both ".emmyrc.json" and ".luarc.json" will be searched in the workspace
    /// directory
    #[arg(short, long, value_delimiter = ',')]
    pub config: Option<Vec<PathBuf>>,

    /// Deprecated, use [WORKSPACE] instead
    #[arg(short, long, num_args = 1..)]
    pub input: Vec<PathBuf>,

    /// Path to the workspace directory
    #[arg(num_args = 1..)]
    pub workspace: Vec<PathBuf>,

    /// Comma separated list of ignore patterns.
    /// Patterns must follow glob syntax
    #[arg(long, value_delimiter = ',')]
    pub ignore: Option<Vec<String>>,

    /// Specify output format
    #[arg(
        long,
        short = 'f',
        default_value = "markdown",
        value_enum,
        ignore_case = true
    )]
    pub output_format: Format,

    /// Deprecated, use --output-format instead
    #[arg(long, value_enum, ignore_case = true)]
    pub format: Option<Format>,

    /// Specify output destination (can be stdout when output_format is json)
    #[arg(long, short, default_value = "./output")]
    pub output: OutputDestination,

    /// The path of the override template
    #[arg(long)]
    pub override_template: Option<PathBuf>,

    #[arg(long, default_value = "Docs")]
    pub site_name: Option<String>,

    /// A directory whose contents are merged with the generated Markdown files.
    /// For example, to override docs/index.md, create a folder called "docs" in
    /// your mixin folder and create a file called "index.md" inside it.
    #[arg(long)]
    pub mixin: Option<PathBuf>,

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

#[derive(Debug, Clone, Eq, PartialEq, ValueEnum)]
pub enum Format {
    Json,
    Markdown,
}

#[allow(unused)]
#[derive(Debug, Clone)]
pub enum OutputDestination {
    Stdout,
    File(PathBuf),
}

impl std::str::FromStr for OutputDestination {
    type Err = String;
    fn from_str(s: &str) -> Result<Self, Self::Err> {
        match s.to_lowercase().as_str() {
            "stdout" => Ok(OutputDestination::Stdout),
            _ => Ok(OutputDestination::File(PathBuf::from(s))),
        }
    }
}