Migrate from gumdrop to clap

Closes #437.

Cargo.toml

@@ -61,7 +61,7 @@ rust-embed = "8"
 
 # CLI
 chrono = "0.4"
+clap = { version = "4.3", features = ["derive"] }
 console = { version = "0.15", default-features = false }
 env_logger = "0.10"
-gumdrop = "0.8"
 log = "0.4"

age-plugin/Cargo.toml

@@ -21,7 +21,7 @@ bech32.workspace = true
 chrono.workspace = true
 
 [dev-dependencies]
-gumdrop.workspace = true
+clap.workspace = true
 
 [lib]
 bench = false

age-plugin/README.md

@@ -67,7 +67,7 @@ users will use identity files containing identities that specify that plugin nam
 
 ## Example plugin binary
 
-The following example uses `gumdrop` to parse CLI arguments, but any argument parsing
+The following example uses `clap` to parse CLI arguments, but any argument parsing
 logic will work as long as it can detect the `--age-plugin=STATE_MACHINE` flag.
 
 ```rust
@@ -78,7 +78,8 @@ use age_plugin::{
     recipient::{self, RecipientPluginV1},
     Callbacks, run_state_machine,
 };
-use gumdrop::Options;
+use clap::Parser;
+
 use std::collections::HashMap;
 use std::io;
 
@@ -133,17 +134,14 @@ impl IdentityPluginV1 for IdentityPlugin {
     }
 }
 
-#[derive(Debug, Options)]
+#[derive(Debug, Parser)]
 struct PluginOptions {
-    #[options(help = "print help message")]
-    help: bool,
-
-    #[options(help = "run the given age plugin state machine", no_short)]
+    #[arg(help = "run the given age plugin state machine", long)]
     age_plugin: Option<String>,
 }
 
 fn main() -> io::Result<()> {
-    let opts = PluginOptions::parse_args_default_or_exit();
+    let opts = PluginOptions::parse();
 
     if let Some(state_machine) = opts.age_plugin {
         // The plugin was started by an age client; run the state machine.

age-plugin/examples/age-plugin-unencrypted.rs

@@ -8,7 +8,7 @@ use age_plugin::{
     recipient::{self, RecipientPluginV1},
     run_state_machine, Callbacks,
 };
-use gumdrop::Options;
+use clap::Parser;
 
 use std::collections::HashMap;
 use std::env;
@@ -139,17 +139,14 @@ impl IdentityPluginV1 for IdentityPlugin {
     }
 }
 
-#[derive(Debug, Options)]
+#[derive(Debug, Parser)]
 struct PluginOptions {
-    #[options(help = "print help message")]
-    help: bool,
-
-    #[options(help = "run the given age plugin state machine", no_short)]
+    #[arg(help = "run the given age plugin state machine", long)]
     age_plugin: Option<String>,
 }
 
 fn main() -> io::Result<()> {
-    let opts = PluginOptions::parse_args_default_or_exit();
+    let opts = PluginOptions::parse();
 
     if let Some(state_machine) = opts.age_plugin {
         run_state_machine(

age-plugin/src/lib.rs

@@ -65,7 +65,7 @@
 //!
 //! # Example plugin binary
 //!
-//! The following example uses `gumdrop` to parse CLI arguments, but any argument parsing
+//! The following example uses `clap` to parse CLI arguments, but any argument parsing
 //! logic will work as long as it can detect the `--age-plugin=STATE_MACHINE` flag.
 //!
 //! ```
@@ -76,7 +76,8 @@
 //!     recipient::{self, RecipientPluginV1},
 //!     Callbacks, run_state_machine,
 //! };
-//! use gumdrop::Options;
+//! use clap::Parser;
+//!
 //! use std::collections::HashMap;
 //! use std::io;
 //!
@@ -131,17 +132,14 @@
 //!     }
 //! }
 //!
-//! #[derive(Debug, Options)]
+//! #[derive(Debug, Parser)]
 //! struct PluginOptions {
