.NET CLI のタブ補完を有効にする方法

この記事の対象: ✔️ .NET Core 2.1 SDK 以降のバージョン

この記事では、PowerShell、Bash、zsh、fish、nushell の 5 つのシェルのタブ補完を構成する方法について説明します。 その他のシェルについては、タブ補完を構成する方法に関するドキュメントを参照してください。

セットアップが完了すると、シェルに dotnet コマンドを入力し、Tab キーを押すと、.NET CLI の タブ 補完がトリガーされます。 現在のコマンド ラインが dotnet complete コマンドに送信され、結果がシェルによって処理されます。 タブ補完を有効にせずに結果をテストするには、 dotnet complete コマンドに直接何かを送信します。 例えば次が挙げられます。

> dotnet complete "dotnet a"
add
clean
--diagnostics
migrate
pack

そのコマンドが機能しない場合は、.NET Core 2.0 SDK 以降がインストールされていることを確認してください。 インストールされているが、そのコマンドがまだ機能しない場合は、 dotnet コマンドが .NET Core 2.0 SDK 以降のバージョンに解決されていることを確認してください。 dotnet --version コマンドを使用して、現在のパスの解決先となっている dotnet のバージョンを確認します。 詳細については、「 使用する .NET バージョンの選択」を参照してください。

例示

タブ補完の例を次に示します。

インプット	変換後	なぜなら
dotnet a⇥	dotnet add	add は最初のサブコマンド (アルファベット順) です。
dotnet add p⇥	dotnet add --help	タブ補完は部分文字列と一致し、 --help は最初にアルファベット順に表示されます。
dotnet add p⇥⇥	dotnet add package	Tab キーをもう一度押すと、次の候補が表示されます。
dotnet package add Microsoft⇥	dotnet package add Microsoft.ApplicationInsights.Web	結果はアルファベット順に返されます。
dotnet reference remove ⇥	dotnet reference remove ..\..\src\OmniSharp.DotNet\OmniSharp.DotNet.csproj	タブ補完がプロジェクト ファイルに対応しているため。

PowerShell

.NET CLI の PowerShell にタブ補完を追加するには、変数 $PROFILEに格納されているプロファイルを作成または編集します。 詳細については、プロファイルの作成方法とプロファイルと実行ポリシーのトピックを参照してください。

プロファイルに次のコードを追加します。

# PowerShell parameter completion shim for the dotnet CLI
Register-ArgumentCompleter -Native -CommandName dotnet -ScriptBlock {
    param($wordToComplete, $commandAst, $cursorPosition)
        dotnet complete --position $cursorPosition "$commandAst" | ForEach-Object {
            [System.Management.Automation.CompletionResult]::new($_, $_, 'ParameterValue', $_)
        }
}

Bash

.NET CLI の bash シェルにタブ補完を追加するには、 .bashrc ファイルに次のコードを追加します。

# bash parameter completion for the dotnet CLI

function _dotnet_bash_complete()
{
  local cur="${COMP_WORDS[COMP_CWORD]}" IFS=$'\n' # On Windows you may need to use use IFS=$'\r\n'
  local candidates

  read -d '' -ra candidates < <(dotnet complete --position "${COMP_POINT}" "${COMP_LINE}" 2>/dev/null)

  read -d '' -ra COMPREPLY < <(compgen -W "${candidates[*]:-}" -- "$cur")
}

complete -f -F _dotnet_bash_complete dotnet

zsh

.NET CLI の zsh シェルにタブ補完を追加するには、 .zshrc ファイルに次のコードを追加します。

# zsh parameter completion for the dotnet CLI

_dotnet_zsh_complete()
{
  local completions=("$(dotnet complete "$words")")

  # If the completion list is empty, just continue with filename selection
  if [ -z "$completions" ]
  then
    _arguments '*::arguments: _normal'
    return
  fi

  # This is not a variable assignment, don't remove spaces!
  _values = "${(ps:\n:)completions}"
}

compdef _dotnet_zsh_complete dotnet

魚

.NET CLI の フィッシュ シェルにタブ補完を追加するには、 config.fish ファイルに次のコードを追加します。

complete -f -c dotnet -a "(dotnet complete (commandline -cp))"

nushell

.NET CLI 用 の nushell にタブ補完を追加するには、 config.nu ファイルの先頭に次のコードを追加します。

let external_completer = { |spans|
    {
        dotnet: { ||
            dotnet complete (
                $spans | skip 1 | str join " "
            ) | lines
        }
    } | get $spans.0 | each { || do $in }
}

次に、 config レコードで、 completions セクションを見つけて、前に定義した external_completer を externalに追加します。

let-env config = {
    # your options here
    completions: {
        # your options here
        external: {
            # your options here
            completer: $external_completer # add it here
        }
    }
}