feat(zkstack_cli): Autocompletion support

.gitignore

@@ -119,3 +119,5 @@ configs/*
 era-observability/
 core/tests/ts-integration/deployments-zk
 transactions/
+_zkstack_bash
+_zkstack_zsh

zkstack_cli/Cargo.toml

@@ -40,6 +40,7 @@ zksync_protobuf_build = "=0.5.0"
 # External dependencies
 anyhow = "1.0.82"
 clap = { version = "4.4", features = ["derive", "wrap_help", "string"] }
+dirs = "5.0.1"
 slugify-rs = "0.0.3"
 cliclack = "0.2.5"
 console = "0.15.8"

zkstack_cli/README.md

@@ -30,6 +30,16 @@ zkstackup  --local
 
 This command installs `zkstack` from the current repository.
 
+### Add Autocompletion
+
+TODO: finalize section
+
+```bash
+zkstack --generate=zsh > /usr/local/share/zsh/site-functions/_zkstack
+compinit
+zkstack --<TAB>
+```
+
 ### Foundry Integration
 
 Foundry is used for deploying smart contracts. Pass flags for Foundry integration with the `-a` option, e.g.,

zkstack_cli/crates/zkstack/Cargo.toml

@@ -14,6 +14,7 @@ keywords.workspace = true
 anyhow.workspace = true
 chrono.workspace = true
 clap.workspace = true
+clap_complete = "4.5.33"
 clap-markdown.workspace = true
 cliclack.workspace = true
 common.workspace = true
@@ -49,6 +50,7 @@ rand.workspace = true
 zksync_consensus_utils.workspace = true
 
 [build-dependencies]
+dirs.workspace = true
 eyre.workspace = true
 ethers.workspace = true
 zksync_protobuf_build.workspace = true

zkstack_cli/crates/zkstack/build.rs

@@ -1,13 +1,18 @@
 use std::path::PathBuf;
 
+use dirs::{config_local_dir, home_dir};
 use ethers::contract::Abigen;
+use eyre::ContextCompat;
 
 fn main() -> eyre::Result<()> {
     let outdir = PathBuf::from(std::env::var("OUT_DIR")?).canonicalize()?;
     Abigen::new("ConsensusRegistry", "abi/ConsensusRegistry.json")?
         .generate()?
         .write_to_file(outdir.join("consensus_registry_abi.rs"))?;
 
+    // Copy completion scripts (ignore errors)
+    copy_completion_scripts().ok();
+
     zksync_protobuf_build::Config {
         input_root: "src/commands/consensus/proto".into(),
         proto_root: "zksync/toolbox/consensus".into(),
@@ -19,3 +24,50 @@ fn main() -> eyre::Result<()> {
     .unwrap();
     Ok(())
 }
+
+fn copy_completion_scripts() -> eyre::Result<()> {
+    let crate_name = env!("CARGO_PKG_NAME");
+
+    // Create local config directory
+    let local_config_dir = config_local_dir().unwrap().join(crate_name);
+    std::fs::create_dir_all(&local_config_dir)?;
+
+    // Array of supported shells
+    let shells = ["bash", "zsh"];
+
+    // Copy completion files
+    let completion_dir = local_config_dir.join("completion");
+    std::fs::create_dir_all(&completion_dir)?;
+
+    for shell in &shells {
+        let completion_file = format!("_{}_{}", crate_name, shell);
+        std::fs::copy(
+            format!("completion/{}", &completion_file),
+            completion_dir.join(&completion_file),
+        )?;
+
+        // Source the completion file inside .{shell}rc
+        let shell_rc = home_dir()
+            .context("missing home directory")?
+            .join(format!(".{}rc", shell));
+
+        if shell_rc.exists() {
+            let shell_rc_content = std::fs::read_to_string(&shell_rc)?;
+
+            if !shell_rc_content.contains("# zkstack completion") {
+                let completion_path = completion_dir.join(&completion_file);
+                let completion_path = completion_path.to_str().unwrap();
+
+                std::fs::write(
+                    shell_rc,
+                    format!(
+                        "{}\n# zkstack completion\nsource \"{}\"\n",
+                        shell_rc_content, completion_path
+                    ),
+                )?;
+            }
+        }
+    }
+
+    Ok(())
+}