-//!     #[options(help = "print help message")]
-//!     help: bool,
-//!
-//!     #[options(help = "run the given age plugin state machine", no_short)]
+//!     #[arg(help = "run the given age plugin state machine", long)]
 //!     age_plugin: Option<String>,
 //! }
 //!
 //! fn main() -> io::Result<()> {
-//!     let opts = PluginOptions::parse_args_default_or_exit();
+//!     let opts = PluginOptions::parse();
 //!
 //!     if let Some(state_machine) = opts.age_plugin {
 //!         // The plugin was started by an age client; run the state machine.

rage/CHANGELOG.md

@@ -11,6 +11,7 @@ to 1.0.0 are beta releases.
 ## [Unreleased]
 ### Changed
 - MSRV is now 1.65.0.
+- Migrated from `gumdrop` to `clap` for argument parsing.
 
 ### Fixed
 - OpenSSH private keys passed to `-i/--identity` that contain invalid public

rage/Cargo.toml

@@ -56,9 +56,9 @@ maintenance = { status = "experimental" }
 # rage and rage-keygen dependencies
 age = { workspace = true, features = ["armor", "cli-common", "plugin"] }
 chrono.workspace = true
+clap.workspace = true
 console.workspace = true
 env_logger.workspace = true
-gumdrop.workspace = true
 i18n-embed = { workspace = true, features = ["desktop-requester"] }
 i18n-embed-fl.workspace = true
 lazy_static.workspace = true
@@ -76,7 +76,6 @@ time = { version = ">=0.3.7, <0.3.24", optional = true } # time 0.3.24 has MSRV
 zip = { version = "0.6.2", optional = true }
 
 [dev-dependencies]
-clap = { version = "4", default-features = false }
 clap_complete = "4"
 flate2 = "1"
 man = "0.3"

rage/i18n/en-US/rage.ftl

@@ -35,13 +35,7 @@
 
 usage-header = Usage:
 
-rage-usage =
-    {usage-header}
-    {"  "}{$usage_a}
-    {"  "}{$usage_b}
-
-    {$flags}
-
+rage-after-help =
     {-input} defaults to standard input, and {-output} defaults to standard output.
 
     {-recipient} can be:

rage/i18n/es-AR/rage.ftl

@@ -35,13 +35,7 @@
 
 usage-header = Usage:
 
-rage-usage =
-    {usage-header}
-    {"  "}{$usage_a}
-    {"  "}{$usage_b}
-
-    {$flags}
-
+rage-after-help =
     {-input} por defecto a standard input, y {-output} por defecto standard output.
 
     {-recipient} puede ser:

rage/i18n/it/rage.ftl

@@ -35,13 +35,7 @@
 
 usage-header = Usage:
 
-rage-usage =
-    {usage-header}
-    {"  "}{$usage_a}
-    {"  "}{$usage_b}
-
-    {$flags}
-
+rage-after-help =
     {-input} ha come valore predefinito lo standard input, e {-output} ha come
     valore predefinito lo standard output.
 

rage/i18n/zh-CN/rage.ftl

@@ -35,13 +35,7 @@
 
 usage-header = Usage:
 
-rage-usage =
-    {usage-header}
-    {"  "}{$usage_a}
-    {"  "}{$usage_b}
-
-    {$flags}
-
+rage-after-help =
     {-input} 默认为标准输入 （stdin）, 而 {-output} 默认为标准输出 （stdout） 。
 
     {-recipient} 可为：

rage/i18n/zh-TW/rage.ftl

@@ -35,13 +35,7 @@
 
 usage-header = Usage:
 
-rage-usage =
-    {usage-header}
-    {"  "}{$usage_a}
-    {"  "}{$usage_b}
-
-    {$flags}
-
+rage-after-help =
     {-input} 默認為標準輸入 （stdin）, 而 {-output} 默認為標準輸出 （stdout） 。
 
     {-recipient} 可為：