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.

Булевы опции (те, которые включают или выключают что-либо) понимают «1», «да» или «истина» как истину и любое другое значение как ложь.

• $__fish_git_prompt_show_informative_status или опция Git bash.showInformativeStatus могут быть установлены в 1, true или yes для включения «информативного» отображения, которое покажет большое количество информации — количество грязных файлов, не отправленных/не полученных коммитов и многое другое. В больших репозиториях это может занять много времени, поэтому вы можете отключить его в таких репозиториях с помощью git config --local bash.showInformativeStatus false. Оно также меняет символы, используемые в приглашении, на менее простые (✚ вместо * для состояния грязного файла, например), и если вас интересует только это, установите $__fish_git_prompt_use_informative_chars.

  Поскольку подсчёт неотслеживаемых файлов требует много времени, количество неотслеживаемых файлов отображается только при включении функции с помощью $__fish_git_prompt_showuntrackedfiles или опции Git bash.showUntrackedFiles.

• $__fish_git_prompt_showdirtystate или опция Git bash.showDirtyState могут быть установлены в 1, true или yes, чтобы показать, является ли репозиторий «грязным», то есть содержит несохранённые изменения.
• $__fish_git_prompt_showuntrackedfiles или опция Git bash.showUntrackedFiles могут быть установлены в 1, true или yes, чтобы показать, содержит ли репозиторий неотслеживаемые файлы (которые не игнорируются).

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

  auto

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

  verbose

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

  name

  если verbose, то также показать сокращённое имя upstream

  informative

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

  git

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

  svn

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

  none

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

• $__fish_git_prompt_showstashstate может быть установлено в 1, true или yes для отображения состояния 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 может быть установлено в 1, true или yes для включения цветового выделения для имени ветки и символов состояния.

Ряд переменных устанавливает символы и цвета, используемые в качестве индикаторов. Многие из них имеют другое значение по умолчанию, если используется информативный статус или установлено $__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_branch_dirty (нет значения по умолчанию) цвет ветки, если она грязная и не отвязанная
• $__fish_git_prompt_color_branch_staged (нет значения по умолчанию) цвет ветки, если она только подготовлена и в остальном чистая
• $__fish_git_prompt_color_flags (--жирный синий) - цвет по умолчанию для состояния грязного/подготовленного/stash/неотслеживаемого

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