Shell completions (#57)

* Add shell completions because I am annoyed

* Update install instructions

Author: coracuity

Cargo.lock

@@ -19,6 +19,7 @@ anyhow = "^1.0.100"
 rayon = "^1.10"
 arrow = { version = "^57.0.0", features = ["default", "ipc_compression"] }
 clap = { version = "^4.5.53", features = ["default", "derive"] }
+clap_complete = "^4.5"
 datafusion = { git = "https://github.com/apache/datafusion.git", rev = "1cc9bcd52e5901f9085864c032c5f51a1932a075" }
 futures = "^0.3.31"
 glob = "^0.3.3"

Cargo.toml

@@ -20,19 +20,16 @@ Like its namesake fabric -- light, flowing, and effortlessly elegant -- this too
 
 ## 📦 Installation
 
-### From Source
+### From Source locally
 
 ```bash
 cargo install --path .
 ```
 
-### Binary
-
-> [!NOTE]
-> Soooooon....
+### From GitHub
 
 ```bash
-cargo binstall silk-chiffon
+cargo install --git https://github.com/acuitymd/silk-chiffon
 ```
 
 ### Releases
@@ -180,6 +177,34 @@ Enable bloom filters for specific columns:
 - `--overwrite` - Overwrite existing files
 - `--list-outputs <FORMAT>` - List output files after creation (text, json)
 
+### Shell Completions
+
+Generate shell completions for your shell:
+
+```bash
+# To add completions for your current shell session only
+
+## zsh
+eval "$(silk-chiffon completions zsh)"
+
+## bash
+eval "$(silk-chiffon completions bash)"
+
+## fish
+silk-chiffon completions fish | source
+
+# To persist completions across sessions
+
+## zsh
+echo 'eval "$(silk-chiffon completions zsh)"' >> ~/.zshrc
+
+## bash
+echo 'eval "$(silk-chiffon completions bash)"' >> ~/.bashrc
+
+## fish
+silk-chiffon completions fish > ~/.config/fish/completions/silk-chiffon.fish
+```
+
 ## 📚 Examples
 
 ### Convert with Sorting

README.md

@@ -9,7 +9,8 @@ pub mod utils;
 use crate::utils::collections::{uniq, uniq_by};
 use anyhow::{Result, anyhow};
 use arrow::ipc::CompressionType;
-use clap::{Args, Parser, Subcommand, ValueEnum};
+use clap::{Args, CommandFactory, Parser, Subcommand, ValueEnum};
+use clap_complete::Shell;
 use datafusion::config::Dialect;
 use parquet::{
     basic::{Compression, Encoding, GzipLevel, ZstdLevel},
@@ -29,6 +30,7 @@ pub struct Cli {
 }
 
 #[derive(Subcommand, Debug)]
+#[allow(clippy::large_enum_variant)]
 pub enum Commands {
     /// Transform data between formats with optional filtering, sorting, merging, and partitioning.
     ///
@@ -46,6 +48,34 @@ pub enum Commands {
     ///   silk-chiffon transform --from-many '*.arrow' --to-many "{{year}}/{{month}}.parquet" --by year,month
     #[command(verbatim_doc_comment)]
     Transform(TransformCommand),
+
+    /// Generate shell completions for your shell.
+    ///
+    /// To add completions for your current shell session only:
+    ///   zsh:  eval "$(silk-chiffon completions zsh)"
+    ///   bash: eval "$(silk-chiffon completions bash)"
+    ///   fish: silk-chiffon completions fish | source
+    ///
+    /// To persist completions across sessions:
+    ///   zsh:  echo 'eval "$(silk-chiffon completions zsh)"' >> ~/.zshrc
+    ///   bash: echo 'eval "$(silk-chiffon completions bash)"' >> ~/.bashrc
+    ///   fish: silk-chiffon completions fish > ~/.config/fish/completions/silk-chiffon.fish
+    #[command(verbatim_doc_comment)]
+    Completions {
+        /// Shell to generate completions for
+        shell: Shell,
+    },
+}
+
+impl Commands {
+    pub fn generate_completions(shell: Shell) {
+        clap_complete::generate(
+            shell,
+            &mut Cli::command(),
+            "silk-chiffon",
+            &mut std::io::stdout(),
+        );
+    }
 }
 
 #[derive(ValueEnum, Clone, Copy, Debug, Default, Display)]

src/lib.rs

@@ -6,8 +6,15 @@ use silk_chiffon::{Cli, Commands, commands};
 async fn main() -> Result<()> {
     let cli = Cli::parse();
 
+    // handle completions before anything else since it writes to stdout
+    if let Commands::Completions { shell } = &cli.command {
+        Commands::generate_completions(*shell);
+        return Ok(());
+    }
+
     match cli.command {
         Commands::Transform(args) => commands::transform::run(args).await?,
+        Commands::Completions { .. } => unreachable!(),
     };
     Ok(())
 }