change shell completions to use dynamic mode (#51)

* change shell completions to use dynamic mode

* modify flake.nix shell completions

Author: Panaetius

Cargo.lock

@@ -6,21 +6,24 @@ version = "0.1.0-nightly"
 edition = "2024"
 license = "Apache-2.0"
 repository = "https://github.com/SwissDatascienceCenter/renku-cli"
-keywords = [ "renku", "cli" ]
-categories = [ "command-line-utilities" ]
+keywords = ["renku", "cli"]
+categories = ["command-line-utilities"]
 build = "build.rs"
 
 # See more keys and their definitions at
 # https://doc.rust-lang.org/cargo/reference/manifest.html
 
 [dependencies]
 clap = { version = "4.5.13", features = ["derive", "wrap_help"] }
-clap_complete = "4.5.13"
+clap_complete = { version = "4.5.61", features = ["unstable-dynamic"] }
 console = {version = "0.15.11"}
 env_logger = { version = "0.11.5" }
 log = { version = "0.4.22" }
 openssl = { version = "0.10.75", optional = true }
-reqwest = { version = "0.12.28", default-features = false, features = ["json", "multipart"] }
+reqwest = { version = "0.12.28", default-features = false, features = [
+  "json",
+  "multipart",
+] }
 serde = { version = "1.0.210", features = ["derive"] }
 serde_json = "1.0.128"
 snafu = { version = "0.8.5" }
@@ -29,27 +32,44 @@ futures = { version = "0.3" }
 regex = { version = "1.12.3" }
 iso8601-timestamp = { version = "0.2.17" }
 toml = { version = "0.8.19" }
-git2 = { version = "0.19.0", default-features = false, features = [ "vendored-libgit2", "https", "ssh" ]}
+git2 = { version = "0.19.0", default-features = false, features = [
+  "vendored-libgit2",
+  "https",
+  "ssh",
+] }
 url = { version = "2.5.1" }
 oauth2 = { version = "4.4.2" }
-openidconnect = { version = "3.5.0", default-features = false, features = [ "reqwest" ] }
+openidconnect = { version = "3.5.0", default-features = false, features = [
+  "reqwest",
+] }
 directories = { version = "5.0" }
 comrak = { version = "0.28.0", optional = true }
 clap-verbosity-flag = "3.0.4"
 
 [features]
 default = ["reqwest/default-tls"] # link against system library
-rustls = ["reqwest/rustls-tls", "openidconnect/rustls-tls"] # include rustls, ssl library written in rust
+rustls = [
+  "reqwest/rustls-tls",
+  "openidconnect/rustls-tls",
+] # include rustls, ssl library written in rust
 vendored-openssl = ["openssl/vendored"] # include compiled openssl library
-vendored-zlib = ["git2/zlib-ng-compat"] # without this feature wherever the cli is installed needs to have zlib.so
-user-doc = [ "dep:comrak" ]
+vendored-zlib = [
+  "git2/zlib-ng-compat",
+] # without this feature wherever the cli is installed needs to have zlib.so
+user-doc = ["dep:comrak"]
 
 [dev-dependencies]
 assert_cmd = "2.0.16"
 predicates = "3.1.2"
 
 [build-dependencies]
-vergen = { version = "8.3.2", features = ["build", "git", "gitcl", "rustc", "cargo"] }
+vergen = { version = "8.3.2", features = [
+  "build",
+  "git",
+  "gitcl",
+  "rustc",
+  "cargo",
+] }
 
 [profile.release]
 strip ="debuginfo"

Cargo.toml

@@ -123,19 +123,23 @@ For convenience, the cli tool can generate completion commands for
 several shells. You can use it for inclusion in your `.bashrc` or
 similar setups.
 
-For example:
+These have to be "sourced" into into your current shell:
 
-``` bash rnk:silent
-rnk shell-completion --shell bash
-```
+```bash
+# Bash
+echo "source <(COMPLETE=bash rnk)" >> ~/.bashrc
 
-will generate the completions for bash. These have to be "sourced"
-into into your current shell:
+# Fish
+echo "COMPLETE=fish rnk | source" >> ~/.config/fish/config.fish
 
-``` bash
-eval "$(rnk shell-completion --shell bash)"
+# Zsh
+echo "source <(COMPLETE=zsh rnk)" >> ~/.zshrc
+
+# Powershell
+echo '$env:COMPLETE = "powershell"; rnk | Out-String | Invoke-Expression; Remove-Item Env:\COMPLETE' >> $PROFILE
 ```
 
+
 Add this line to your `.bashrc` to have these completions available
 when you enter bash.
 

docs/install.md

@@ -91,7 +91,7 @@
           cargoExtraArgs = "";
           postInstall = ''
             for shell in fish zsh bash; do
-               $out/bin/rnk shell-completion --shell $shell > rnk.$shell
+               echo "COMPLETE=$shell rnk" > rnk.$shell
                installShellCompletion --$shell rnk.$shell
             done
           '';

flake.nix

@@ -5,7 +5,6 @@ pub mod sink;
 use self::cmd::project::Error as ProjectError;
 use self::cmd::{CmdError, Context};
 use self::opts::{MainOpts, SubCommand};
-use clap::CommandFactory;
 use serde::Serialize;
 use std::fmt;
 
@@ -15,10 +14,6 @@ pub async fn execute_cmd(opts: MainOpts) -> Result<(), CmdError> {
     log::info!("Running command: {:?}", opts.subcmd);
     match &opts.subcmd {
         SubCommand::Version(input) => input.exec(&ctx).await?,
-        SubCommand::ShellCompletion(input) => {
-            let mut app = MainOpts::command();
-            input.print_completions(&mut app).await;
-        }
         SubCommand::Project(input) => input.exec(ctx).await?,
         SubCommand::Clone(input) => input
             .exec(ctx)

src/cli.rs

@@ -1,6 +1,5 @@
 pub mod login;
 pub mod project;
-pub mod shell_completion;
 #[cfg(feature = "user-doc")]
 pub mod userdoc;
 pub mod version;

src/cli/cmd.rs

@@ -8,7 +8,7 @@ use crate::data::simple_message::SimpleMessage;
 use crate::httpclient::Error as HttpError;
 use std::sync::Arc;
 
-use clap::Parser;
+use clap::{Parser, ValueHint};
 use git2::{Error as GitError, Repository};
 use snafu::{ResultExt, Snafu};
 use std::path::{Path, PathBuf};
@@ -24,12 +24,12 @@ pub struct Input {
     /// namespace/slug identifier or the complete url. If a complete
     /// url is given, it will override any renku-url that might have
     /// been given otherwise.
-    #[arg()]
+    #[arg(value_hint=ValueHint::Other)]
     pub project_ref: ProjectId,
 
     /// Optional target directory to create the project in. By default
     /// the current working directory is used.
-    #[arg()]
+    #[arg(value_hint=ValueHint::DirPath)]
     pub target_dir: Option<PathBuf>,
 }
 

src/cli/cmd/project/clone.rs

@@ -49,9 +49,6 @@ pub enum SubCommand {
     #[command()]
     Version(version::Input),
 
-    #[command()]
-    ShellCompletion(shell_completion::Input),
-
     #[command()]
     Project(project::Input),
 

src/cli/cmd/shell_completion.rs

@@ -1,3 +1,6 @@
+use clap::CommandFactory;
+use clap_complete::CompleteEnv;
+use rnk::cli::opts::MainOpts;
 use rnk::error::{Error, Result};
 use std::process;
 
@@ -12,6 +15,7 @@ async fn main() {
 }
 
 async fn execute() -> Result<()> {
+    CompleteEnv::with_factory(MainOpts::command).complete();
     let opts = rnk::read_args();
     env_logger::Builder::new()
         .filter_level(opts.common_opts.verbosity.log_level_filter())