Как мне получить завершение bash для работы с псевдонимами?

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

complete -o default -o nospace -F _git git

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

complete -o default -o nospace -F _git_checkout gco

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

[alias]
        co = checkout

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

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

# 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

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

Поместите эти строки в ваш .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

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

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

$ g co <branchname>

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

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

__git_complete git _git

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

__git_complete g _git

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

complete -o default -o nospace -F _git_checkout gco

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

__git_complete gco _git_checkout

Еще один вариант - использовать файл ~/.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. Прокомментируйте или отредактируйте, если найдете способ.

Вам просто нужно найти команду 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

Ideally I'd like autocompletion to just magically work for all my aliases. Is it possible?

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

Сначала найдите исходную команду завершения. Пример:

$ complete | grep git

complete -o bashdefault -o default -o nospace -F __git_wrap__git_main git

Теперь добавьте их в свой сценарий запуска (например, ~ / .bashrc):

# copy the original statement, but replace the last command (git) with your alias (g)
complete -o bashdefault -o default -o nospace -F __git_wrap__git_main g

# load dynamically loaded completion functions (may not be required)
_completion_loader git

Линия _completion_loader может не потребоваться. Но в некоторых ситуациях функция завершения загружается динамически только после того, как вы наберете команду и нажмете TAB в первый раз. Поэтому, если вы не использовали исходную команду и попробовали использовать псевдоним + TAB, вы можете получить сообщение об ошибке типа «bash: Завершение: функция '_docker' не найдена».

На этот вопрос можно найти множество ответов, и, как и я, держу пари, что много сбитых с толку читателей. В моем случае у меня также было требование, чтобы мои точечные файлы работали на нескольких платформах с разными версиями Git. У меня также нет alias g=git, но вместо этого g определен как функция.

Для этого мне пришлось объединить здесь разные ответы в одно решение. Хотя это уже повторяет ответы, я подумал, что кто-то в моей лодке может найти эту компиляцию полезной, как и я, когда впервые пришел к этому вопросу.

Это предполагает выполнение более старых и новых Git, значений по умолчанию для Ubuntu и brew install git в MacOS. В последнем случае установленные дополнения brew не обрабатывались bash (что я диагностирую позже).

# Alias g to git

g() {
  if [[ $# > 0 ]]; then
    git "$@"
  else
    git status -sb
  fi
}

# Preload git completion in Ubuntu which is normally lazy loaded but we need
# the __git_wrap__git_main function available for our completion.
if [[ -e /usr/share/bash-completion/completions/git ]]; then
  source /usr/share/bash-completion/completions/git
elif [[ -e /usr/local/etc/bash_completion.d/git-completion.bash ]]; then
  source /usr/local/etc/bash_completion.d/git-completion.bash
fi

if command_exists __git_complete; then
  __git_complete g _git
elif command_exists __git_wrap__git_main; then
  complete -o bashdefault -o default -o nospace -F __git_wrap__git_main g
fi

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

complete -o default -o nospace -F _git g

Фелипе Контрерас, который уже достаточно активен для функций завершения Git (см. Завершение Zsh в Git 2.30), предлагает (для - возможно - Git 2.31, Q1 2021) общедоступную функцию, которая поможет с автозаполнением псевдонимов.

Его предложение:

Back in 2012 I argued for the introduction of a helper that would allow users to specify aliases like:

git_complete gf git_fetch

Back then there was pushback because there was no clear guideline for public functions (git_complete vs _git_complete vs _GIT_complete), and some aliases didn't actually work.

Fast-forward to 2020 and there's still no guideline for public functions, and those aliases still don't work (even though I sent the fixes).

This has not prevented people from using this function that is clearly needed to setup custom aliases (this page), and in fact it's the recommended way.

But it is cumbersome that the user must type:

__git_complete gf _git_fetch

Or worse:

__git_complete gk __gitk_main

8 years is more than enough time to stop waiting for the perfect to come; let's define a public function (with the same name) that is actually user-friendly:

__git_complete gf git_fetch
__git_complete gk gitk

While also maintaining backwards compatibility.

The logic is:

1. If $2 exists, use it directly
2. If not, check if __$2_main exists
3. If not, check if _$2 exists
4. If not, fail

Вы можете привязать Tab к alias-expand-line и complete (его действие по умолчанию) в ~/.inputrc. Для этого вам сначала нужно связать каждое действие с ключом, а затем связать их вместе следующим образом:

"\M-z":alias-expand-line
"\M-x":complete
TAB:"\M-z\M-x"

Вы можете использовать любые комбинации клавиш, которые вам нравятся, я использую Meta, потому что это бесплатно. См. man 3 readline для получения дополнительной информации.

Теперь, если вы откроете новый терминал и наберете псевдоним:

gco m<TAB>

Линия будет преобразована в

git checkout master

Конечно, Tab по-прежнему будет работать в обычном режиме, даже если не указан псевдоним.