starship/docs/zh-CN/advanced-config/README.md
2022-06-16 08:48:50 -04:00

7.9 KiB
Raw Blame History

高级配置

Starship 功能繁多,有时您必须在编辑 starship.toml 之外做更多工作才能实现某些效果。 此页面详细介绍了一些在 starship 中使用的高级配置技巧。

::: warning

本节所述的配置内容可能随 Starship 未来版本的更新而改变。

:::

在 Cmd 中自定义提示符显示前和执行前的命令

Clink 提供了很灵活的 API能在 Cmd shell 中运行预提示和执行前命令。 在 Starship 中使用这些 API 很容易。 对你的 starship.lua 按需做出如下修改:

  • 为了在提示符显示前运行一个自定义函数,你需要定义一个名为 starship_preprompt_user_func 的函数。 这个函数接受当前的提示符作为字符串参数,你可以在函数中使用它。 例如,如果想在提示符前绘制一个火箭,可以这样写:
function starship_preprompt_user_func(prompt)
  print("🚀")
end

load(io.popen('starship init cmd'):read("*a"))()
  • 为了在命令执行前运行一个自定义函数,你需要定义一个名为 starship_precmd_user_func 的函数。 这个函数接受当前的命令行内容作为字符串参数,同样,你可以在函数中使用它。 例如,要打印即将被执行的命令,可以这样写:
function starship_precmd_user_func(line)
  print("Executing: "..line)
end

load(io.popen('starship init cmd'):read("*a"))()

在 Bash 中自定义提示符显示前和执行前的命令

Bash 不像多数其他的 Shell 有成体系的预执行框架。 因此,很难在 bash 中提供完全可自定义的 hook 机制。 然而Starship 确实能使您有限地在提示符渲染过程中插入自己的函数执行:

  • 若要在提示符显示之前运行自定义函数,需要定义此函数,然后将函数名赋值给 starship_reserved_user_func。 例如,如果想在提示符前绘制一个火箭,可以这样写:
function blastoff(){
    echo "🚀"
}
starship_precmd_user_func="blastoff"
  • 要在一个命令运行前运行自定义函数,您可以使用 DEBUG trap 机制。 然而,您必须在捕捉 DEBUG 信号_之前_启动 Starship Starship 可以保留 DEBUG trap 的值,但如果该 trap 在 starship 启动后被覆盖,一些功能将会被破坏。
function blastoff(){
    echo "🚀"
}
trap blastoff DEBUG     # Trap DEBUG *before* running starship
set -o functrace
eval $(starship init bash)
set +o functrace

在 Powershell 中自定义提示符显示前和执行前的命令

Powershell 不像多数其他的 Shell 有成体系的预执行框架。 因此,很难在 Powershell 中提供完全可自定义的 hook 机制。 然而Starship 确实能使您有限地在提示符渲染过程中插入自己的函数执行:

创建一个名为 Invoke-Starship-PreCommand 的函数

function Invoke-Starship-PreCommand {
    $host.ui.Write("🚀")
}

更改窗口标题

一些 shell 会自动更改您的窗口标题(比如改成您的工作目录)。 Fish 甚至默认会执行此功能。 Starship 没有实现此功能,但将这个功能添加到 bashzshcmdpowershell 是相当简单的。

首先,定义窗口标题更改函数(在 bash 和 zsh 中相同):

function set_win_title(){
    echo -ne "\033]0; YOUR_WINDOW_TITLE_HERE \007"
}

您可以使用变量来定制标题(常用的有 $USER$HOSTNAME$PWD)。

bash 中,设置此函数为 starship 预执行函数:

starship_precmd_user_func="set_win_title"

zsh中,将此函数添加到 reservmd_functions 列表:

precmd_functions+=(set_win_title)

如果您对产生的效果感到满意,请将以上代码添加到您的 shell 配置文件(~/.bashrc~/zsrhc)中以使其永久化。

例如,如果您想要在终端标签标题中显示当前目录, 将以下代码添加到您的 ~/.ashrc~/.zshrc:

function set_win_title(){
    echo -ne "\033]0; $(basename "$PWD") \007"
}
starship_precmd_user_func="set_win_title"

对于 Cmd您可以使用 starship_preprompt_user_func 函数修改窗口标题。

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,来设置类似的输出。

# edit $PROFILE
function Invoke-Starship-PreCommand {
  $host.ui.Write("`e]0; PS> $env:USERNAME@$env:COMPUTERNAME`: $pwd `a")
}

Invoke-Expression (&starship init powershell)

启用右侧提示

一些 Shell 支持右侧提示, 它与输入区渲染在同一行。 Starship 可以设置右侧提示的内容,使用 right_format 选项。 Any module that can be used in format is also supported in right_format. The $all variable will only contain modules not explicitly used in either format or right_format.

Note: The right prompt is a single line following the input location. To right align modules above the input line in a multi-line prompt, see the fill module.

right_format is currently supported for the following shells: elvish, fish, zsh, xonsh, cmd.

示例

# ~/.config/starship.toml

# A minimal left prompt
format = """$character"""

# move the rest of the prompt to the right
right_format = """$all"""

Produces a prompt like the following:

▶                                   starship on  rprompt [!] is 📦 v0.57.0 via 🦀 v1.54.0 took 17s

Continuation Prompt

Some shells support a continuation prompt along with the normal prompt. This prompt is rendered instead of the normal prompt when the user has entered an incomplete statement (such as a single left parenthesis or quote).

Starship can set the continuation prompt using the continuation_prompt option. The default prompt is "[∙](bright-black) ".

Note: continuation_prompt should be set to a literal string without any variables.

Note: Continuation prompts are only available in the following shells:

  • bash
  • zsh
  • PowerShell

示例

# ~/.config/starship.toml

# A continuation prompt that displays two filled in arrows
continuation_prompt = "▶▶"

样式设定

样式字符串是用空格分隔的单词列表。 其中单词不是大小写敏感的(例如 boldBoLd 被视为同一字符串)。 每个单词可以是以下之一:

  • bold
  • italic
  • underline
  • dimmed
  • inverted
  • bg:<color>
  • fg:<color>
  • <color>
  • none

<color> 是颜色说明符(下面解释)。 fg:<color> and <color> currently do the same thing, though this may change in the future. inverted swaps the background and foreground colors. 字符串中的单词顺序不影响显示结果。

The none token overrides all other tokens in a string if it is not part of a bg: specifier, so that e.g. fg:red none fg:blue will still create a string with no styling. bg:none sets the background to the default color so fg:red bg:none is equivalent to red or fg:red and bg:green fg:red bg:none is also equivalent to fg:red or red. 未来可能会将 none 与其它标识符一起使用视为一种错误。

颜色说明符可以是以下内容之一:

  • One of the standard terminal colors: black, red, green, blue, yellow, purple, cyan, white. You can optionally prefix these with bright- to get the bright version (e.g. bright-white).
  • 一个 # 后跟一个六位十六进制数。 这将指定一个 十六进制 RGB 颜色代码
  • 0-255 之间的数字。 这将指定一个 8 位 ANSI 颜色码

如果为文本/背景指定了多个颜色,字符串中最后指定的颜色将具有最高优先级。