esmeril 0.2.0

Scaffold, validate, format, audit and build Roblox Luau projects from the terminal
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
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151

use clap::{Parser, Subcommand};

#[derive(Parser)]
#[command(
    name = "esmeril",
    version,
    about = "Scaffold, validate, format, audit and build Roblox Luau projects from the terminal"
)]
pub struct Cli {
    #[command(subcommand)]
    pub command: Commands,

    #[arg(
        global = true,
        long,
        id = "json_out",
        help = "Emit machine-readable JSON to stdout instead of the table"
    )]
    pub json: bool,
}

#[derive(Subcommand)]
pub enum Commands {
    #[command(
        about = "Scaffold a modern Roblox project: Rojo, Selene, StyLua, Aftman, Wally and CI"
    )]
    Init(InitArgs),
    #[command(about = "Inspect a project: tooling configs, structure and an A-F grade")]
    Check(CheckArgs),
    #[command(about = "Audit wally.toml dependencies against the package registry")]
    Deps(DepsArgs),
    #[command(about = "Bump wally.toml requirements to the latest published versions")]
    Update(UpdateArgs),
    #[command(about = "Run the formatter and linter on the source tree")]
    Fmt(FmtArgs),
    #[command(about = "Check the project and build it with Rojo")]
    Build(BuildArgs),
    #[command(about = "Check the local toolchain: rojo, selene, stylua, wally and aftman")]
    Doctor,
    #[command(about = "Generate shell completion scripts")]
    Completions {
        #[arg(
            value_enum,
            help = "Shell to generate for: bash, zsh, fish, powershell, elvish"
        )]
        shell: clap_complete::Shell,
    },
}

#[derive(clap::Args)]
pub struct InitArgs {
    #[arg(help = "Directory to create; defaults to the current directory name")]
    pub name: Option<String>,

    #[arg(long, help = "Use Luau language mode Strict instead of NonStrict")]
    pub strict: bool,

    #[arg(
        long,
        help = "Scaffold a library package (for publishing to Wally) instead of a game"
    )]
    pub lib: bool,

    #[arg(long, help = "Overwrite files when the target directory is not empty")]
    pub force: bool,
}

#[derive(clap::Args)]
pub struct CheckArgs {
    #[arg(
        default_value = ".",
        help = "Project directory to inspect; defaults to the current directory"
    )]
    pub path: String,

    #[arg(
        long,
        help = "Create the standard files that are missing instead of only reporting"
    )]
    pub fix: bool,

    #[arg(
        long,
        help = "Print the report as a markdown table instead of the text report"
    )]
    pub markdown: bool,
}

#[derive(clap::Args)]
pub struct DepsArgs {
    #[arg(
        default_value = ".",
        help = "Project directory to inspect; defaults to the current directory"
    )]
    pub path: String,

    #[arg(
        long,
        help = "Use only the local index cache; fail when a package is not cached"
    )]
    pub offline: bool,
}

#[derive(clap::Args)]
pub struct FmtArgs {
    #[arg(
        default_value = ".",
        help = "Project directory to inspect; defaults to the current directory"
    )]
    pub path: String,

    #[arg(long, help = "Only report problems, do not format")]
    pub check: bool,
}

#[derive(clap::Args)]
pub struct BuildArgs {
    #[arg(
        default_value = ".",
        help = "Project directory to inspect; defaults to the current directory"
    )]
    pub path: String,

    #[arg(
        short,
        long,
        help = "Output file name (defaults to game.rbxl or lib.rbxm)"
    )]
    pub output: Option<String>,
}

#[derive(clap::Args)]
pub struct UpdateArgs {
    #[arg(
        default_value = ".",
        help = "Project directory to inspect; defaults to the current directory"
    )]
    pub path: String,

    #[arg(
        long,
        help = "Write the new requirements to wally.toml (dry-run by default)"
    )]
    pub write: bool,

    #[arg(
        long,
        help = "Use only the local index cache; fail when a package is not cached"
    )]
    pub offline: bool,
}