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

Синопсис

fish_git_prompt

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 (--полужирный синий) - цвет по умолчанию для состояния «грязного»/«в очереди»/«в стэше»/«не отслеживаемого»

Обратите внимание, что все цвета также могут иметь соответствующий цвет _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