Create a ClapError alias

Author: sfauvel

mithril-client-cli/src/commands/deprecation.rs

@@ -3,6 +3,8 @@ use clap::{
     error::{ContextKind, ContextValue},
 };
 
+use crate::ClapError;
+
 /// Stores the deprecated command name and the new command name to use.
 #[derive(Clone)]
 pub struct DeprecatedCommand {
@@ -25,7 +27,7 @@ pub struct Deprecation;
 
 impl Deprecation {
     fn find_deprecated_command(
-        error: &clap::error::Error,
+        error: &ClapError,
         deprecated_commands: Vec<DeprecatedCommand>,
     ) -> Option<DeprecatedCommand> {
         if let Some(context_value) = error.get(ContextKind::InvalidSubcommand) {
@@ -40,11 +42,11 @@ impl Deprecation {
 
     /// Modify result to add information on deprecated commands.
     pub fn handle_deprecated_commands<A>(
-        matches_result: Result<A, clap::error::Error>,
+        matches_result: Result<A, ClapError>,
         styles: Styles,
         deprecated_commands: Vec<DeprecatedCommand>,
-    ) -> Result<A, clap::error::Error> {
-        matches_result.map_err(|mut e: clap::error::Error| {
+    ) -> Result<A, ClapError> {
+        matches_result.map_err(|mut e: ClapError| {
             if let Some(deprecated_command) = Self::find_deprecated_command(&e, deprecated_commands)
             {
                 let message = format!(
@@ -83,9 +85,9 @@ mod tests {
 
     #[test]
     fn invalid_sub_command_message_for_a_non_deprecated_command_is_not_modified() {
-        fn build_error() -> Result<MyCommand, clap::error::Error> {
-            let mut e = clap::error::Error::new(ErrorKind::InvalidSubcommand)
-                .with_cmd(&MyCommand::command());
+        fn build_error() -> Result<MyCommand, ClapError> {
+            let mut e =
+                ClapError::new(ErrorKind::InvalidSubcommand).with_cmd(&MyCommand::command());
 
             e.insert(
                 ContextKind::InvalidSubcommand,
@@ -109,15 +111,14 @@ mod tests {
 
     #[test]
     fn replace_error_message_on_deprecated_commands_and_show_the_new_command() {
-        let mut e = clap::error::Error::new(clap::error::ErrorKind::InvalidSubcommand)
-            .with_cmd(&MyCommand::command());
+        let mut e = ClapError::new(ErrorKind::InvalidSubcommand).with_cmd(&MyCommand::command());
         e.insert(
             ContextKind::InvalidSubcommand,
             ContextValue::String("old_command".to_string()),
         );
 
         let result = Deprecation::handle_deprecated_commands(
-            Err(e) as Result<MyCommand, clap::error::Error>,
+            Err(e) as Result<MyCommand, ClapError>,
             Styles::plain(),
             vec![DeprecatedCommand::new("old_command", "new_command")],
         );

mithril-client-cli/src/lib.rs

@@ -10,3 +10,6 @@
 pub mod commands;
 mod configuration;
 mod utils;
+
+/// Error Clap
+pub type ClapError = clap::error::Error;

mithril-client-cli/src/main.rs

@@ -12,13 +12,13 @@ use std::sync::Arc;
 use std::{fs::File, path::PathBuf};
 
 use mithril_client::MithrilResult;
-use mithril_client_cli::commands::{DeprecatedCommand, Deprecation};
 use mithril_doc::{Documenter, GenerateDocCommands, StructDoc};
 
 use mithril_client_cli::commands::{
     cardano_db::CardanoDbCommands, cardano_transaction::CardanoTransactionCommands,
-    mithril_stake_distribution::MithrilStakeDistributionCommands,
+    mithril_stake_distribution::MithrilStakeDistributionCommands, DeprecatedCommand, Deprecation,
 };
+use mithril_client_cli::ClapError;
 
 enum LogOutputType {
     StdErr,
@@ -141,7 +141,7 @@ impl Args {
     }
 
     fn parse_with_decorator(
-        decorator: &dyn Fn(Result<Self, clap::error::Error>) -> Result<Self, clap::error::Error>,
+        decorator: &dyn Fn(Result<Self, ClapError>) -> Result<Self, ClapError>,
     ) -> Self {
         let result = decorator(Self::try_parse());
         match result {
@@ -151,8 +151,8 @@ impl Args {
     }
 
     fn handle_deprecated_decorator(
-        args_result: Result<Self, clap::error::Error>,
-    ) -> Result<Self, clap::error::Error> {
+        args_result: Result<Self, ClapError>,
+    ) -> Result<Self, ClapError> {
         let styles = Args::command().get_styles().clone();
         Deprecation::handle_deprecated_commands(
             args_result,
@@ -228,7 +228,7 @@ impl ArtifactCommands {
 #[tokio::main]
 async fn main() -> MithrilResult<()> {
     // Load args
-    let args = Args::parse_with_decorator(&|result: Result<Args, clap::error::Error>| {
+    let args = Args::parse_with_decorator(&|result: Result<Args, ClapError>| {
         Args::handle_deprecated_decorator(result)
     });
     let _guard = slog_scope::set_global_logger(args.build_logger()?);