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
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
use clap::{ArgEnum, StructOpt};
use std::path::PathBuf;
use stylua_lib::{
BlockNewlineGaps, CallParenType, CollapseSimpleStatement, IndentType, LineEndings, LuaVersion,
QuoteStyle, SpaceAfterFunctionNames,
};
lazy_static::lazy_static! {
static ref NUM_CPUS: String = num_cpus::get().to_string();
}
#[derive(StructOpt, Clone, Debug)]
#[structopt(name = "stylua", about = "A utility to format Lua code", version)]
pub struct Opt {
/// Specify path to stylua.toml configuration file.
///
/// If not provided, defaults to looking in the current directory for a configuration file.
#[structopt(long = "config-path", short = 'f', parse(from_os_str))]
pub config_path: Option<PathBuf>,
/// Specify the location of the file that is being passed into stdin.
/// Ignored if not taking in input from stdin.
///
/// This option is only used to help determine where to find the configuration file.
#[structopt(long = "stdin-filepath", parse(from_os_str))]
pub stdin_filepath: Option<PathBuf>,
/// Search parent directories for stylua.toml, if not found in current directory.
/// Ignored if config_path is provided.
///
/// Keeps searching recursively up the parent directory tree, until the root directory is reached.
/// If not found, looks in $XDG_CONFIG_HOME or $XDG_CONFIG_HOME/stylua.
#[structopt(short, long)]
pub search_parent_directories: bool,
/// Runs in 'check' mode.
///
/// Compares a diff between all input files to determine if they are formatted.
/// Exits with 0 if all formatting is OK,
/// Exits with 1 if any formatting is incorrect, outputting file diffs.
/// Any files input will not be overwritten.
#[structopt(short, long)]
pub check: bool,
/// Configures the diff output when using 'check' mode.
///
/// This option is ignored if 'check' is not enabled.
#[structopt(long, arg_enum, ignore_case = true, default_value_t = OutputFormat::Standard)]
pub output_format: OutputFormat,
/// Verifies the output correctness after formatting.
///
/// Checks the generated AST with the original AST to detect if code correctness has changed.
#[structopt(long)]
pub verify: bool,
/// Enables verbose output
#[structopt(short, long)]
pub verbose: bool,
/// Use colored output.
#[structopt(long, ignore_case = true, default_value_t = Color::Auto, arg_enum)]
pub color: Color,
/// Glob patterns to test against which files to check.
///
/// To ignore a specific glob pattern, begin the glob pattern with `!`
#[structopt(short, long)]
pub glob: Option<Vec<String>>,
/// The number of threads to use to format files in parallel.
///
/// Defaults to the number of logical cores on your system.
#[structopt(long, default_value = &NUM_CPUS)]
pub num_threads: usize,
/// A starting range to format files, given as a byte offset from the beginning of the file.
///
/// Any content before this value will be ignored.
#[structopt(long)]
pub range_start: Option<usize>,
/// An ending range to format files, given as a byte offset from the beginning of the file.
///
/// Any content after this value will be ignored.
#[structopt(long)]
pub range_end: Option<usize>,
/// Formatting options to apply when formatting code.
#[structopt(flatten, next_help_heading = "FORMATTING OPTIONS")]
pub format_opts: FormatOpts,
/// A list of files to format
#[structopt(parse(from_os_str))]
pub files: Vec<PathBuf>,
/// Whether to traverse hidden files/directories.
#[structopt(short, long)]
pub allow_hidden: bool,
/// Whether to continue formatting files that are excluded from version control (e.g., listed in .gitignore)
#[structopt(long)]
pub no_ignore_vcs: bool,
/// Disables the EditorConfig feature.
///
/// Has no effect if a stylua.toml configuration file is found.
#[cfg(feature = "editorconfig")]
#[structopt(long)]
pub no_editorconfig: bool,
/// Respect .styluaignore and glob matching for file paths provided directly to the tool
#[structopt(long)]
pub respect_ignores: bool,
/// Run Stylua as a language server (following LSP protocol)
#[structopt(long)]
pub lsp: bool,
}
#[derive(ArgEnum, Clone, Copy, Debug, PartialEq, Eq)]
#[clap(rename_all = "PascalCase")]
pub enum Color {
/// Always use colour
Always,
/// Checks the terminal features to determine whether to apply colour
Auto,
/// Never use colour
Never,
}
impl Color {
pub fn should_use_color(&self) -> bool {
match self {
Color::Always => true,
Color::Never => false,
Color::Auto => {
let terminal = console::Term::stdout();
let features = terminal.features();
features.is_attended() && features.colors_supported()
}
}
}
pub fn should_use_color_stderr(&self) -> bool {
match self {
Color::Always => true,
Color::Never => false,
Color::Auto => {
let terminal = console::Term::stderr();
let features = terminal.features();
features.is_attended() && features.colors_supported()
}
}
}
}
#[derive(ArgEnum, Clone, Copy, Debug)]
#[clap(rename_all = "PascalCase")]
pub enum OutputFormat {
/// Outputs using the standard inbuilt pretty-diff design
Standard,
/// Outputs using unified diff formatting
Unified,
/// Outputs in json
Json,
/// Outputs a human-friendly summary
Summary,
}
#[derive(StructOpt, Clone, Copy, Debug)]
pub struct FormatOpts {
/// The type of Lua syntax to parse
#[structopt(long, arg_enum, ignore_case = true)]
pub syntax: Option<ArgLuaVersion>,
/// The column width to use to attempt to wrap lines.
#[structopt(long)]
pub column_width: Option<usize>,
/// The type of line endings to use.
#[structopt(long, arg_enum, ignore_case = true)]
pub line_endings: Option<ArgLineEndings>,
/// The type of indents to use.
#[structopt(long, arg_enum, ignore_case = true)]
pub indent_type: Option<ArgIndentType>,
/// The width of a single indentation level.
#[structopt(long)]
pub indent_width: Option<usize>,
/// The style of quotes to use in string literals.
#[structopt(long, arg_enum, ignore_case = true)]
pub quote_style: Option<ArgQuoteStyle>,
/// Specify whether to apply parentheses on function calls with single string or table arg.
#[structopt(long, arg_enum, ignore_case = true)]
pub call_parentheses: Option<ArgCallParenType>,
/// Specify whether to collapse simple statements.
#[structopt(long, arg_enum, ignore_case = true)]
pub collapse_simple_statement: Option<ArgCollapseSimpleStatement>,
/// Specify whether to preserve leading and trailing newline gaps for blocks.
#[structopt(long, arg_enum, ignore_case = true)]
pub preserve_block_newline_gaps: Option<ArgBlockNewlineGaps>,
/// Enable requires sorting
#[structopt(long)]
pub sort_requires: bool,
#[structopt(long, arg_enum, ignore_case = true)]
pub space_after_function_names: Option<ArgSpaceAfterFunctionNames>,
}
// Convert [`stylua_lib::Config`] enums into clap-friendly enums
macro_rules! convert_enum {
($from:tt, $arg:tt, { $($(#[$inner:meta])* $enum_name:ident,)+ }) => {
#[derive(ArgEnum, Clone, Copy, Debug)]
#[clap(rename_all = "PascalCase")]
pub enum $arg {
$(
$(#[$inner])*
$enum_name,
)+
}
impl From<$arg> for $from {
fn from(other: $arg) -> $from {
match other {
$(
$(#[$inner])*
$arg::$enum_name => $from::$enum_name,
)+
}
}
}
impl From<$from> for $arg {
fn from(other: $from) -> $arg {
match other {
$(
$(#[$inner])*
$from::$enum_name => $arg::$enum_name,
)+
}
}
}
};
}
convert_enum!(LuaVersion, ArgLuaVersion, {
All,
Lua51,
#[cfg(feature = "lua52")] Lua52,
#[cfg(feature = "lua53")] Lua53,
#[cfg(feature = "lua54")] Lua54,
#[cfg(feature = "luau")] Luau,
#[cfg(feature = "luajit")] LuaJIT,
#[cfg(feature = "cfxlua")] CfxLua,
});
convert_enum!(LineEndings, ArgLineEndings, {
Unix,
Windows,
});
convert_enum!(IndentType, ArgIndentType, {
Tabs,
Spaces,
});
convert_enum!(QuoteStyle, ArgQuoteStyle, {
AutoPreferDouble,
AutoPreferSingle,
ForceDouble,
ForceSingle,
});
convert_enum!(CallParenType, ArgCallParenType, {
Always,
NoSingleString,
NoSingleTable,
None,
Input,
});
convert_enum!(CollapseSimpleStatement, ArgCollapseSimpleStatement, {
Never,
FunctionOnly,
ConditionalOnly,
Always,
});
convert_enum!(BlockNewlineGaps, ArgBlockNewlineGaps, {
Never,
Preserve,
});
convert_enum!(SpaceAfterFunctionNames, ArgSpaceAfterFunctionNames, {
Never,
Definitions,
Calls,
Always,
});
#[cfg(test)]
mod tests {
use super::Opt;
use clap::IntoApp;
#[test]
fn verify_opt() {
Opt::command().debug_assert()
}
}