Merge branch 'pr-15-shell-completions'

Author: realfresh

Cargo.lock

@@ -15,6 +15,7 @@ categories = ["development-tools", "command-line-utilities"]
 [dependencies]
 anyhow = "1.0.89"
 clap = { version = "4.5.20", features = ["derive"] }
+clap_complete = "^4.5"
 copypasta = "0.8.2"
 dirs = "5.0.1"
 human-panic = "2.0.2"
@@ -25,7 +26,10 @@ ratatui = "0.28.1"
 serde = { version = "1.0.210", features = ["default", "derive"] }
 serde_json = "1.0.128"
 tui-input = "0.10.1"
-ureq = { version = "2.10.1", features = ["gzip", "native-tls"], default-features = false }
+ureq = { version = "2.10.1", features = [
+  "gzip",
+  "native-tls",
+], default-features = false }
 url = "2.5.2"
 yansi = "1.0.1"
 
@@ -53,16 +57,16 @@ pkg-url = "{ repo }/releases/download/v{ version }/{ name }-macos-arm64"
 
 [package.metadata.cross.target.x86_64-unknown-linux-gnu]
 pre-build = [
-    "dpkg --add-architecture $CROSS_DEB_ARCH",
-    "apt-get update && apt-get --assume-yes install pkg-config libssl-dev:$CROSS_DEB_ARCH"
+  "dpkg --add-architecture $CROSS_DEB_ARCH",
+  "apt-get update && apt-get --assume-yes install pkg-config libssl-dev:$CROSS_DEB_ARCH",
 ]
 [package.metadata.cross.target.i686-unknown-linux-gnu]
 pre-build = [
-    "dpkg --add-architecture $CROSS_DEB_ARCH",
-    "apt-get update && apt-get --assume-yes install pkg-config libssl-dev:$CROSS_DEB_ARCH"
+  "dpkg --add-architecture $CROSS_DEB_ARCH",
+  "apt-get update && apt-get --assume-yes install pkg-config libssl-dev:$CROSS_DEB_ARCH",
 ]
 [package.metadata.cross.target.aarch64-unknown-linux-gnu]
 pre-build = [
-    "dpkg --add-architecture $CROSS_DEB_ARCH",
-    "apt-get update && apt-get --assume-yes install pkg-config libssl-dev:$CROSS_DEB_ARCH"
+  "dpkg --add-architecture $CROSS_DEB_ARCH",
+  "apt-get update && apt-get --assume-yes install pkg-config libssl-dev:$CROSS_DEB_ARCH",
 ]

Cargo.toml

@@ -2,6 +2,7 @@ use crate::template::item::Template;
 use crate::template::list::TemplateList;
 use anyhow::{bail, Context, Result};
 use clap::{Args, Parser, Subcommand};
+use clap_complete::Shell;
 use once_cell::sync::Lazy;
 
 const LONG_ABOUT: &str = r"
@@ -66,6 +67,11 @@ pub enum Commands {
     Create(CommandCreate),
     /// Choose templates interactively from the GitHub & TopTal collections
     Search,
+    /// Generate completions to stdout
+    Completions {
+        /// Specify desired shell
+        shell: Shell,
+    },
 }
 
 impl Cli {
@@ -76,6 +82,9 @@ impl Cli {
             Some(Commands::Search) => {
                 bail!("Cannot provide template arguments to 'search' command")
             }
+            Some(Commands::Completions { shell: _ }) => {
+                bail!("Cannot provide template arguments to 'completions' command")
+            }
             None => bail!("Cannot provide template arguments to an unknown command"),
         };
 

src/cli.rs

@@ -0,0 +1,15 @@
+use std::io;
+
+use anyhow::Result;
+use clap::CommandFactory;
+use clap_complete::{generate, Shell};
+
+use crate::cli::Cli;
+
+pub fn command(shell: &Shell) -> Result<()> {
+    let cmd = &mut Cli::command();
+
+    generate(*shell, cmd, cmd.get_name().to_string(), &mut io::stdout());
+
+    Ok(())
+}

src/commands/completions.rs

@@ -72,7 +72,7 @@ pub fn command(cmd: &CommandCreate) -> Result<()> {
     }
 
     // Print template to stdout
-    println!("{}", output);
+    println!("{output}");
 
     Ok(())
 }

src/commands/create.rs

@@ -1,2 +1,3 @@
+pub mod completions;
 pub mod create;
 pub mod search;

src/commands/mod.rs

@@ -1,5 +1,5 @@
 /// From: https://github.com/ratatui-org/rust-tui-template
-
+///
 /// Terminal UI events handler
 pub mod event;
 

src/commands/search/framework/mod.rs

@@ -209,7 +209,7 @@ pub fn handle_mouse_events(event: MouseEvent, app: &mut UIState) -> Result<()> {
             MouseEventKind::ScrollDown => {
                 if now.duration_since(app.last_scroll_time) > Duration::from_millis(15) {
                     app.list_next(if is_shift || is_alt {
-                        println!("Scrolling {} {}", is_shift, is_alt);
+                        println!("Scrolling {is_shift} {is_alt}");
                         Some(10)
                     } else {
                         Some(1)

src/commands/search/handlers.rs

@@ -10,7 +10,7 @@ use ratatui::{text, Frame};
 fn create_tabs<'a>(tab_titles: Vec<String>, list_tab: usize) -> anyhow::Result<Tabs<'a>> {
     let items = tab_titles
         .into_iter()
-        .map(|t| Line::from(format!(" {} ", t)))
+        .map(|t| Line::from(format!(" {t} ")))
         .collect::<Vec<Line>>();
     let block = Block::default()
         .borders(Borders::ALL)

src/commands/search/views/home/header.rs

@@ -36,7 +36,7 @@ fn create_selected<'a>(
         .map(|s| {
             let name = s.template.value.name().unwrap();
             let prefix = s.kind.name();
-            ListItem::new(format!("{} - {}", prefix, name))
+            ListItem::new(format!("{prefix} - {name}"))
         })
         .collect();