Shell completion command

Cargo.toml

@@ -16,6 +16,8 @@ path = "./src/huak/lib.rs"
 
 [dependencies]
 clap = {version = "4.0.15", features = ["cargo", "derive"]}
+clap_complete = "4.0"
+
 thiserror = "1.0.36"
 fs_extra = "1.2.0"
 glob = "0.3.0"

README.md

@@ -68,30 +68,86 @@ A Python package manager written in Rust inspired by Cargo.
 Usage: huak <COMMAND>
 
 Commands:
-  activate  Activate the project's virtual environment
-  add       Add a dependency to the existing project
-  audit     Check for vulnerable dependencies and license compatibility*
-  build     Build tarball and wheel for the project
-  clean     Remove tarball and wheel from the built project
-  doc       Generates documenation for the project*
-  fix       Auto-fix fixable lint conflicts
-  fmt       Format the project's Python code
-  init      Initialize the existing project
-  install   Install the dependencies of an existing project
-  lint      Lint the project's Python code
-  new       Create a new project at <path>
-  publish   Builds and uploads current project to a registry*
-  remove    Remove a dependency from the project
-  run       Run a command within the project's environment context
-  test      Test the project's Python code
-  update    Update dependencies added to the project*
-  version   Display the version of the project
-  help      Print this message or the help of the given subcommand(s)
+  activate    Activate the project's virtual environment
+  add         Add a dependency to the existing project
+  audit       Check for vulnerable dependencies and license compatibility*
+  build       Build tarball and wheel for the project
+  completion  Generates a shell completion script for supported shells. See the help menu for more information on supported shells
+  clean       Remove tarball and wheel from the built project
+  doc         Generates documentation for the project*
+  fix         Auto-fix fixable lint conflicts
+  fmt         Format the project's Python code
+  init        Initialize the existing project
+  install     Install the dependencies of an existing project
+  lint        Lint the project's Python code
+  new         Create a new project at <path>
+  publish     Builds and uploads current project to a registry*
+  remove      Remove a dependency from the project
+  run         Run a command within the project's environment context
+  test        Test the project's Python code
+  update      Update dependencies added to the project*
+  version     Display the version of the project
+  help        Print this message or the help of the given subcommand(s)
 ```
 _"*" indicates first-pass of implementation is incomplete._
 
 Note that `huak activate` is currently only partially supported on Windows. See the related [issue](https://github.com/cnpryer/huak/issues/302) for more details.
 
+
+
+## Shell completion
+
+##### Bash
+First, ensure that you install `bash-completion` using your package manager.
+After, add this to your `~/.bash_profile`:
+
+```bash
+eval "$(huak completion bash)"
+```
+
+##### Elvish
+This shell is supported, but the suggestion as to how this should be added to your shell init file is missing.
+
+If you are able to test this please head over to [github](https://github.com/cnpryer/huak/issues) and file an issue
+##### Fish
+Generate a `huak.fish` completion script:
+
+```bash
+huak completion fish > ~/.config/fish/completions/huak.fish
+```
+
+##### Powershell
+Open your profile script with:
+
+```bash
+mkdir -Path (Split-Path -Parent $profile) -ErrorAction SilentlyContinue
+```
+
+```bash
+notepad $profile
+```
+
+Add the line and save the file:
+```bash
+Invoke-Expression -Command $(huak completion powershell| Out-String)
+```
+
+##### Zsh
+Generate a `_huak` completion script and put it somewhere in your `$fpath`:
+```bash
+huak completion zsh > /usr/local/share/zsh/site-functions/_huak
+```
+
+Ensure that the following is present in your `~/.zshrc`:
+
+```bash
+autoload -U compinit
+```
+
+```bash
+compinit -i
+```
+
 ## Documentation
 
 If you've cloned the repository, run `cargo doc --open`.

src/bin/huak/commands/completion.rs

@@ -0,0 +1,19 @@
+use crate::commands::Cli;
+use crate::errors::CliResult;
+
+use clap::CommandFactory;
+use clap_complete::{generate, Shell};
+
+/// Prints the script to stdout and a way to add the script to the shell init file to stderr. This
+/// way if the user runs completion <shell> > completion.sh only the stdout will be redirected into
+/// completion.sh.
+pub fn run(shell: Shell) -> CliResult<()> {
+    let mut cmd = Cli::command();
+
+    // We can't take a reference to the cmd variable since we also need a mutable reference to this
+    // in the generate() function.
+    let cmd_name = String::from(Cli::command().get_name());
+
+    generate(shell, &mut cmd, &cmd_name, &mut std::io::stdout());
+    Ok(())
+}

src/bin/huak/commands/mod.rs

@@ -1,11 +1,13 @@
 use crate::errors::CliResult;
 use clap::{Parser, Subcommand};
+use clap_complete::Shell;
 
 pub(crate) mod activate;
 pub(crate) mod add;
 pub(crate) mod audit;
 pub(crate) mod build;
 pub(crate) mod clean;
+pub(crate) mod completion;
 pub(crate) mod doc;
 pub(crate) mod fix;
 pub(crate) mod fmt;
@@ -46,6 +48,9 @@ pub enum Commands {
     Audit,
     /// Build tarball and wheel for the project.
     Build,
+    /// Generates a shell completion script for supported shells.
+    /// See the help menu for more information on supported shells.
+    Completion { shell: Shell },
     /// Remove tarball and wheel from the built project.
     Clean {
         #[arg(long, required = false)]
@@ -119,6 +124,7 @@ pub enum Commands {
 impl Cli {
     pub fn run(self) -> CliResult<()> {
         match self.command {
+            Commands::Completion { shell } => completion::run(shell),
             Commands::Activate => activate::run(),
             Commands::Add { dependency, dev } => add::run(dependency, dev),
             Commands::Audit => audit::run(),

src/huak/lib.rs

@@ -28,6 +28,60 @@
 //!
 //!Around 0.1.0 you'll be able to install `huak` using `brew` or `pip`. Distribution plans will be finalized closer to 0.1.0.
 //!
+//!## Shell completion
+//!
+//!##### Bash
+//!First, ensure that you install `bash-completion` using your package manager.
+//!After, add this to your `~/.bash_profile`:
+//!
+//!```bash
+//! eval "$(huak completion bash)"
+//!```
+//!
+//!##### Elvish
+//!This shell is supported, but the suggestion as to how this should be added to your shell init file is missing.
+//!
+//!If you are able to test this please head over to [github](https://github.com/cnpryer/huak/issues) and file an issue
+//!##### Fish
+//!Generate a `huak.fish` completion script:
+//!
+//!```bash
+//! huak completion fish > ~/.config/fish/completions/huak.fish
+//!```
+//!
+//!##### Powershell
+//!Open your profile script with:
+//!
+//!```bash
+//! mkdir -Path (Split-Path -Parent $profile) -ErrorAction SilentlyContinue
+//!```
+//!
+//!```bash
+//! notepad $profile
+//!```
+//!
+//!Add the line and save the file:
+//!```bash
+//! Invoke-Expression -Command $(huak completion powershell| Out-String)
+//!```
+//!
+//!##### Zsh
+//!Generate a `_huak` completion script and put it somewhere in your `$fpath`:
+//!```bash
+//! huak completion zsh > /usr/local/share/zsh/site-functions/_huak
+//!```
+//!
+//!Ensure that the following is present in your `~/.zshrc`:
+//!
+//!```bash
+//! autoload -U compinit
+//!```
+//!
+//!```bash
+//! compinit -i
+//!```
+//!
+//!
 //!## Goals
 //!
 //!Besides some of my own experience with the Python ecosystem, there are a few additional guiding principles steering the development of Huak: