Как получить завершение bash для работы с псевдонимами? - PullRequest
181 голосов
/ 05 декабря 2008

Показательный пример:

Я на Mac с bash v3.2.17, я использую git, установленный через macports с вариантом bash_completion.

Когда я печатаю git checkout m<tab>. например, я получаю его заполненным до master.

Однако у меня есть псевдоним git checkout, gco. Когда я набираю gco m<tab>, я не получаю название автозаполнения.

В идеале я хотел бы, чтобы автозаполнение просто волшебным образом работало для всех моих псевдонимов. Является ли это возможным? В противном случае я бы хотел вручную настроить его для каждого псевдонима. Итак, как мне поступить?

Ответы [ 12 ]

166 голосов
/ 21 февраля 2013

Как указано в комментариях выше,

complete -o default -o nospace -F _git_checkout gco

больше не будет работать. Тем не менее, в git-creation.bash есть функция __git_complete, которую можно использовать для настройки завершения для псевдонимов, например:

__git_complete gco _git_checkout
53 голосов
/ 25 ноября 2009

Я тоже столкнулся с этой проблемой и придумал этот фрагмент кода. Это автоматически даст вам завершение для всех псевдонимов. Запустите его после объявления всех (или любых) псевдонимов.

# wrap_alias takes three arguments:
# $1: The name of the alias
# $2: The command used in the alias
# $3: The arguments in the alias all in one string
# Generate a wrapper completion function (completer) for an alias
# based on the command and the given arguments, if there is a
# completer for the command, and set the wrapper as the completer for
# the alias.
function wrap_alias() {
  [[ "$#" == 3 ]] || return 1

  local alias_name="$1"
  local aliased_command="$2"
  local alias_arguments="$3"
  local num_alias_arguments=$(echo "$alias_arguments" | wc -w)

  # The completion currently being used for the aliased command.
  local completion=$(complete -p $aliased_command 2> /dev/null)

  # Only a completer based on a function can be wrapped so look for -F
  # in the current completion. This check will also catch commands
  # with no completer for which $completion will be empty.
  echo $completion | grep -q -- -F || return 0

  local namespace=alias_completion::

  # Extract the name of the completion function from a string that
  # looks like: something -F function_name something
  # First strip the beginning of the string up to the function name by
  # removing "* -F " from the front.
  local completion_function=${completion##* -F }
  # Then strip " *" from the end, leaving only the function name.
  completion_function=${completion_function%% *}

  # Try to prevent an infinite loop by not wrapping a function
  # generated by this function. This can happen when the user runs
  # this twice for an alias like ls='ls --color=auto' or alias l='ls'
  # and alias ls='l foo'
  [[ "${completion_function#$namespace}" != $completion_function ]] && return 0

  local wrapper_name="${namespace}${alias_name}"

  eval "
function ${wrapper_name}() {
  let COMP_CWORD+=$num_alias_arguments
  args=( \"${alias_arguments}\" )
  COMP_WORDS=( $aliased_command \${args[@]} \${COMP_WORDS[@]:1} )
  $completion_function
  }
"

  # To create the new completion we use the old one with two
  # replacements:
  # 1) Replace the function with the wrapper.
  local new_completion=${completion/-F * /-F $wrapper_name }
  # 2) Replace the command being completed with the alias.
  new_completion="${new_completion% *} $alias_name"

  eval "$new_completion"
}

# For each defined alias, extract the necessary elements and use them
# to call wrap_alias.
eval "$(alias -p | sed -e 's/alias \([^=][^=]*\)='\''\([^ ][^ ]*\) *\(.*\)'\''/wrap_alias \1 \2 '\''\3'\'' /')"

unset wrap_alias
18 голосов
/ 05 декабря 2008

В git-completion.bash есть строка:

complete -o default -o nospace -F _git git

Глядя на эту строку (и функцию _git), вы можете добавить эту строку к вашему .bash_profile:

complete -o default -o nospace -F _git_checkout gco
15 голосов
/ 22 мая 2012

У меня есть псевдоним g = 'git', и в сочетании с псевдонимами git я набираю такие вещи, как

$ g co <branchname>

Более простым решением для моего конкретного случая использования было добавление одной строки в git-complete.

Прямо под этой строкой:

__git_complete git _git

Я добавил эту строку для обработки моего единственного псевдонима 'g':

__git_complete g _git
12 голосов
/ 24 декабря 2016

В идеале я хотел бы, чтобы автозаполнение просто волшебным образом работало для всех моих псевдонимов. Возможно ли это?

Да, это возможно с проектом complete-alias (в Linux). Поддержка Mac является экспериментальной, но пользователи сообщают об успехе.

5 голосов
/ 26 февраля 2016

Еще одним вариантом является использование ~/.bash_completion файла. Чтобы создать псевдоним gco для git checkout, просто вставьте это:

_xfunc git __git_complete gco _git_checkout

Затем в ~/.bashrc вы должны указать только псевдоним:

alias gco='git checkout'

Две строки. Вот и все.

Пояснение:

~/bash_completion получен в конце основного скрипта bash_completion. В gentoo я нашел основной скрипт в /usr/share/bash-completion/bash_completion.

Бит _xfunc git обеспечивает поиск файла git-completion, поэтому вам не нужно ничего помещать в ~/.bashrc.

Принятый ответ требует от вас скопировать .git-completion.sh и получить его из вашего ~/.bashrc файла, который я нахожу неудачным.


PS: Я все еще пытаюсь понять, как не использовать весь сценарий git-completion в моей среде bash. Пожалуйста, прокомментируйте или отредактируйте, если найдете способ.

5 голосов
/ 16 января 2010

Эта страница форума показывает решение.

Поместите эти строки в ваш .bashrc или .bash_profile:

# Author.: Ole J
# Date...: 23.03.2008
# License: Whatever

# Wraps a completion function
# make-completion-wrapper <actual completion function> <name of new func.>
#                         <command name> <list supplied arguments>
# eg.
#   alias agi='apt-get install'
#   make-completion-wrapper _apt_get _apt_get_install apt-get install
# defines a function called _apt_get_install (that's $2) that will complete
# the 'agi' alias. (complete -F _apt_get_install agi)
#
function make-completion-wrapper () {
    local function_name="$2"
    local arg_count=$(($#-3))
    local comp_function_name="$1"
    shift 2
    local function="
function $function_name {
    ((COMP_CWORD+=$arg_count))
    COMP_WORDS=( "$@" \${COMP_WORDS[@]:1} )
    "$comp_function_name"
    return 0
}"
    eval "$function"
}

# and now the commands that are specific to this SO question

alias gco='git checkout'

# we create a _git_checkout_mine function that will do the completion for "gco"
# using the completion function "_git"
make-completion-wrapper _git _git_checkout_mine git checkout

# we tell bash to actually use _git_checkout_mine to complete "gco"
complete -o bashdefault -o default -o nospace -F _git_checkout_mine gco

Это решение похоже на скрипт Бальшецера , но на самом деле только этот мне подходит. (У сценария Бальшецера были проблемы с некоторыми из моих псевдонимов.)

4 голосов
/ 05 декабря 2008

Вы также можете попробовать использовать псевдонимы Git. Например, в моем файле ~/.gitconfig есть раздел, который выглядит следующим образом:

[alias]
        co = checkout

Таким образом, вы можете ввести git co m<TAB>, и это должно расшириться до git co master, что является командой git checkout.

2 голосов
/ 07 ноября 2016

Вам просто нужно найти команду complete и продублировать строку с псевдонимом.

У меня есть alias d-m="docker-machine". Словом, d-m будет псевдонимом для docker-machine.

Итак, на Mac (через brew) файлы завершения находятся в cd `brew --prefix`/etc/bash_completion.d/.
Для моего случая я отредактировал файл с именем docker-machine.
Весь путь внизу был:

complete -F _docker_machine docker-machine

Итак, я просто добавил еще одну строку с моим псевдонимом:

complete -F _docker_machine docker-machine
complete -F _docker_machine d-m
0 голосов
/ 17 апреля 2019

Если вы используете alias g='git', я добавлю эту строку кода в .bash_aliases

complete -o default -o nospace -F _git g
Добро пожаловать на сайт PullRequest, где вы можете задавать вопросы и получать ответы от других членов сообщества.
...