Switch from structopt to clap

src/cli/build.rs

@@ -4,9 +4,9 @@ use std::{
 };
 
 use anyhow::Context;
+use clap::Parser;
 use fs_err::File;
 use memofs::Vfs;
-use structopt::StructOpt;
 use tokio::runtime::Runtime;
 
 use crate::serve_session::ServeSession;
@@ -17,20 +17,20 @@ const UNKNOWN_OUTPUT_KIND_ERR: &str = "Could not detect what kind of file to bui
                                        Expected output file to end in .rbxl, .rbxlx, .rbxm, or .rbxmx.";
 
 /// Generates a model or place file from the Rojo project.
-#[derive(Debug, StructOpt)]
+#[derive(Debug, Parser)]
 pub struct BuildCommand {
     /// Path to the project to serve. Defaults to the current directory.
-    #[structopt(default_value = "")]
+    #[clap(default_value = "")]
     pub project: PathBuf,
 
     /// Where to output the result.
     ///
     /// Should end in .rbxm, .rbxl, .rbxmx, or .rbxlx.
-    #[structopt(long, short)]
+    #[clap(long, short)]
     pub output: PathBuf,
 
     /// Whether to automatically rebuild when any input files change.
-    #[structopt(long)]
+    #[clap(long)]
     pub watch: bool,
 }
 

src/cli/doc.rs

@@ -1,7 +1,7 @@
-use structopt::StructOpt;
+use clap::Parser;
 
 /// Open Rojo's documentation in your browser.
