Lerking/micropython
1
0
Fork 0
mirror of https://github.com/micropython/micropython.git synced 2026-01-04 11:10:14 +01:00
Code Issues Actions 52 Packages Projects Releases Wiki Activity

tools/ci.sh: Add zsh and fish shell completion support.

Browse Source 
This commit adds custom command completion functions for both the zsh
and fish shell.

The behaviour for those new completions follow the existing completion
for the bash shell, including the way to generate the completion alias
(with appropriately named command line switches).

Signed-off-by: Alessandro Gatti <a.gatti@frob.it>
This commit is contained in:
Alessandro Gatti
2025-11-19 02:50:12 +01:00
committed by Damien George
parent d1caa9df07
commit 4633d2a037
2 changed files with 23 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
docs/develop/gettingstarted.rst
View File

@@ -338,7 +338,15 @@ If you use the bash shell, you can add a ``ci`` command with tab completion:
.. code-block:: bash
$ eval `tools/ci.sh --bash-completion`
$ eval $(tools/ci.sh --bash-completion)
For the zsh shell, replace ``--bash-completion`` with ``--zsh-completion``.
For the fish shell, replace ``--bash-completion`` with ``--fish-completion``.
Then, typing:
.. code-block:: bash
$ ci unix_cov<tab>
This will complete the ci step name to ``unix_coverage_``.

14
tools/ci.sh
View File

@@ -1049,6 +1049,14 @@ function _ci_bash_completion {
echo "alias ci=\"$(readlink -f "$0")\"; complete -W '$(grep '^function ci_' $0 | awk '{print $2}' | sed 's/^ci_//')' ci"
}
function _ci_zsh_completion {
echo "alias ci=\"$(readlink -f "$0"\"); _complete_mpy_ci_zsh() { compadd $(grep '^function ci_' $0 | awk '{sub(/^ci_/,"",$2); print $2}' | tr '\n' ' ') }; autoload -Uz compinit; compinit; compdef _complete_mpy_ci_zsh $(readlink -f "$0")"
}
function _ci_fish_completion {
echo "alias ci=\"$(readlink -f "$0"\"); complete -c ci -p $(readlink -f "$0") -f -a '$(grep '^function ci_' $(readlink -f "$0") | awk '{sub(/^ci_/,"",$2); print $2}' | tr '\n' ' ')'"
}
function _ci_main {
case "$1" in
(-h|-?|--help)
@@ -1057,6 +1065,12 @@ function _ci_main {
(--bash-completion)
_ci_bash_completion
;;
(--zsh-completion)
_ci_zsh_completion
;;
(--fish-completion)
_ci_fish_completion
;;
(-*)
echo "Unknown option: $1" 1>&2
exit 1