migrate from structopt to clap

Author: lewis6991

Cargo.lock

@@ -31,7 +31,6 @@ walkdir = "2.5.0"
 serde_yml = "0.0.12"
 dirs = "5"
 emmylua_codestyle = "0.4.1"
-structopt = "0.3"
 wax = "0.6.0"
 percent-encoding = "2.3"
 flagset = "0.4.6"
@@ -48,3 +47,4 @@ include_dir = "0.7.4"
 toml_edit = "0.22.23"
 itertools = "0.11.0"
 ariadne = { version = "0.5.0", features = ["auto-color"] }
+clap = { version = "4.5.39", features = ["derive", "wrap_help"] }

Cargo.toml

@@ -23,7 +23,7 @@ log.workspace = true
 fern.workspace = true
 rowan.workspace = true
 walkdir.workspace = true
-structopt.workspace = true
 tokio.workspace = true
 tokio-util.workspace = true
 ariadne.workspace = true
+clap.workspace = true

crates/emmylua_check/Cargo.toml

@@ -1,82 +1,59 @@
-use structopt::StructOpt;
+use clap::{Parser, ValueEnum};
+use std::path::PathBuf;
 
 #[allow(unused)]
-#[derive(Debug, StructOpt, Clone)]
-#[structopt(name = "emmylua-check", about = "EmmyLua Check")]
+#[derive(Debug, Parser, Clone)]
 pub struct CmdArgs {
     /// Configuration file paths.
     /// If not provided, both ".emmyrc.json" and ".luarc.json" will be searched in the workspace
     /// directory
-    #[structopt(short, long, use_delimiter = true, parse(from_os_str))]
-    pub config: Option<Vec<std::path::PathBuf>>,
+    #[arg(short, long, value_delimiter = ',')]
+    pub config: Option<Vec<PathBuf>>,
 
     /// Path to the workspace directory
-    #[structopt(parse(from_os_str))]
-    pub workspace: std::path::PathBuf,
+    pub workspace: PathBuf,
 
     /// Comma separated list of ignore patterns.
     /// Patterns must follow glob syntax
-    #[structopt(short, long, use_delimiter = true)]
+    #[arg(short, long, value_delimiter = ',')]
     pub ignore: Option<Vec<String>>,
 
     /// Specify output format
-    #[structopt(
-        long,
-        default_value = "text",
-        possible_values = &OutputFormat::variants(),
-        case_insensitive = true
-    )]
+    #[arg(long, default_value = "text", value_enum, ignore_case = true)]
     pub output_format: OutputFormat,
 
     /// Specify output destination (stdout or a file path, only used when output_format is json).
-    #[structopt(long, default_value = "stdout", parse(try_from_str))]
+    #[arg(long, default_value = "stdout")]
     pub output: OutputDestination,
 
     /// Treat warnings as errors
-    #[structopt(long)]
+    #[arg(long)]
     pub warnings_as_errors: bool,
 
     /// Verbose output
-    #[structopt(long)]
+    #[arg(long)]
     pub verbose: bool,
 }
 
-#[derive(Debug, Clone, PartialEq)]
+#[derive(Debug, Clone, PartialEq, ValueEnum)]
 pub enum OutputFormat {
     Json,
     Text,
 }
 
-impl std::str::FromStr for OutputFormat {
-    type Err = String;
-    fn from_str(s: &str) -> Result<Self, Self::Err> {
-        match s.to_lowercase().as_str() {
-            "json" => Ok(OutputFormat::Json),
-            "text" => Ok(OutputFormat::Text),
-            _ => Err(format!("Invalid output format: {}", s)),
-        }
-    }
-}
-
-impl OutputFormat {
-    pub fn variants() -> [&'static str; 2] {
-        ["json", "text"]
-    }
-}
-
 #[allow(unused)]
 #[derive(Debug, Clone)]
 pub enum OutputDestination {
     Stdout,
-    File(std::path::PathBuf),
+    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(std::path::PathBuf::from(s))),
+            _ => Ok(OutputDestination::File(PathBuf::from(s))),
         }
     }
 }

crates/emmylua_check/src/cmd_args.rs

@@ -50,7 +50,10 @@ pub fn load_workspace(
                 vec![
                     main_path.join(".luarc.json"),
                     main_path.join(".emmyrc.json"),
-                ],
+                ]
+                .into_iter()
+                .filter(|path| path.exists())
+                .collect(),
                 main_path.clone(),
             )
         };

