次の方法で共有

about_ANSI_Terminals

  • [アーティクル]

簡単な説明

PowerShell で ANSI エスケープ シーケンスで使用できるサポートについて説明します。

長い説明

PowerShell には、PowerShell をホストしているターミナル アプリケーションでの出力のレンダリングを制御するための ANSI エスケープ シーケンスの使用をサポートする多くの機能があります。

PowerShell 7.2 では、ANSI で装飾されたテキストの出力をサポートするために、 $PSStylePowerShell エンジンに新しい自動変数 、、 の変更が追加されました。

ANSI ターミナルのサポート

ANSI 機能は、xterm ベースのターミナルと互換性を持つように設計されています。 詳細については、Wikipedia の xterm を参照してください。

Windows 10以降では、Windows コンソール ホストは xterm 互換です。 Windows ターミナル アプリケーションも xterm 互換です。

macOS では、既定のターミナル アプリケーションは xterm 互換です。

Linux の場合、各ディストリビューションには異なるターミナル アプリケーションが付属しています。 適切なターミナル アプリケーションを見つけるには、ディストリビューションのドキュメントを参照してください。

$PSStyle

変数には、次のプロパティがあります。

  • リセット - すべての装飾をオフにします
  • 点滅 - 点滅 をオンにします
  • BlinkOff - 点滅 をオフにします
  • 太字 - 太字 をオンにします
  • BoldOff - 太字をオフにします
  • [非表示] - [非表示] をオンにします
  • HiddenOff - 非表示をオフにします
  • 反転 - 反転をオンにします
  • ReverseOff - 反転をオフにします
  • 斜体 - 斜体をオンにします
  • ItalicOff - 斜体をオフにします
  • 下線 - 下線をオンにします
  • UnderlineOff - 下線をオフにします
  • 取り消し線 - 取り消し線をオンにします
  • StrikethroughOff - 取り消し線をオフにします
  • OutputRendering - 出力レンダリングを使用するタイミングを制御する
  • 書式設定 - 出力ストリームの既定の書式設定を制御する入れ子になったオブジェクト
  • Progress - 進行状況 バーのレンダリングを制御する入れ子になったオブジェクト
  • FileInfo - FileInfo オブジェクトの色分けを制御する入れ子になったオブジェクト。
  • フォアグラウンド - 前景の色分けを制御する入れ子になったオブジェクト
  • 背景 - 背景 の色分けを制御する入れ子になったオブジェクト

基本メンバーは、名前にマップされた ANSI エスケープ シーケンスの文字列を返します。 値は、カスタマイズできるように設定できます。 たとえば、太字を下線付きに変更できます。 プロパティ名を使用すると、タブ補完を使用して装飾文字列を簡単に作成できます。

"$($PSStyle.Background.BrightCyan)Power$($PSStyle.Underline)$($PSStyle.Bold)Shell$($PSStyle.Reset)"

次のメンバーは、ANSI 書式を使用する方法とタイミングを制御します。

  • $PSStyle.OutputRendering は、値を System.Management.Automation.OutputRendering 持つ列挙型です。

    • ANSI: ANSI エスケープ シーケンスは常にそのまま渡されます。

      重要

      出力をダウンストリームで実行することを意図したファイルまたはパイプラインにリダイレクトする場合は、 ANSI モードを使用する必要があります。 これにより、出力が変更されないようにします。 他のモードを使用すると、ANSI エスケープ シーケンスを削除することで出力が変更され、実行動作が変更される可能性があります。

    • PlainText: ANSI エスケープ シーケンスは常に削除され、プレーン テキストのみになります。

    • Host :これが既定の動作です。 ANSI エスケープ シーケンスは、リダイレクトまたはパイプ出力から削除されます。 詳細については、「 出力のリダイレクト」を参照してください。

  • $PSStyle.Backgroundメンバーと $PSStyle.Foreground メンバーは、16 個の標準コンソール カラーの ANSI エスケープ シーケンスを含む文字列です。

    • Black
    • BrightBlack
    • White
    • BrightWhite
    • Red
    • BrightRed
    • Magenta
    • BrightMagenta
    • Blue
    • BrightBlue
    • Cyan
    • BrightCyan
    • Green
    • BrightGreen
    • Yellow
    • BrightYellow

    値は設定可能であり、任意の数の ANSI エスケープ シーケンスを含めることができます。 24 ビット色を指定するメソッドもあります FromRgb() 。 メソッドを呼び出すには FromRgb() 、2 つの方法があります。

    string FromRgb(byte red, byte green, byte blue)
