Add: Provide command completion for zsh and bash

bjoernricks · bjoernricks · commit 0bd63893c509 · 2024-01-31T12:16:15.000+01:00
Allow to install command completions for zsh and bash.
diff --git a/README.md b/README.md
@@ -19,6 +19,7 @@ Welcome to **autohooks**!
 - [Requirements](#requirements)
 - [Plugins](#plugins)
 - [Installing autohooks](#installing-autohooks)
+- [Command Completion](#command-completion)
 - [Maintainer](#maintainer)
 - [Contributing](#contributing)
 - [License](#license)
@@ -104,6 +105,33 @@ will use the [pythonpath mode](#pythonpath-mode) by default.
 For more details on using [pip], [poetry] or [pipenv] in conjunction with these
 modes see the [documentation](https://greenbone.github.io/autohooks).
 
+## Command Completion
+
+`autohooks` comes with support for command line completion in bash
+and zsh.
+
+Setup for bash:
+
+```bash
+echo "source ~/.autohooks-complete.bash" >> ~/.bashrc
+autohooks --print-completion bash > ~/.autohooks-complete.bash
+```
+
+Alternatively, you can use the result of the completion command directly with
+the eval function of your bash shell:
+
+```bash
+eval "$(autohooks --print-completion bash)"
+```
+
+Setup for zsh:
+
+```zsh
+echo 'fpath=("$HOME/.zsh.d" $fpath)' >> ~/.zsh
+mkdir -p ~/.zsh.d/
+autohooks --print-completion zsh > ~/.zsh.d/_greenbone_feed_sync
+```
+
 ## Maintainer
 
 This project is maintained by [Greenbone AG](https://www.greenbone.net/).
diff --git a/autohooks/cli/__init__.py b/autohooks/cli/__init__.py
@@ -6,6 +6,8 @@
 import argparse
 import sys
 
+import shtab
+
 from autohooks.__version__ import __version__ as version
 from autohooks.cli.activate import install_hooks
 from autohooks.cli.check import check_hooks
@@ -23,6 +25,7 @@
 
 def main():
     parser = argparse.ArgumentParser(description=DESCRIPTION)
+    shtab.add_argument_to(parser)
     parser.add_argument(
         "--version",
         action="version",
diff --git a/poetry.lock b/poetry.lock
diff --git a/pyproject.toml b/pyproject.toml
@@ -41,6 +41,7 @@ python = "^3.9"
 tomlkit = ">=0.5.11"
 pontos = ">=22.8.0"
 rich = ">=12.5.1"
+shtab = ">=1.6.5"
 
 [tool.poetry.dev-dependencies]
 autohooks-plugin-black = ">=21.12.0"
