# Расширенная конфигурация Хотя Starship - это универсальная оболочка, иногда вам нужно сделать больше, чем просто редактировать `starship.toml`, для того чтобы сделать определенные вещи. Эта страница описывает некоторые из дополнительных техник конфигурации, используемых в Starship. ::: warning Конфигурации в этом разделе могут быть изменены в будущих выпусках Starship. ::: ## TransientPrompt для PowerShell Можно заменить предыдущий выведенный промпт на пользовательскую строку. Это полезно в тех случаях, когда весь промпт не всегда нужен. Чтобы включить, запустите `Enable-TransientPrompt` в сеансе оболочки. Чтобы включить его глобально, вставьте это в ваш `$PROFILE` Переход может быть отключён на лету с помощью `Disable-TransientPrompt`. По умолчанию, левая сторона ввода заменяется на `>`. Для настройки определите новую функцию под названием `Invoke-Starship-TransientFunction`. Например, чтобы отобразить модуль Starship `character`, вы должны выполнить ```powershell function Invoke-Starship-TransientFunction { &starship module character } Invoke-Expression (&starship init powershell) Enable-TransientPrompt ``` ## TransientPrompt и TransientRightPrompt в Cmd Clink позволяет заменить предыдущий выведенный промпт на пользовательские строки. Это полезно в тех случаях, когда весь промпт не всегда нужен. Чтобы включить это, запустите `clink set prompt.transient `, где \ может быть одним из - `always`: всегда заменять предыдущий промпт - `same_dir`: заменять предыдущий промпт только если рабочая директория та же - `off`: не заменять промпт (т.е. выключить переход) Вы должны сделать это только один раз. Внесите следующие изменения в ваш `starship.lua`, чтобы настроить, что отображается слева и справа: - По умолчанию, левая сторона ввода заменяется на `>`. Чтобы настроить это, определите новую функцию под названием `starship_transient_prompt_func`. Эта функция получает текущий промпт как строку, которую вы можете использовать. Например, чтобы отобразить здесь модуль Starship `character`, вы должны выполнить ```lua function starship_transient_prompt_func(prompt) return io.popen("starship module character" .." --keymap="..rl.getvariable('keymap') ):read("*a") end load(io.popen('starship init cmd'):read("*a"))() ``` - По умолчанию, правая сторона ввода пуста. Для настройки определите новую функцию под названием `starship_transient_rprompt_func`. Эта функция получает текущий промпт как строку, которую вы можете использовать. Например, чтобы отобразить время, когда здесь была запущена последняя команда, вы должны выполнить ```lua function starship_transient_rprompt_func(prompt) return io.popen("starship module time"):read("*a") end load(io.popen('starship init cmd'):read("*a"))() ``` ## TransientPrompt и TransientRightPrompt в Fish Можно заменить предыдущий выведенный промпт на пользовательскую строку. Это полезно в тех случаях, когда весь промпт не всегда нужен. Чтобы включить это, запустите `enable_transience` в сеансе оболочки. Чтобы включить его глобально, добавьте это в ваш `~/.config/fish/config.fish`. Переход может быть отключён на лету с помощью `disable_transience`. Обратите внимание, что в случае с Fish, временный промпт печатается только в том случае, если командная строка не пустая и синтаксически верна. - По умолчанию, левая сторона ввода заменяется жирным зеленым `❯`. Для настройки определите новую функцию под названием `starship_transient_prompt_func`. Например, чтобы отобразить здесь модуль Starship `character`, вы должны выполнить ```fish function starship_transient_prompt_func starship module character end starship init fish | source enable_transience ``` - По умолчанию, правая сторона ввода пуста. Для настройки определите новую функцию под названием `starship_transient_rprompt_func`. Например, чтобы отобразить время, когда здесь была запущена последняя команда, вы должны выполнить ```fish function starship_transient_rprompt_func starship module time end starship init fish | source enable_transience ``` ## TransientPrompt и TransientRightPrompt в Bash Фреймворк [Ble.sh](https://github.com/akinomyoga/ble.sh) в версии 0.4 или выше позволяет заменить выведенный ранее промпт, пользовательскими строками. Это полезно в тех случаях, когда весть промпт не всегда нужен. Чтобы включить это, добавьте в `~/.bashrc` `bleopt prompt_ps1_transient=`: ` здесь - это разделённый двоеточиями список, состоящий из always, <1>same-dir и <1>trim. Когда prompt_ps1_final пуст, а опция <0>prompt_ps1_transient - не пустой \, промпт, указанный <0>PS1 удаляется при выходе из текущей командной строки. Если \ содержит поле trim`, сохраняется только последняя строка многострочного `PS1`, а остальные линии стираются. Иначе командная строка будет перерисована, будто `PS1=` установлено. Когда поле `same-dir` содержится в \ и текущий рабочий каталог отличается от конечного каталога предыдущей командной строки, этот параметр `prompt_ps1_transient` игнорируется. Внесите следующие изменения в свой `~/.blerc` (или в `~/.config/blesh/init.sh `), чтобы настроить отображение слева и справа: - Чтобы настроить, на что будет заменена левая часть ввода, настройте параметр `prompt_ps1_final` Ble.sh. Например, чтобы отобразить здесь символ Starship's `character` модуля здесь, вы бы сделали ```bash bleopt prompt_ps1_final='$(starship module character)' ``` - Чтобы настроить, на что будет заменена правая часть ввода, настройте параметр `prompt_rps1_final` Ble.sh. Например, чтобы отобразить время, когда здесь была запущена последняя команда, вы должны выполнить ```bash bleopt prompt_rps1_final='$(starship module time)' ``` ## Пользовательские команды предварительного промпта и предварительного выполнения в Cmd Clink предоставляет чрезвычайно гибкие API-интерфейсы для запуска команд предварительного промпта и предварительного выполнения в оболочке Cmd. Он довольно прост в использовании со Starship. Внесите следующие изменения в свой файл `starship.lua` в соответствии с вашими требованиями: - Чтобы запустить пользовательскую функцию непосредственно перед отображением промпта, определите новую функцию с именем `starship_preprompt_user_func`. Эта функция получает текущий промпт в виде строки, которую вы можете использовать. Например, чтобы нарисовать ракету перед промптом, вы должны сделать ```lua function starship_preprompt_user_func(prompt) print("🚀") end load(io.popen('starship init cmd'):read("*a"))() ``` - Чтобы запустить пользовательскую функцию непосредственно перед выполнением команды, определите новую функцию с именем `starship_precmd_user_func`. Эта функция получает текущую командную строку в виде строки, которую вы можете использовать. Например, чтобы напечатать команду, которая вот-вот будет выполнена, вы должны сделать ```lua function starship_precmd_user_func(line) print("Executing: "..line) end load(io.popen('starship init cmd'):read("*a"))() ``` ## Пользовательские команды перед командной строкой и перед запуском Bash Bash не имеет формальной среды preexec/precmd, как и большинство других оболочек. Из-за этого трудно предоставить полностью настраиваемые хуки в `bash`. Тем не менее, Starship дает вам ограниченную возможность вставить собственные функции в процедуру отображения подсказки: - Чтобы запустить пользовательскую функцию прямо перед отображением подсказки, определите новую функцию и затем назначьте ей имя `starship_precmd_user_func`. Например, чтобы нарисовать ракету перед появлением подсказки, сделайте ```bash function blastoff(){ echo "🚀" } starship_precmd_user_func="blastoff" ``` - Чтобы запустить пользовательскую функцию непосредственно перед выполнением команды, вы можете использовать механизм ловушки [`DEBUG`](https://jichu4n.com/posts/debug-trap-and-prompt_command-in-bash/). Тем не менее, вы **должны** поймать сигнал DEBUG _перед_ инициализацией Starship! Starship может сохранить значение ловушки DEBUG, но если ловушка перезаписана после запуска Starship, некоторая функциональность сломается. ```bash function blastoff(){ echo "🚀" } trap blastoff DEBUG # Ловушка DEBUG *перед* запуском starship set -o functrace eval $(starship init bash) set +o functrace ``` ## Пользовательские команды предварительного промпта и предварительного выполнения в PowerShell PowerShell не имеет формальной платформы preexec/precmd, как большинство других оболочек. Из-за этого трудно предоставить полностью настраиваемые хуки в `powershell`. Тем не менее, Starship дает вам ограниченную возможность вставить собственные функции в процедуру отображения подсказки: Создайте функцию с именем `Invoke-Starship-PreCommand` ```powershell function Invoke-Starship-PreCommand { $host.ui.Write("🚀") } ``` ## Изменение заголовка окна Некоторые промпты командной строки автоматически изменят название окна для вас (например, чтобы оно отражало ваш рабочий каталог). Fish даже делает это по умолчанию. Starship этого не делает, но довольно просто добавить эту функциональность в `bash`, `zsh`, `cmd` или `powershell`. Сначала задайте функцию изменения заголовка окна (идентичную в bash и zsh): ```bash function set_win_title(){ echo -ne "\033]0; YOUR_WINDOW_TITLE_HERE \007" } ``` Вы можете использовать переменные для настройки этого заголовка (`$USER`, `$HOSTNAME`, и `$PWD` являются популярными вариантами). В `bash`, установите эту функцию как функцию precmd в Starship: ```bash starship_precmd_user_func="set_win_title" ``` В `zsh`, добавьте это в массив `precmd_functions`: ```bash precmd_functions+=(set_win_title) ``` Если вам нравится результат, добавьте эти строки в свой файл конфигурации оболочки (`~/.bashrc` или `~/.zshrc`), чтобы сделать его постоянным. Например, если вы хотите отобразить ваш текущий каталог в заголовке вкладки терминала, добавьте следующие строки в `~/. bashrc` или `~/.zshrc`: ```bash function set_win_title(){ echo -ne "\033]0; $(basename "$PWD") \007" } starship_precmd_user_func="set_win_title" ``` Для Cmd вы можете изменить заголовок окна, используя функцию `starship_preprompt_user_func`. ```lua function starship_preprompt_user_func(prompt) console.settitle(os.getenv('USERNAME').."@"..os.getenv('COMPUTERNAME')..": "..os.getcwd()) end load(io.popen('starship init cmd'):read("*a"))() ``` Вы также можете настроить аналогичный вывод с помощью PowerShell, создав функцию с именем `Invoke-Starship-PreCommand`. ```powershell # edit $PROFILE function Invoke-Starship-PreCommand { $host.ui.RawUI.WindowTitle = "$env:USERNAME@$env:COMPUTERNAME`: $pwd `a" } Invoke-Expression (&starship init powershell) ``` ## Включить Правый Промпт Некоторые оболочки поддерживают правый промпт, который отображается в той же строке, что и входные данные. Starship может задать содержание правого промпта, используя опцию `right_format`. Любой модуль, который может быть использован в `format`, также поддерживается в `right_format`. Переменная `$all` будет содержать только модули, явно не используемые ни в `format`, ни в `right_format`. Примечание: Правые промпты состоят из одной строки, следующий за местоположением ввода. Чтобы выровнять модули по правому краю над строкой ввода в многострочном промпте, ознакомьтесь с [`fill` module](../config/#fill). `right_format` в настоящее время поддерживается для следующих оболочек: elvish, fish, zsh, xonsh, cmd, nutshell, bash. Примечание: [Ble.sh ](https://github.com/akinomyoga/ble.sh) используя правый промпт в bash необходимо установить фреймворк версии 0.4 или выше. ### Пример ```toml # ~/.config/starship.toml # Минимальный левый промпт format = """$character""" # переместите остальную часть промпта вправо right_format = """$all""" ``` Выдает промпт, подобный следующему: ``` ▶ starship on  rprompt [!] is 📦 v0.57.0 via 🦀 v1.54.0 took 17s ``` ## Продолжение Промпта Некоторые оболочки поддерживают промпт продолжения наряду с обычным промптом. Этот промпт отображается вместо обычного промпта, когда пользователь вводит неполный оператор (например, единственную левую круглую скобку или кавычку). Starship может настроить промпт на продолжение, используя опцию `continuation_prompt`. По умолчанию промпт `'[∙](bright-black) '`. Примечание: `continuation_prompt` должно быть изменено на строку без каких-либо переменных. Примечание: Дальнейшие подсказки доступны только в следующих оболочках: - `bash` - `zsh` - `PowerShell` ### Пример ```toml # ~/.config/starship.toml # Запрос на продолжение, в котором отображаются две заполненные стрелки continuation_prompt = '▶️▶️ ' ``` ## Строки стиля Строки стиля - это список слов, разделенных пробелами. Слова не чувствительны к регистру (то есть `bold` и `BoLd` считаются одной строкой). Каждое слово может быть одним из следующих: - `bold` - `italic` - `underline` - `dimmed` - `инвертировано` - `мерцать` - `скрытый` - `зачеркнуто` - `bg:` - `fg:` - `` - `none` где `` является цветовым спецификатором (обсуждается ниже). `fg:` и `` в настоящее время выполняет то же самое, хотя в будущем это может измениться. `` также может быть установлено значение `prev_fg` или `prev_bg`, которое соответствует цвету переднего плана или фона предыдущего элемента соответственно, если доступно, или `нет` в противном случае. `инвертировано` меняет местами цвета фона и переднего плана. Порядок слов в строке не имеет значения. Токен `none` переопределяет все остальные токены в строке, если он не является частью спецификатора `bg:` так, например, `fg:red none fg:blue` все равно создаст строку без стиля. `bg:none` устанавливает цвет по умолчанию на цвет `fg:red bg:none` эквивалентно `red` или `fg:red` и `bg:green fg:red bg:none` также эквивалентно `fg:red` или `red`. Использование `none` в сочетании с другими токенами может стать ошибкой в будущем. Цветовой спецификатор может быть одним из следующих: - Один из стандартных цветов терминалов: `black`, `red`, `green`, `blue`, `gellow`, `purple`, `cyan`, `white`. При желании вы можете добавить к ним префикс `bright-`, чтобы получить версию bright (например, `bright-white`). - `#`, за которой следует шестизначное шестнадцатеричное число. Это определяет [шестнадцатеричный код цвета RGB](https://www.w3schools.com/colors/colors_hexadecimal.asp). - Число от 0 до 255. Это определяет [8-битный код цвета ANSI](https://i.stack.imgur.com/KTSQa.png). Если для переднего плана/фона задано несколько цветов, то последняя из строк будет иметь приоритет. Не все строки стиля будут корректно отображаться в терминале. В частности, существуют следующие известные ошибки: - Во многих терминалах по умолчанию отключена поддержка `blink`. - `hidden` [не поддерживается в iTerm](https://gitlab.com/gnachman/iterm2/-/issues/4564). - `strikethrough` по умолчанию не поддерживается в macOS Terminal.app.