crates/emmylua_check/src/init.rs

@@ -2,18 +2,18 @@ mod cmd_args;
 mod init;
 mod output;
 
+use clap::Parser;
 use cmd_args::CmdArgs;
 use emmylua_code_analysis::{DbIndex, FileId};
 use fern::Dispatch;
 use log::LevelFilter;
 use output::output_result;
 use std::{error::Error, path::PathBuf, sync::Arc};
-use structopt::StructOpt;
 use tokio_util::sync::CancellationToken;
 
 #[tokio::main]
 async fn main() -> Result<(), Box<dyn Error + Sync + Send>> {
-    let cmd_args = CmdArgs::from_args();
+    let cmd_args = CmdArgs::parse();
     let mut workspace = cmd_args.workspace;
     if !workspace.is_absolute() {
         workspace = std::env::current_dir()?.join(workspace);

crates/emmylua_check/src/main.rs

@@ -26,6 +26,6 @@ serde_json.workspace = true
 lsp-types.workspace = true
 rowan.workspace = true
 walkdir.workspace = true
-structopt.workspace = true
 tera.workspace = true
 include_dir.workspace = true
+clap.workspace = true

crates/emmylua_doc_cli/Cargo.toml

@@ -1,55 +1,36 @@
-use std::str::FromStr;
-use structopt::StructOpt;
+use clap::{Parser, ValueEnum};
+use std::path::PathBuf;
 
-#[derive(Debug, StructOpt)]
+#[derive(Debug, Parser)]
 pub struct CmdArgs {
-    #[structopt(
-        parse(from_os_str),
-        long = "input",
-        short = "i",
-        help = "The path of the lua project"
-    )]
-    pub input: std::path::PathBuf,
-
-    #[structopt(
-        default_value = "markdown",
-        long = "format",
-        short = "f",
-        help = "Format of the output, default is Markdown"
-    )]
+    /// The path of the lua project
+    #[arg(long, short)]
+    pub input: PathBuf,
+
+    /// Format of the output, default is Markdown
+    #[arg(long, short, default_value = "markdown")]
     pub format: Format,
 
-    #[structopt(
-        parse(from_os_str),
-        default_value = "./output",
-        long = "output",
-        short = "o",
-        help = "The output path of the docs file"
-    )]
-    pub output: std::path::PathBuf,
-
-    #[structopt(
-        parse(from_os_str),
-        long = "override-template",
-        help = "The path of the override template"
-    )]
-    pub override_template: Option<std::path::PathBuf>,
-
-    #[structopt(
-        parse(from_os_str),
-        long = "mixin",
-        help = "The path of the mixin md file"
-    )]
-    pub mixin: Option<std::path::PathBuf>,
+    /// The output path of the docs file
+    #[arg(long, short, default_value = "./output")]
+    pub output: PathBuf,
+
+    /// The path of the override template
+    #[arg(long)]
+    pub override_template: Option<PathBuf>,
+
+    /// The path of the mixin md file
+    #[arg(long)]
+    pub mixin: Option<PathBuf>,
 }
 
-#[derive(Debug, Eq, PartialEq, StructOpt)]
+#[derive(Debug, Clone, Eq, PartialEq, ValueEnum)]
 pub enum Format {
     Markdown,
     Json,
 }
 
-impl FromStr for Format {
+impl std::str::FromStr for Format {
     type Err = &'static str;
 
     fn from_str(s: &str) -> Result<Self, Self::Err> {

crates/emmylua_doc_cli/src/cmd_args.rs

@@ -1,7 +1,7 @@
 use crate::cmd_args::Format;
+use clap::Parser;
 use cmd_args::CmdArgs;
 use std::process::exit;
-use structopt::StructOpt;
 
 mod cmd_args;
 mod common;
@@ -10,7 +10,7 @@ mod json_generator;
 mod markdown_generator;
 
 fn main() {
-    let args = CmdArgs::from_args();
+    let args = CmdArgs::parse();
     let mut input = args.input;
     if input.is_relative() {
         input = std::env::current_dir().ok().unwrap().join(&input);

crates/emmylua_doc_cli/src/main.rs

@@ -28,9 +28,9 @@ notify.workspace = true
 tokio-util.workspace = true
 rowan.workspace = true
 walkdir.workspace = true
-structopt.workspace = true
 rust-i18n.workspace = true
 glob.workspace = true
 serde_yml.workspace = true
 itertools.workspace = true
 dirs.workspace = true
+clap.workspace = true