Jak stworzyć skrypt z autouzupełnianiem?

Kiedy używam programu podobnego svni piszę w Gnome Terminal:

svn upd

i naciśnij, Tabże autouzupełnianie:

svn update

Czy można zrobić coś takiego w niestandardowym skrypcie bash?

Możesz użyć programowalnego zakończenia . Mają zapoznać się /etc/bash_completioni /etc/bash_completion.d/*dla niektórych przykładów.

Spóźniłem się sześć miesięcy, ale szukałem tego samego i znalazłem to:

Musisz utworzyć nowy plik:

/etc/bash_completion.d/foo

W przypadku statycznego autouzupełniania ( --help/ --verbosena przykład) dodaj:

_foo() 
{
    local cur prev opts
    COMPREPLY=()
    cur="${COMP_WORDS[COMP_CWORD]}"
    prev="${COMP_WORDS[COMP_CWORD-1]}"
    opts="--help --verbose --version"

    if [[ ${cur} == -* ]] ; then
        COMPREPLY=( $(compgen -W "${opts}" -- ${cur}) )
        return 0
    fi
}
complete -F _foo foo

• COMP_WORDS to tablica zawierająca wszystkie pojedyncze słowa w bieżącym wierszu poleceń.
• COMP_CWORD jest indeksem słowa zawierającego bieżącą pozycję kursora.
• COMPREPLY jest zmienną tablicową, z której Bash czyta możliwe uzupełnienia.

A compgenkomenda zwraca tablicę z elementów --help, --verbosei --versiondopasowanie bieżące słowo "${cur}":

compgen -W "--help --verbose --version" -- "<userinput>"

Źródło: http://www.debian-administration.org/articles/316

Wszystkie uzupełnienia bash są przechowywane w /etc/bash_completion.d/. Więc jeśli budujesz oprogramowanie z bash_completion, warto by deb / make install upuścił plik z nazwą oprogramowania w tym katalogu. Oto przykładowy skrypt zakończenia bash dla Rsync:

# bash completion for rsync

have rsync &&
_rsync()
{
    # TODO: _split_longopt

    local cur prev shell i userhost path   

    COMPREPLY=()
    cur=`_get_cword`
    prev=${COMP_WORDS[COMP_CWORD-1]}

    _expand || return 0

    case "$prev" in
    --@(config|password-file|include-from|exclude-from))
        _filedir
        return 0
        ;;
    -@(T|-temp-dir|-compare-dest))
        _filedir -d
        return 0
        ;;
    -@(e|-rsh))
        COMPREPLY=( $( compgen -W 'rsh ssh' -- "$cur" ) )
        return 0
        ;;
    esac

    case "$cur" in
    -*)
        COMPREPLY=( $( compgen -W '-v -q  -c -a -r -R -b -u -l -L -H \
            -p -o -g -D -t -S -n -W -x -B -e -C -I -T -P \
            -z -h -4 -6 --verbose --quiet --checksum \
            --archive --recursive --relative --backup \
            --backup-dir --suffix= --update --links \
            --copy-links --copy-unsafe-links --safe-links \
            --hard-links --perms --owner --group --devices\
            --times --sparse --dry-run --whole-file \
            --no-whole-file --one-file-system \
            --block-size= --rsh= --rsync-path= \
            --cvs-exclude --existing --ignore-existing \
            --delete --delete-excluded --delete-after \
            --ignore-errors --max-delete= --partial \
            --force --numeric-ids --timeout= \
            --ignore-times --size-only --modify-window= \
            --temp-dir= --compare-dest= --compress \
            --exclude= --exclude-from= --include= \
            --include-from= --version --daemon --no-detach\
            --address= --config= --port= --blocking-io \
            --no-blocking-io --stats --progress \
            --log-format= --password-file= --bwlimit= \
            --write-batch= --read-batch= --help' -- "$cur" ))
        ;;
    *:*)
        # find which remote shell is used
        shell=ssh
        for (( i=1; i < COMP_CWORD; i++ )); do
            if [[ "${COMP_WORDS[i]}" == -@(e|-rsh) ]]; then
                shell=${COMP_WORDS[i+1]}
                break
            fi
        done
        if [[ "$shell" == ssh ]]; then
            # remove backslash escape from :
            cur=${cur/\\:/:}
            userhost=${cur%%?(\\):*}
            path=${cur#*:}
            # unescape spaces
            path=${path//\\\\\\\\ / }
            if [ -z "$path" ]; then
                # default to home dir of specified
                # user on remote host
                path=$(ssh -o 'Batchmode yes' $userhost pwd 2>/dev/null)
            fi
            # escape spaces; remove executables, aliases, pipes
            # and sockets; add space at end of file names
            COMPREPLY=( $( ssh -o 'Batchmode yes' $userhost \
                command ls -aF1d "$path*" 2>/dev/null | \
                sed -e 's/ /\\\\\\\ /g' -e 's/[*@|=]$//g' \
                -e 's/[^\/]$/& /g' ) )
        fi
        ;;
    *)  
        _known_hosts_real -c -a "$cur"
        _filedir
        ;;
    esac

    return 0
} &&
complete -F _rsync $nospace $filenames rsync

# Local variables:
# mode: shell-script
# sh-basic-offset: 4
# sh-indent-comment: t
# indent-tabs-mode: nil
# End:
# ex: ts=4 sw=4 et filetype=sh

Warto byłoby przejrzeć jeden z plików uzupełniających bash, które najbardziej pasują do twojego programu. Jednym z najprostszych przykładów jest rrdtoolplik.

Oto kompletny samouczek.

Załóżmy przykładowy skrypt o nazwie admin.sh, do którego chcesz, aby autouzupełnianie działało.

#!/bin/bash

while [ $# -gt 0 ]; do
  arg=$1
  case $arg in
    option_1)
     # do_option_1
    ;;
    option_2)
     # do_option_1
    ;;
    shortlist)
      echo option_1 option_2 shortlist
    ;;
    *)
     echo Wrong option
    ;;
  esac
  shift
done

Uwaga krótka lista opcji. Wywołanie skryptu z tą opcją spowoduje wydrukowanie wszystkich możliwych opcji dla tego skryptu.

A tutaj masz skrypt autouzupełniania:

_script()
{
  _script_commands=$(/path/to/your/script.sh shortlist)

  local cur
  COMPREPLY=()
  cur="${COMP_WORDS[COMP_CWORD]}"
  COMPREPLY=( $(compgen -W "${_script_commands}" -- ${cur}) )

  return 0
}
complete -o nospace -F _script ./admin.sh

Zauważ, że ostatnim argumentem do uzupełnienia jest nazwa skryptu, do którego chcesz dodać autouzupełnianie. Wszystko, co musisz zrobić, to dodać swój skrypt autouzupełniania do bashrc as

source /path/to/your/autocomplete.sh

lub skopiuj go do /etc/bash.completion.d

Jeśli wszystko, czego chcesz, to proste automatyczne uzupełnianie oparte na słowach (więc nie uzupełniaj podkomendy ani nic takiego), completepolecenie ma -Wopcję, która po prostu robi właściwą rzecz.

Na przykład mam następujące wiersze .bashrcdo autouzupełniania programu o nazwie jupyter :

# gleaned from `jupyter --help`
_jupyter_options='console qtconsole notebook' # shortened for this answer
complete -W "${_jupyter_options}" 'jupyter'

Teraz jupyter <TAB> <TAB>autouzupełnianie dla mnie.

W docs w gnu.org są pomocne.

Wygląda na to, że IFSzmienna jest ustawiona poprawnie, ale nie spowodowało to dla mnie żadnych problemów.

Aby dodać uzupełnienie nazwy pliku i domyślne uzupełnienie BASH, użyj -oopcji:

complete -W "${_jupyter_options}" -o bashdefault -o default 'jupyter'

Aby użyć tego w zsh, dodaj następujący kod przed uruchomieniem completepolecenia w swoim ~/.zshrc:

# make zsh emulate bash if necessary
if [[ -n "$ZSH_VERSION" ]]; then
    autoload bashcompinit
    bashcompinit
fi