-#[derive(Debug, StructOpt)]
+#[derive(Debug, Parser)]
 pub struct DocCommand {}
 
 impl DocCommand {

src/cli/fmt_project.rs

@@ -1,15 +1,15 @@
 use std::path::PathBuf;
 
 use anyhow::Context;
-use structopt::StructOpt;
+use clap::Parser;
 
 use crate::project::Project;
 
 /// Reformat a Rojo project using the standard JSON formatting rules.
-#[derive(Debug, StructOpt)]
+#[derive(Debug, Parser)]
 pub struct FmtProjectCommand {
     /// Path to the project to format. Defaults to the current directory.
-    #[structopt(default_value = "")]
+    #[clap(default_value = "")]
     pub project: PathBuf,
 }
 

src/cli/init.rs

@@ -4,9 +4,9 @@ use std::process::{Command, Stdio};
 use std::str::FromStr;
 
 use anyhow::{bail, format_err};
+use clap::Parser;
 use fs_err as fs;
 use fs_err::OpenOptions;
-use structopt::StructOpt;
 
 use super::resolve_path;
 
@@ -22,14 +22,14 @@ static PLACE_README: &str = include_str!("../../assets/default-place-project/REA
 static PLACE_GIT_IGNORE: &str = include_str!("../../assets/default-place-project/gitignore.txt");
 
 /// Initializes a new Rojo project.
-#[derive(Debug, StructOpt)]
+#[derive(Debug, Parser)]
 pub struct InitCommand {
     /// Path to the place to create the project. Defaults to the current directory.
-    #[structopt(default_value = "")]
+    #[clap(default_value = "")]
     pub path: PathBuf,
 
     /// The kind of project to create, 'place' or 'model'. Defaults to place.
-    #[structopt(long, default_value = "place")]
+    #[clap(long, default_value = "place")]
     pub kind: InitKind,
 }
 

src/cli/mod.rs

@@ -1,4 +1,4 @@
-//! Defines Rojo's CLI through structopt types.
+//! Defines Rojo's CLI through clap types.
 
 mod build;
 mod doc;
@@ -11,7 +11,7 @@ mod upload;
 
 use std::{borrow::Cow, env, path::Path, str::FromStr};
 
-use structopt::StructOpt;
+use clap::Parser;
 use thiserror::Error;
 
 pub use self::build::BuildCommand;
@@ -23,15 +23,15 @@ pub use self::serve::ServeCommand;
 pub use self::sourcemap::SourcemapCommand;
 pub use self::upload::UploadCommand;
 
-/// Command line options that Rojo accepts, defined using the structopt crate.
-#[derive(Debug, StructOpt)]
-#[structopt(name = "Rojo", about, author)]
+/// Command line options that Rojo accepts, defined using the clap crate.
+#[derive(Debug, Parser)]
+#[clap(name = "Rojo", version, about, author)]
 pub struct Options {
-    #[structopt(flatten)]
+    #[clap(flatten)]
     pub global: GlobalOptions,
 
     /// Subcommand to run in this invocation.
-    #[structopt(subcommand)]
+    #[clap(subcommand)]
     pub subcommand: Subcommand,
 }
 
@@ -50,14 +50,14 @@ impl Options {
     }
 }
 
-#[derive(Debug, StructOpt)]
+#[derive(Debug, Parser)]
 pub struct GlobalOptions {
     /// Sets verbosity level. Can be specified multiple times.
-    #[structopt(long("verbose"), short, global(true), parse(from_occurrences))]
+    #[clap(long("verbose"), short, global(true), parse(from_occurrences))]
     pub verbosity: u8,
 
     /// Set color behavior. Valid values are auto, always, and never.
-    #[structopt(long("color"), global(true), default_value("auto"))]
+    #[clap(long("color"), global(true), default_value("auto"))]
     pub color: ColorChoice,
 }
 
@@ -109,7 +109,7 @@ pub struct ColorChoiceParseError {
     attempted: String,
 }
 
-#[derive(Debug, StructOpt)]
+#[derive(Debug, Parser)]
 pub enum Subcommand {
     Init(InitCommand),
     Serve(ServeCommand),

src/cli/plugin.rs

@@ -3,9 +3,9 @@ use std::{
     io::BufWriter,
 };
 
+use clap::Parser;
 use memofs::{InMemoryFs, Vfs, VfsSnapshot};
 use roblox_install::RobloxStudio;
-use structopt::StructOpt;
 
 use crate::serve_session::ServeSession;
 
@@ -13,14 +13,14 @@ static PLUGIN_BINCODE: &[u8] = include_bytes!(concat!(env!("OUT_DIR"), "/plugin.
 static PLUGIN_FILE_NAME: &str = "RojoManagedPlugin.rbxm";
 
 /// Install Rojo's plugin.
-#[derive(Debug, StructOpt)]
+#[derive(Debug, Parser)]
 pub struct PluginCommand {
-    #[structopt(subcommand)]
+    #[clap(subcommand)]
     subcommand: PluginSubcommand,
 }
 
 /// Manages Rojo's Roblox Studio plugin.
-#[derive(Debug, StructOpt)]
+#[derive(Debug, Parser)]
 pub enum PluginSubcommand {
     /// Install the plugin in Roblox Studio's plugins folder. If the plugin is
     /// already installed, installing it again will overwrite the current plugin

src/cli/serve.rs

@@ -5,8 +5,8 @@ use std::{
     sync::Arc,
 };
 
+use clap::Parser;
 use memofs::Vfs;
-use structopt::StructOpt;
 use termcolor::{BufferWriter, Color, ColorChoice, ColorSpec, WriteColor};
 
 use crate::{serve_session::ServeSession, web::LiveServer};
@@ -17,19 +17,19 @@ const DEFAULT_BIND_ADDRESS: Ipv4Addr = Ipv4Addr::new(127, 0, 0, 1);
 const DEFAULT_PORT: u16 = 34872;
 
 /// Expose a Rojo project to the Rojo Studio plugin.
-#[derive(Debug, StructOpt)]
+#[derive(Debug, Parser)]
 pub struct ServeCommand {
     /// Path to the project to serve. Defaults to the current directory.
-    #[structopt(default_value = "")]
+    #[clap(default_value = "")]
     pub project: PathBuf,
 
     /// The IP address to listen on. Defaults to `127.0.0.1`.
-    #[structopt(long)]
+    #[clap(long)]
     pub address: Option<IpAddr>,
 
     /// The port to listen on. Defaults to the project's preference, or `34872` if
     /// it has none.
-    #[structopt(long)]
+    #[clap(long)]
     pub port: Option<u16>,
 }
 

src/cli/sourcemap.rs

@@ -3,11 +3,11 @@ use std::{
     path::{Path, PathBuf},
 };
 
+use clap::Parser;
 use fs_err::File;
 use memofs::Vfs;
 use rbx_dom_weak::types::Ref;
 use serde::Serialize;
-use structopt::StructOpt;
 
 use crate::{
     serve_session::ServeSession,
@@ -33,22 +33,22 @@ struct SourcemapNode {
 }
 
 /// Generates a sourcemap file from the Rojo project.
-#[derive(Debug, StructOpt)]
+#[derive(Debug, Parser)]
 pub struct SourcemapCommand {
     /// Path to the project to use for the sourcemap. Defaults to the current
     /// directory.
-    #[structopt(default_value = "")]
+    #[clap(default_value = "")]
     pub project: PathBuf,
 
     /// Where to output the sourcemap. Omit this to use stdout instead of
     /// writing to a file.
     ///
     /// Should end in .json.
-    #[structopt(long, short)]
+    #[clap(long, short)]
     pub output: Option<PathBuf>,
 
     /// If non-script files should be included or not. Defaults to false.
-    #[structopt(long)]
+    #[clap(long)]
     pub include_non_scripts: bool,
 }
 

src/cli/upload.rs

@@ -2,38 +2,38 @@ use std::path::PathBuf;
 use std::str::FromStr;
 
 use anyhow::{bail, format_err, Context};
+use clap::Parser;
 use memofs::Vfs;
 use reqwest::{
     header::{ACCEPT, CONTENT_TYPE, COOKIE, USER_AGENT},
     StatusCode,
 };
-use structopt::StructOpt;
 
 use crate::{auth_cookie::get_auth_cookie, serve_session::ServeSession};
 
 use super::resolve_path;
 
 /// Builds the project and uploads it to Roblox.
-#[derive(Debug, StructOpt)]
+#[derive(Debug, Parser)]
 pub struct UploadCommand {
     /// Path to the project to upload. Defaults to the current directory.
-    #[structopt(default_value = "")]
+    #[clap(default_value = "")]
     pub project: PathBuf,
 
     /// Authenication cookie to use. If not specified, Rojo will attempt to find one from the system automatically.
-    #[structopt(long)]
+    #[clap(long)]
     pub cookie: Option<String>,
 
     /// API key obtained from create.roblox.com/credentials. Rojo will use the Open Cloud API when this is provided. Only supports uploading to a place.
-    #[structopt(long = "api_key")]
+    #[clap(long = "api_key")]
     pub api_key: Option<String>,
 
     /// The Universe ID of the given place. Required when using the Open Cloud API.
-    #[structopt(long = "universe_id")]
+    #[clap(long = "universe_id")]
     pub universe_id: Option<u64>,
 
     /// Asset ID to upload to.
-    #[structopt(long = "asset_id")]
+    #[clap(long = "asset_id")]
     pub asset_id: u64,
 }