命令行补全

报告问题 查看源代码 每夜 build · 7.4 .

您可以在 Bash 和 Zsh 中启用命令行补全功能(也称为“Tab 补全”)。这样,您就可以使用 Tab 键补全命令名称、标志名称、标志值以及目标名称。

Bash

Bazel 带有一个 Bash 完成脚本。

如果您已安装 Bazel:

  • 从 APT 仓库中安装,然后即可完成 - Bash 补全脚本已安装在 /etc/bash_completion.d 中。

  • 使用 Homebrew 即可完成 - Bash 补全脚本已安装在 $(brew --prefix)/etc/bash_completion.d 中。

  • 使用从 GitHub 下载的安装程序,然后执行以下操作:

    1. 找到完成文件的绝对路径。安装程序会将其复制到 bin 目录。

      示例:如果您使用 --user 运行了安装程序,则此值将为 $HOME/.bazel/bin。如果您以 root 身份运行安装程序,则此值将为 /usr/local/lib/bazel/bin

    2. 执行以下其中一项操作:

      • 将此文件复制到您的完成目录(如果有)。

        示例:在 Ubuntu 上,这是 /etc/bash_completion.d 目录。

      • 或者,从 Bash 的 RC 文件获取完成文件。

        使用完成文件的绝对路径,将类似于下面一行的代码添加到 ~/.bashrc(在 Ubuntu 上)或 ~/.bash_profile(在 macOS 上):

        source /path/to/bazel-complete.bash
        
  • 通过引导,然后:

    1. 构建完成脚本:

      bazel build //scripts:bazel-complete.bash
      
    2. 补全文件会在 bazel-bin/scripts/bazel-complete.bash 下构建。

      执行以下其中一项操作:

      • 将此文件复制到您的完成目录(如果有)。

        示例:在 Ubuntu 上,这是 /etc/bash_completion.d 目录

      • 将其复制到本地磁盘上的某个位置(例如复制到 $HOME),并从 Bash 的 RC 文件获取完成文件。

        使用完成文件的绝对路径,将类似于下面一行的代码添加到 ~/.bashrc(在 Ubuntu 上)或 ~/.bash_profile(在 macOS 上):

        source /path/to/bazel-complete.bash
        

Zsh

Bazel 附带 Zsh 补全脚本。

如果您安装了 Bazel:

  • 在 APT 代码库中,您即完成了 - Zsh 完成脚本已安装在 /usr/share/zsh/vendor-completions 中。

    如果您对 .zshrc 进行了大量自定义,并且自动补全功能无法正常运行,请尝试以下解决方案之一:

    将以下内容添加到 .zshrc 中:

        zstyle :compinstall filename '/home/tradical/.zshrc'
    
        autoload -Uz compinit
        compinit
    

    请按照此处的说明操作

    如果您使用的是 oh-my-zsh,则可能需要安装并启用 zsh-autocomplete 插件。如果您不想这样做,请使用上述解决方案之一。

  • 从 Homebrew,就大功告成了 - Zsh 补全脚本已安装在 $(brew --prefix)/share/zsh/site-functions 中。

  • 使用从 GitHub 下载的安装程序,然后执行以下操作:

    1. 找到完成文件的绝对路径。安装程序会将其复制到 bin 目录。

      示例:如果您使用 --user 运行了安装程序,则此值为 $HOME/.bazel/bin。如果您是以 root 身份运行安装程序,则路径为 /usr/local/lib/bazel/bin

    2. 将以下脚本添加到 $fpath 目录中:

      fpath[1,0]=~/.zsh/completion/
      mkdir -p ~/.zsh/completion/
      cp /path/from/above/step/_bazel ~/.zsh/completion
      

      您可能需要首次调用 rm -f ~/.zcompdump; compinit 才能使其正常运行。

    3. (可选)将以下内容添加到 .zshrc。

      # This way the completion script does not have to parse Bazel's options
      # repeatedly.  The directory in cache-path must be created manually.
      zstyle ':completion:*' use-cache on
      zstyle ':completion:*' cache-path ~/.zsh/cache