fish_git_prompt - вывод информации git для использования в подсказке

Резюме

function fish_prompt
     printf '%s' $PWD (fish_git_prompt) ' $ '
end

Описание

Функция fish_git_prompt отображает информацию о текущем репозитории git, если таковой имеется.

Git должен быть установлен.

Существует множество параметров настройки, которые можно контролировать с помощью параметров git или переменных оболочки fish. Параметры git, где это возможно, имеют приоритет над переменной оболочки fish с той же функцией. Параметры git могут быть настроены на уровне отдельного репозитория или глобально. Параметры git можно установить с помощью команды git config, а переменные оболочки fish можно установить как обычно с помощью команды set.

• $__fish_git_prompt_show_informative_status или параметр git bash.showInformativeStatus можно установить для включения отображения "информации", которое покажет большое количество информации: количество не отслеживаемых файлов, грязных файлов, не отправленных/не полученных коммитов и многое другое. В больших репозиториях это может занять много времени, поэтому вы можете отключить его в этих репозиториях с помощью git config --local bash.showInformativeStatus false. Также это изменит символы, используемые в подсказке, на менее простые (✚ вместо * для состояния "грязных" файлов, например), и если вас интересует только это, установите $__fish_git_prompt_use_informative_chars.
• $__fish_git_prompt_showdirtystate или параметр git bash.showDirtyState можно установить для отображения, является ли репозиторий "грязным", то есть содержит ли он несохраненные изменения.
• $__fish_git_prompt_showuntrackedfiles или параметр git bash.showUntrackedFiles можно установить для отображения, содержит ли репозиторий не отслеживаемые файлы (которые не игнорируются).

• $__fish_git_prompt_showupstream можно установить в список значений, чтобы определить, как отображать изменения между HEAD и upstream:

  auto

  сводка различий между HEAD и его upstream

  verbose

  отображение количества коммитов опережающих/отстающих (+/-) от upstream

  name

  если verbose, то также отображается сокращенное имя upstream

  informative

  аналогично verbose, но ничего не отображает, когда значения равны - это значение по умолчанию, если включен информативный статус.

  git

  всегда сравнивает HEAD с @{upstream}

  svn

  всегда сравнивает HEAD с вашим SVN upstream

  none

  отключает (полезно с информативным статусом)

• $__fish_git_prompt_showstashstate можно установить для отображения состояния stash.
• $__fish_git_prompt_shorten_branch_len можно установить в число символов, до которых будет сокращено имя ветви.

• $__fish_git_prompt_describe_style можно установить в один из следующих стилей для описания текущего HEAD:

  contains

  относительно более новой аннотированной метки, такой как (v1.6.3.2~35)

  branch

  относительно более новой метки или ветви, такой как (master~4)

  describe

  относительно более старой аннотированной метки, такой как (v1.6.3.1-13-gdd42c2f)

  default

  абсолютно совпадающая метка ((develop))

  Если ни один из этих вариантов не подходит, используется сокращенный до 8 символов SHA коммита.

• $__fish_git_prompt_showcolorhints можно установить для включения цветного отображения имени ветви и символов статуса.

Ряд переменных устанавливает символы и цвета, используемые в качестве индикаторов. Многие из них имеют другое значение по умолчанию, если включен информативный статус, или установлен $__fish_git_prompt_use_informative_chars. Стандартное значение по умолчанию приводится первым, затем информативное по умолчанию (если оно отличается). Если для цветов не задано значение по умолчанию, оно устанавливается в $__fish_git_prompt_color.

• $__fish_git_prompt_char_stateseparator (' ', |) - символ, используемый между символами состояния
• $__fish_git_prompt_color (значение по умолчанию отсутствует)
• $__fish_git_prompt_color_prefix - цвет префикса (
• $__fish_git_prompt_color_suffix - цвет суффикса )
• $__fish_git_prompt_color_bare - цвет, используемый для голого репозитория - без рабочей области
• $__fish_git_prompt_color_merging - цвет, используемый, когда происходит слияние/перебазирование/отмена/бисекция или cherry-pick

Некоторые переменные используются только в определенных режимах, например, при включенном информативном статусе:

• $__fish_git_prompt_char_cleanstate (✔) - символ, используемый, когда ничего больше не применяется
• $__fish_git_prompt_color_cleanstate

Переменные, используемые с showdirtystate:

• $__fish_git_prompt_char_dirtystate (*, ✚) - количество "грязных" изменений, т.е. не поставленных в индекс файлов с изменениями
• $__fish_git_prompt_char_invalidstate (#, ✖) - количество "неслитых" изменений, например, дополнительных изменений в уже добавленных файлах
• $__fish_git_prompt_char_stagedstate (+, ●) - количество файлов в индексе без дополнительных изменений
• $__fish_git_prompt_color_dirtystate (красный при showcolorhints, такой же как color_flags в противном случае)
• $__fish_git_prompt_color_invalidstate
• $__fish_git_prompt_color_stagedstate (зеленый при showcolorhints, color_flags в противном случае)

Переменные, используемые с showstashstate:

• $__fish_git_prompt_char_stashstate ($, ⚑)
• $__fish_git_prompt_color_stashstate (также как color_flags)

Переменные, используемые с showuntrackedfiles:

• $__fish_git_prompt_char_untrackedfiles (%, …) - символ для не отслеживаемых файлов
• $__fish_git_prompt_color_untrackedfiles (также как color_flags)

Переменные, используемые с showupstream (также подразумеваются информативным статусом):

• $__fish_git_prompt_char_upstream_ahead (>, ↑) - символ для коммитов, на которые этот репозиторий опережает upstream
• $__fish_git_prompt_char_upstream_behind (<, ↓) - символ для коммитов, на которые этот репозиторий отстает от upstream
• $__fish_git_prompt_char_upstream_diverged (<>) - символ, если этот репозиторий как опережает, так и отстаёт от upstream
• $__fish_git_prompt_char_upstream_equal (=) - символ, если этот репозиторий равен upstream
• $__fish_git_prompt_char_upstream_prefix ('')
• $__fish_git_prompt_color_upstream

Цвета, используемые с showcolorhints:

• $__fish_git_prompt_color_branch (зеленый) - цвет ветви
• $__fish_git_prompt_color_branch_detached (красный) цвет ветви, если она отсоединена (например, коммит выделен)
• $__fish_git_prompt_color_flags (--жирный синий) - цвет по умолчанию для состояния dirty/staged/stashed/untracked

Обратите внимание, что все цвета также могут иметь соответствующий цвет _done . Например, содержимое $__fish_git_prompt_color_upstream_done печатается сразу _после_ upstream.

См. также fish_vcs_prompt, которая вызовет все поддерживаемые функции подсказок для системы контроля версий, включая git, Mercurial и Subversion.

Пример

Простая подсказка, которая отображает информацию git:

function fish_prompt
    # ...
    set -g __fish_git_prompt_showupstream auto
    printf '%s %s$' $PWD (fish_git_prompt)
end