コマンドライン補完

問題を報告 ソースを表示

Bash と Zsh では、コマンドライン補完(タブ補完)を有効にできます。これにより、コマンド名、フラグ名とフラグ値、ターゲット名をタブで補完できます。

Bash

Bazel には Bash 完了スクリプトが付属しています。

Bazel をインストールした場合:

  • APT リポジトリから、これで完了です。Bash 完了スクリプトは、すでに /etc/bash_completion.d にインストールされています。

  • Homebird で作業は完了です。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 プラグインをインストールして有効にできます。それ以外の場合は、上記のいずれかの解決策を使用します。

  • Homebird で作業は完了です。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