string FromRgb(int rgb)

    次のいずれかの例では、背景色を 24 ビットの色 Beigeに設定します。

    $PSStyle.Background.FromRgb(245, 245, 220)
$PSStyle.Background.FromRgb(0xf5f5dc)

  • $PSStyle.Formatting は、デバッグ、エラー、詳細、警告メッセージ、およびリストヘッダーとテーブル ヘッダーの既定の書式設定を制御する入れ子になったオブジェクトです。 太字や下線などの属性を制御することもできます。 これは、 $Host.PrivateData レンダリングの書式設定の色を管理する方法として置き換えられます。 $Host.PrivateData は下位互換性のために存在し続けますが、 に $PSStyle.Formatting接続されていません。 $PSStyle.Formatting には、次のメンバーがあります。

    • FormatAccent - リスト アイテムの書式設定
    • TableHeader - テーブル ヘッダーの書式設定
    • ErrorAccent - エラー メタデータの書式設定
    • エラー - エラー メッセージの書式設定
    • 警告 - 警告 メッセージの書式設定
    • 詳細 - 詳細 メッセージの書式設定
    • デバッグ - デバッグ メッセージの書式設定

  • $PSStyle.Progress では、進行状況ビュー バーのレンダリングを制御できます。

    • スタイル - レンダリング スタイルを設定する ANSI 文字列。
    • MaxWidth - ビューの最大幅を設定します。 既定値は 120 です。 最小値は 18 です。
    • ビュー - 値 MinimalClassicと を含む列挙型。 Classic は変更なしの既存の表示です。 Minimal は単一行の最小表示です。 Minimal が既定値です。
    • UseOSCIndicator - 既定値は です $false。 OSC インジケーターをサポートする端末の場合は、 を に $true 設定します。

    注意

    ホストで仮想ターミナルがサポートされていない場合、$PSStyle.Progress.View は自動的に Classic に設定されます。

    次の例では、レンダリング スタイルを最小限の進行状況バーに設定します。

    $PSStyle.Progress.View = 'Minimal'

  • $PSStyle.FileInfo は、 FileInfo オブジェクトの色分けを制御する入れ子になったオブジェクトです。

    • ディレクトリ - ディレクトリ の色を指定する組み込みメンバー
    • シンボリック リンク - シンボリック リンクの色を指定する組み込みメンバー
    • 実行可能ファイル - 実行可能ファイル の色を指定する組み込みメンバー。
    • Extension - このメンバーを使用して、さまざまなファイル拡張子の色を定義します。 Extension メンバーには、アーカイブと PowerShell ファイルの拡張機能があらかじめ含まれています。

ANSI 出力を生成するコマンドレット

  • markdown コマンドレット - Show-Markdown コマンドレットは、マークダウン テキストを含むファイルの内容を表示します。 出力は、さまざまなスタイルを表すために ANSI シーケンスを使用してレンダリングされます。 スタイルの定義は、Get-MarkdownOption コマンドレットと Set-MarkdownOption コマンドレットを使用して管理できます。
  • PSReadLine コマンドレット - PSReadLine モジュールは ANSI シーケンスを使用して、コマンド ラインで PowerShell 構文要素を色分けします。 色は 、Get-PSReadLineOption と Set-PSReadLineOption を使用して管理できます。
  • Get-Error - Get-Error コマンドレットは、読みやすくするために書式設定された Error オブジェクトの詳細ビューを返します。
  • Select-String - PowerShell 7.0 以降では、 Select-String は ANSI シーケンスを使用して出力内の一致パターンを強調表示します。
  • Write-Progress - ANSI 出力は、前述のように を使用して $PSStyle.Progress管理されます。 詳細については、「Write-Progress」を参照してください。

モードでの出力の Host リダイレクト

既定では、 $PSStyle.OutputRendering は Host に設定 されています。 ANSI エスケープ シーケンスは、リダイレクトまたはパイプ出力から削除されます。

