Add completions for bash and zsh

[smyrick]

This pull request introduces shell completion support for Rover, allowing users to generate bash and zsh completion scripts via new commands. It adds the necessary implementation, updates dependencies, and provides integration tests and documentation for Homebrew formula updates. These changes improve the user experience by enabling tab completion for Rover commands in bash and zsh shells.

This was created with Cursor AI. I am not a Rust expert but the code seems reasonable to me. Please provide more feedback that necessary.

Shell Completion Feature

• Added new rover completion bash and rover completion zsh commands, which generate shell completion scripts for bash and zsh, respectively, using the clap_complete crate. [1] [2] [3] [4]
• Updated the CLI logic to skip update checks for completion commands and properly dispatch to the new completion handlers. [1] [2]

Dependency Updates

• Added clap_complete as a dependency in both the main and workspace sections of Cargo.toml to support shell completion generation. [1] [2]

Testing

• Added integration tests to verify that the rover completion bash and rover completion zsh commands generate the expected completion scripts. [1] [2]

Documentation

• Added a new HOMEBREW_FORMULA_UPDATE.md file detailing the changes required to the Homebrew formula for automatic installation of completion scripts.

Changelog

• Updated CHANGELOG.md to document the addition of shell completion support for bash and zsh.

[apollo-librarian]

✅ Docs preview ready

The preview is ready to be viewed. View the preview

File Changes

1 new, 2 changed, 0 removed

+ (developer-tools)/rover/commands/completion.mdx
* (developer-tools)/rover/getting-started.mdx
* (developer-tools)/rover/_sidebar.yaml

Build ID: fe56d79e2e787cff8f45a6ec
Build Logs: View logs

URL: https://www.apollographql.com/docs/deploy-preview/fe56d79e2e787cff8f45a6ec

[dylan-apollo]

Kinda hard to test this for real automatically—have you manually tested with both bash and zsh?

[smyrick]

[smyrick]

I updated the test to at least validate the output is valid bash and zsh scripts.

[smyrick]

For updating later:

Homebrew Formula Update for Shell Completions

This document describes the changes needed to the Homebrew formula to automatically install bash and zsh completion scripts when Rover is installed via Homebrew.

Formula Location

The Rover Homebrew formula is maintained at:
https://github.com/Homebrew/homebrew-core/blob/master/Formula/r/rover.rb

Required Changes

Update the install method in the formula to generate and install completion scripts:

def install
  # Ensure that the `openssl` crate picks up the intended library.
  ENV["OPENSSL_DIR"] = Formula["openssl@3"].opt_prefix
  ENV["OPENSSL_NO_VENDOR"] = "1"

  system "cargo", "install", *std_cargo_args

  # Generate and install bash completion
  bash_completion.install Utils.safe_popen_read(bin/"rover", "completion", "bash")

  # Generate and install zsh completion
  zsh_completion.install Utils.safe_popen_read(bin/"rover", "completion", "zsh")
end

Explanation

• bash_completion.install installs the bash completion script to share/bash-completion/completions/rover
• zsh_completion.install installs the zsh completion script to share/zsh/site-functions/_rover
• Utils.safe_popen_read executes the rover completion command and captures its output
• The completion scripts are generated dynamically using the rover completion subcommand

Testing

After updating the formula:

1. Install Rover via Homebrew: brew install rover
2. Verify bash completion is installed: ls $(brew --prefix)/share/bash-completion/completions/rover
3. Verify zsh completion is installed: ls $(brew --prefix)/share/zsh/site-functions/_rover
4. Test completion in your shell (may require restarting the shell or sourcing completion files)

Notes

• Bash completion requires bash-completion to be installed (usually via brew install bash-completion@2)
• Zsh completion should work automatically if zsh is configured properly
• Users may need to restart their shell or source completion files for completions to take effect

[naomijub]

@smyrick there are conflicts on Cargo.lock, can you update?

[smyrick]

@naomijub I am not sure why the other jobs are failing now. It looks like they are not setup for NodeJS? Is that a separate issue?

It looks like other PRs have the same issue: #2893

[naomijub]

Docs review approved

[smyrick]

Validated and working with Homebrew!