jwodder-ps1 0.7.2

安装 & 设置

jwodder-ps1 需要 Python 3.9 或更高版本。您还需要一个 Bash 或 zsh shell 来设置程序，并且需要安装 git v1.7.10+ 来获取 Git 仓库的状态信息。

使用 pip 或类似工具安装 jwodder-ps1 命令，建议使用 pipx 安装来自 PyPI 的同名包。

如果您使用 Bash，请将其配置为使用 jwodder-ps1 作为提示符，在您的 ~/.bashrc 文件的末尾添加以下行

PROMPT_COMMAND="$PROMPT_COMMAND"'; PS1="$(jwodder-ps1 "${PS1_GIT:-}")"'

如果您使用 zsh，请在您的 ~/.zshrc 文件的末尾添加以下内容

precmd_jwodder_ps1() { PS1="$(jwodder-ps1 --zsh "${PS1_GIT:-}")" }
precmd_functions+=( precmd_jwodder_ps1 )

如果您只想使用脚本的 Git 状态部分并将其与您的提示符字符串结合，请将 PS1 赋值替换为您想要的提示符，在您想要 Git 状态字符串的地方插入 $(jwodder-ps1 --git-only "${PS1_GIT:-}")。

根据 jwodder-ps1 的安装方式和您的 PATH 值，您可能需要使用 jwodder-ps1 可执行文件的完整路径。

配置 jwodder-ps1 后，打开一个新的 shell 并享受它！

如果 Git 集成导致您遇到麻烦（无论是由于某些东西损坏还是因为它运行得太慢），可以通过在命令行上运行 PS1_GIT=off 来暂时禁用它。

用法

jwodder-ps1 [<options>] [<git flag>]

jwodder-ps1 命令输出一行包含当前目录的样式提示字符串。默认情况下，样式化格式适用于 Bash 的 PS1 变量，但可以使用 --ansi 和 --zsh 选项来更改格式。

jwodder-ps1 只接受一个可选参数。如果此参数为“off”，则禁用 Git 集成。如果为其他值或未指定，则启用 Git 集成。

Git 状态符号

当在 Git 仓库内时，在提示符的末尾添加了一些符号，以显示当前 HEAD 和其状态。除了 @ 分隔符和 HEAD 本身外，当不相关时，将省略单个符号。从左到右，符号依次为

• @ — 分隔符

• + (加粗浅黄色) — 表示存在已隐藏的更改

• HEAD 名称（浅绿色）：当前分支的名称（如果有），或当前签出的标签的名称（如果有），或当前提交哈希的短形式。当仓库处于分离的 HEAD 状态时，此名称为浅蓝色。

  如果字符串过长，则会被截断。

• +n（绿色）— HEAD 相对于上游领先多少个提交

• -n（红色）— HEAD 相对于上游落后多少个提交

• * — 表示工作树中是否有已暂存或未暂存的更改

  • 绿色：存在已暂存更改

  • 红色：存在未暂存更改

  • 加粗浅黄色：既存在已暂存又存在未暂存更改

• +（加粗红色）— 表示工作树中存在未跟踪文件

• [STATE]（洋红色）— 如果有任何活动，显示 Git 当前正在进行的活动

  • [BSECT] — 二分查找

  • [CHYPK] — cherry-pick

  • [MERGE] — 合并

  • [REBAS] — 变基

  • [REVRT] — 反转

• !（加粗红色）— 表示存在合并冲突的路径