OutputRendering は、ホスト、、 Out-Fileおよび Out-Stringでのレンダリングにのみ適用されます。 ネイティブ実行可能ファイルからの出力は影響を受けません。

PowerShell 7.2.6 では、 および Out-String のOut-File動作が次のシナリオで変更されました。

  • 入力オブジェクトが純粋な文字列の場合、 OutputRendering 設定に関係なく、これらのコマンドレットは文字列を変更しません。
  • 入力オブジェクトに書式設定ビューを適用する必要がある場合、これらのコマンドレットは OutputRendering 設定に基づいて書式設定出力文字列のエスケープ シーケンスを保持または削除します。

これは、PowerShell 7.2 と比較して、これらのコマンドレットの破壊的変更です。

OutputRendering は、コマンド ラインから実行 pwsh して出力をリダイレクトする場合など、PowerShell ホスト プロセスからの出力には適用されません。

次の例では、PowerShell は から bashLinux 上で実行されます。 このコマンドレットは Get-ChildItem 、ANSI 装飾テキストを生成します。 リダイレクトは、PowerShell ホストの外部のプロセスで bash 発生するため、 出力は OutputRendering の影響を受けません。

pwsh -noprofile -command 'Get-Childitem' > out.txt

の out.txt 内容を検査すると、ANSI エスケープ シーケンスが表示されます。

これに対し、PowerShell セッション内でリダイレクトが行われると、 OutputRendering はリダイレクトされた出力に影響します。

pwsh -noprofile -command 'Get-Childitem > out.txt'

の内容 out.txt を検査する場合、ANSI エスケープ シーケンスはありません。

ANSI 出力の無効化

ANSI エスケープ シーケンスのサポートは、TERM または NO_COLOR 環境変数を使用して無効にすることができます。

$env:TERM の次の値は、動作を次のように変更します。

  • dumb -設定 $Host.UI.SupportsVirtualTerminal = $false
  • xterm-mono -設定 $PSStyle.OutputRendering = PlainText
  • xtermm -設定 $PSStyle.OutputRendering = PlainText

が存在する場合$env:NO_COLORは、$PSStyle.OutputRenderingPlainText に設定されます。 NO_COLOR環境変数の詳細については、「」を参照してくださいhttps://no-color.org/。

C からを使用する $PSStyle #

次の例に示すように、C# 開発者はシングルトンとしてアクセス PSStyle できます。

string output = $"{PSStyle.Instance.Foreground.Red}{PSStyle.Instance.Bold}Hello{PSStyle.Instance.Reset}";

PSStyle は、System.Management.Automation 名前空間に存在します。

PowerShell エンジンには、次の変更が含まれています。

  • PowerShell の書式設定システムが、$PSStyle.OutputRendering を考慮するように更新されます。
  • StringDecorated ANSI エスケープされた文字列を処理するために、 型が追加されます。
  • string IsDecorated文字列にまたはC1 CSI文字シーケンスが含まれているESC場合に true を返すブール値プロパティが追加されました。
  • 文字列の プロパティは Length 、ANSI エスケープ シーケンスのないテキストの長さを返します。
  • メソッドは StringDecorated Substring(int contentLength) 、ANSI エスケープ シーケンスの一部ではないコンテンツ長までのインデックス 0 から始まる部分文字列を返します。 これは、テーブルの書式設定が文字列を切り捨て、印刷可能な文字領域を占有しない ANSI エスケープ シーケンスを保持するために必要です。
  • メソッドは string ToString() 同じままで、文字列のプレーンテキスト バージョンを返します。
  • パラメーターが true の場合、メソッドは string ToString(bool Ansi) 生の ANSI 埋め込み文字列を Ansi 返 します。 それ以外の場合は、ANSI エスケープ シーケンスが削除されたプレーンテキスト バージョンが返されます。
  • メソッドは FormatHyperlink(string text, uri link) 、ハイパーリンクを装飾するために使用される ANSI エスケープ シーケンスを含む文字列を返します。 Windows ターミナルなどの一部のターミナル ホストは、このマークアップをサポートしていて、これにより、レンダリングされたテキストがターミナルでクリック可能になります。

こちらもご覧ください