Zsh-Git-Prompt 项目启动与配置教程

1. 项目目录结构及介绍

Zsh-Git-Prompt 是一个用于 Zsh shell 的 Git 提示符项目，它可以在你的终端中提供丰富的 Git 信息。项目的目录结构如下：

• src/: 存放项目的主要脚本文件。
  • gitprompt.sh: 主脚本文件，包含 Git 提示符的核心功能。
  • gitprompt.bash: 用于 Bash shell 的脚本文件。
• themes/: 包含多种预设主题的目录。
• examples/: 包含示例配置文件的目录。
• tests/: 用于测试项目功能的目录。

2. 项目的启动文件介绍

项目的启动文件是 src/gitprompt.sh。这个文件是 Zsh-Git-Prompt 的主要脚本，它包含了定义和配置 Git 提示符所需的所有代码。在使用前，你需要在你的 Zsh 配置文件（通常是 .zshrc）中添加以下代码来引入该脚本：

source /path/to/zsh-git-prompt/src/gitprompt.sh

确保替换 /path/to/zsh-git-prompt 为实际的脚本路径。

3. 项目的配置文件介绍

Zsh-Git-Prompt 允许通过配置文件来自定义提示符的显示。配置文件通常放置在用户的家目录下，文件名为 .git-prompt.conf。以下是配置文件的一些基本选项：

• ZSH_THEME_GIT_PROMPT: 选择一个预定义的主题，例如 default、auto 或 powerlevel10k。
• ZSH_THEME_GIT_PROMPT_PREFIX: 定义 Git 提示符的前缀，默认为 git: 。
• ZSH_THEME_GIT_PROMPT_SUFFIX: 定义 Git 提示符的后缀，默认为 ) 。
• ZSH_THEME_GIT_PROMPT_DIRTY: 当你的 Git 仓库中有未提交的变更时，定义提示符的显示方式。
• ZSH_THEME_GIT_PROMPT_CLEAN: 当你的 Git 仓库是干净时，定义提示符的显示方式。

以下是一个示例配置文件的内容：

# .git-prompt.conf

# 选择一个主题
ZSH_THEME_GIT_PROMPT="default"

# 自定义前缀和后缀
ZSH_THEME_GIT_PROMPT_PREFIX="git:("
ZSH_THEME_GIT_PROMPT_SUFFIX=")"

# 自定义仓库状态提示
ZSH_THEME_GIT_PROMPT_DIRTY="*"
ZSH_THEME_GIT_PROMPT_CLEAN=" "

在修改配置文件后，记得重新加载你的 Zsh 配置文件（通常是执行 source ~/.zshrc 命令）来使更改生效。