feat(cli): added command to generate shell completion scripts

Author: algarfer

Cargo.toml

@@ -254,6 +254,7 @@ base64 = "0.22.1"
 calamine = { version = "0.31" }
 chrono = { version = "0.4", features = ["serde"] }
 clap = { version = "4.5", features = ["derive"] }
+clap_complete_command.version = "0.6.1"
 clientele = { version = "0.3.8", default-features = false, features = ["dotenv", "subcommands", "std"] }
 crossterm = "0.27"
 colored = "3"

rudof_cli/Cargo.toml

@@ -16,6 +16,7 @@ name = "rudof"
 [dependencies]
 anyhow.workspace = true
 clap.workspace = true
+clap_complete_command.workspace = true
 clientele.workspace = true
 dctap.workspace = true
 iri_s.workspace = true

rudof_cli/src/cli/parser.rs

@@ -8,6 +8,7 @@ use crate::cli::wrappers::{
     SortByShaclValidationReportCli, SortByValidateCli, ValidationModeCli,
 };
 use clap::{Args, Parser, Subcommand};
+use clap_complete_command::Shell;
 use rudof_lib::{InputSpec, IriS};
 use rudof_mcp::server::TransportType;
 use std::path::PathBuf;
@@ -19,6 +20,7 @@ use std::path::PathBuf;
 #[derive(Parser, Debug)]
 #[command(author, version, about)]
 #[command(
+    name = "rudof",
     arg_required_else_help = true,
     long_about = None // Automatically uses the Doc Comment above
 )]
@@ -73,6 +75,8 @@ pub enum Command {
     Generate(GenerateArgs),
     /// Validate Property Graph data using PGSchema
     PgSchemaValidate(PgSchemaValidateArgs),
+    /// Generates a shell completion script for the specified shell
+    Completion(CompletionArgs),
 }
 
 // ============================================================================
@@ -1372,3 +1376,13 @@ pub struct PgSchemaValidateArgs {
     #[command(flatten)]
     pub common: CommonArgsOutputForceOverWrite,
 }
+
+/// Arguments for the `completion` command
+#[derive(Debug, Clone, Args)]
+pub struct CompletionArgs {
+    #[clap(value_parser = clap::value_parser!(Shell))]
+    pub shell: Shell,
+
+    #[command(flatten)]
+    pub common: CommonArgsOutputForceOverWrite,
+}

rudof_cli/src/commands/base.rs

@@ -1,8 +1,8 @@
 use crate::cli::parser::{Command as CliCommand, CommonArgs, CommonArgsAll, CommonArgsOutputForceOverWrite};
 use crate::commands::{
-    CompareCommand, ConvertCommand, DataCommand, DctapCommand, GenerateCommand, McpCommand, NodeCommand,
-    PgSchemaValidateCommand, PgschemaCommand, QueryCommand, RdfConfigCommand, ServiceCommand, ShaclCommand,
-    ShaclValidateCommand, ShapemapCommand, ShexCommand, ShexValidateCommand, ValidateCommand,
+    CompareCommand, CompletionCommand, ConvertCommand, DataCommand, DctapCommand, GenerateCommand, McpCommand,
+    NodeCommand, PgSchemaValidateCommand, PgschemaCommand, QueryCommand, RdfConfigCommand, ServiceCommand,
+    ShaclCommand, ShaclValidateCommand, ShapemapCommand, ShexCommand, ShexValidateCommand, ValidateCommand,
 };
 use crate::output::{ColorSupport, get_writer};
 use anyhow::Result;
@@ -118,6 +118,7 @@ impl CommandFactory {
             CliCommand::Query(args) => Ok(Box::new(QueryCommand::new(args))),
             CliCommand::Generate(args) => Ok(Box::new(GenerateCommand::new(args))),
             CliCommand::PgSchemaValidate(args) => Ok(Box::new(PgSchemaValidateCommand::new(args))),
+            CliCommand::Completion(args) => Ok(Box::new(CompletionCommand::new(args))),
         }
     }
 }
@@ -213,5 +214,9 @@ fn extract_common(cmd: &CliCommand) -> CommonArgs {
             output: a.common.output.clone(),
             force_overwrite: a.common.force_overwrite,
         }),
+        CliCommand::Completion(a) => CommonArgs::OutputForceOverWrite(CommonArgsOutputForceOverWrite {
+            output: a.common.output.clone(),
+            force_overwrite: a.common.force_overwrite,
+        }),
     }
 }

rudof_cli/src/commands/completion.rs

@@ -0,0 +1,32 @@
+use crate::cli::parser::{Cli, CompletionArgs};
+use crate::commands::CommandContext;
+use crate::commands::base::Command;
+use clap::CommandFactory;
+
+/// Implementation of the `compare` command.
+///
+/// This struct holds the specific arguments parsed by `clap` and
+/// implements the [`Command`] trait to execute Compare command logic.
+pub struct CompletionCommand {
+    /// Arguments specific to Completion command.
+    args: CompletionArgs,
+}
+
+impl CompletionCommand {
+    pub fn new(args: CompletionArgs) -> Self {
+        Self { args }
+    }
+}
+
+impl Command for CompletionCommand {
+    /// Executes the Completion command logic.
+    fn execute(&self, ctx: &mut CommandContext) -> anyhow::Result<()> {
+        self.args.shell.generate(&mut Cli::command(), ctx.writer.as_mut());
+        Ok(())
+    }
+
+    /// Returns the unique identifier for this command.
+    fn name(&self) -> &'static str {
+        "completion"
+    }
+}

rudof_cli/src/commands/mod.rs

@@ -1,5 +1,6 @@
 mod base;
 mod compare;
+mod completion;
 mod convert;
 mod data;
 mod dctap;
@@ -20,6 +21,7 @@ mod validate;
 
 pub use base::{CommandContext, CommandFactory};
 pub use compare::CompareCommand;
+pub use completion::CompletionCommand;
 pub use convert::ConvertCommand;
 pub use data::DataCommand;
 pub use dctap::DctapCommand;