Fishの基礎 - 補完 - 版の履歴

Wiki: /* 組み込み関数 */

2024-10-10T21:03:26Z

組み込み関数

← 古い版		2024年10月11日 (金) 06:03時点における版
202行目:		202行目:
	== 組み込み関数 ==		== 組み込み関数 ==
	Fishには補完を支援するための多くの組み込み関数がある。<br>		Fishには補完を支援するための多くの組み込み関数がある。<br>
			<br>
			組み込み関数を組み合わせてカスタム関数内で使用することにより、より複雑な補完ロジックを実現することができる。<br>
	<br>		<br>
	* <code>__fish_complete_directories</code>		* <code>__fish_complete_directories</code>
294行目:		296行目:
	*: <br>		*: <br>
	* <code>__fish_complete_man</code>		* <code>__fish_complete_man</code>
	*: ~~manページの名前を補完する。~~		*: システムで利用可能なmanページの名前を補完する。
			*: <br>
			*: 以下の例では、mymanviewerというカスタムコマンドに対して、全ての利用可能なmanページのタイトルを補完候補として提供している。
			*: これにより、ユーザは素早くに特定のmanページを選択することができる。
			*: <syntaxhighlight lang="fish">complete -c mymanviewer -f -a "(__fish_complete_man)"</syntaxhighlight>
			*: <br>
	* <code>__fish_complete_time</code>		* <code>__fish_complete_time</code>
	*: 時間関連の補完を提供する。		*: 時間関連の補完を提供する。
			*: <br>
			*: 以下の例では、mytimeというカスタムコマンドに対して、時間関連の補完 (例: 今日の日付、現在の時刻等) を提供している。
			*: 具体的な補完内容はシステムの設定や現在の時刻に依存することに注意する。
			*: <syntaxhighlight lang="fish">complete -c mytime -f -a "(__fish_complete_time)"</syntaxhighlight>
			*: <br>
	* <code>__fish_apropos</code>		* <code>__fish_apropos</code>
	*: aproposコマンドの結果を基に補完候補を生成する。		*: aproposコマンドの結果を基に補完候補を生成する。
	<br>		*: ユーザが指定したキーワードに関連するコマンドやドキュメントを素早く見つけることができる。
	~~また、組み込み関数を組み合わせてカスタム関数内で使用することにより、より複雑な補完ロジックを実現することができる。~~<br>		*: <br>
			*: 以下の例では、search-commandsというカスタムコマンドに対して、現在のコマンドライン入力 (例: commandline -ctで取得) に基づいて、関連するコマンドやmanページを補完候補として提供している。
			*: <syntaxhighlight lang="fish">complete -c search-commands -f -a "(__fish_apropos (commandline -ct))"</syntaxhighlight>
	<br><br>		<br><br>

Wiki: /* 組み込み関数 */

2024-10-10T20:53:38Z

組み込み関数

← 古い版		2024年10月11日 (金) 05:53時点における版
257行目:		257行目:
	*: <syntaxhighlight lang="fish">complete -c openfile -f -a "(__fish_complete_suffix .txt)"</syntaxhighlight>		*: <syntaxhighlight lang="fish">complete -c openfile -f -a "(__fish_complete_suffix .txt)"</syntaxhighlight>
	*: <br>		*: <br>
	* <code>__fish_complete_history</code>
	*: コマンド履歴から項目を補完する。
	* <code>__fish_print_hostnames</code>		* <code>__fish_print_hostnames</code>
	*: <u>/etc/hosts</u>ファイルとmDNSから取得したホスト名を補完する。		*: <u>/etc/hosts</u>ファイルとmDNSから取得したホスト名を補完する。
264行目:		262行目:
	*: 以下の例では、some_commandコマンドに対して、システムが知りうるホスト名を補完候補として提供している。		*: 以下の例では、some_commandコマンドに対して、システムが知りうるホスト名を補完候補として提供している。
	*: <syntaxhighlight lang="fish">complete -c some_command -f -a "(__fish_print_hostnames)"</syntaxhighlight>		*: <syntaxhighlight lang="fish">complete -c some_command -f -a "(__fish_print_hostnames)"</syntaxhighlight>
			*: <br>
			* <code>__fish_complete_history</code>
			*: コマンド履歴から項目を補完する。
			*: <br>
			*: 以下の例では、rerunコマンドに対して、過去に実行したコマンドを補完候補として提供している。
			*: <syntaxhighlight lang="fish">complete -c rerun -f -a "(__fish_complete_history)"</syntaxhighlight>
	*: <br>		*: <br>
	* <code>__fish_print_interfaces</code>		* <code>__fish_print_interfaces</code>
	*: システムのネットワークインターフェースを補完する。		*: システムのネットワークインターフェースを補完する。
			*: <br>
			*: 以下の例では、ifconfigコマンドに対して、利用可能なネットワークインターフェース (例: eth0, wlan0等) を補完候補として提供している。
			*: <syntaxhighlight lang="fish">complete -c ifconfig -f -a "(__fish_print_interfaces)"</syntaxhighlight>
			*: <br>
	* <code>__fish_print_filesystems</code>		* <code>__fish_print_filesystems</code>
	*: ~~利用可能なファイルシステムタイプを補完する。~~		*: システムでサポートされているファイルシステムの一覧を補完する。
			*: <br>
			*: 以下の例では、mountコマンドに対して、利用可能なファイルシステムタイプ (例: ext4, ntfs, vfat等) を補完候補として提供している。
			*: <syntaxhighlight lang="fish">complete -c mount -f -a "(__fish_print_filesystems)"</syntaxhighlight>
			*: <br>
	* <code>__fish_print_packages</code>		* <code>__fish_print_packages</code>
	*: ~~システムのパッケージマネージャーからパッケージ名を補完する。~~		*: パッケージ管理システムからインストールされたパッケージの一覧を補完する。
			*: <br>
			*: 以下の例では、zepper removeコマンドに対して、インストール済みのパッケージ名を補完候補として提供している。
			*: <syntaxhighlight lang="fish">complete -c apt-get -f -n "__fish_seen_subcommand_from remove" -a "(__fish_print_packages)"</syntaxhighlight>
			*: <br>
			* <code>__fish_complete_uninstalled_packages</code>
			*: システムにインストールされていないが利用可能なパッケージの一覧を補完する。
			*: <br>
			*: 以下の例では、zypper installコマンドに対して、インストールされていない利用可能なパッケージ名を補完候補として提供している。
			*: <syntaxhighlight lang="fish">complete -c apt-get -f -n "__fish_seen_subcommand_from install" -a "(__fish_complete_uninstalled_packages)"</syntaxhighlight>
			*: <br>
	* <code>__fish_complete_man</code>		* <code>__fish_complete_man</code>
	*: manページの名前を補完する。		*: manページの名前を補完する。
	* <code>__fish_complete_time</code>		* <code>__fish_complete_time</code>
	*: 時間関連の補完を提供する。		*: 時間関連の補完を提供する。
	* <code>__fish_complete_uninstalled_packages</code>
	*: インストールされていないパッケージを補完する。
	* <code>__fish_apropos</code>		* <code>__fish_apropos</code>
	*: aproposコマンドの結果を基に補完候補を生成する。		*: aproposコマンドの結果を基に補完候補を生成する。

Wiki: /* 組み込み関数 */

2024-10-10T20:41:27Z

組み込み関数

← 古い版		2024年10月11日 (金) 05:41時点における版
205行目:		205行目:
	* <code>__fish_complete_directories</code>		* <code>__fish_complete_directories</code>
	*: ディレクトリの補完		*: ディレクトリの補完
			*: <br>
			*: 以下の例では、mycommandコマンドに対して、現在のディレクトリ内の全てのサブディレクトリを補完候補として提供している。
			*: <syntaxhighlight lang="fish">complete -c mycommand -f -a "(__fish_complete_directories)"</syntaxhighlight>
			*: <br>
	* <code>__fish_complete_path</code>		* <code>__fish_complete_path</code>
	*: ファイルパスの補完		*: ファイルパスの補完
			*: <br>
			*: 以下の例では、myfileコマンドに対して、現在のディレクトリ内の全てのファイルとディレクトリを補完候補として提供している。
			*: <syntaxhighlight lang="fish">complete -c myfile -f -a "(__fish_complete_path)"</syntaxhighlight>
			*: <br>
	* <code>__fish_complete_users</code>		* <code>__fish_complete_users</code>
	*: システム上のユーザ名の補完		*: システム上のユーザ名の補完
			*: <br>
			*: 以下の例では、usercommandコマンドに対して、システム上の全てのユーザ名を補完候補として提供している。
			*: <syntaxhighlight lang="fish">complete -c usercommand -f -a "(__fish_complete_users)"</syntaxhighlight>
			*: <br>
	* <code>__fish_complete_groups</code>		* <code>__fish_complete_groups</code>
	*: グループ名の補完		*: グループ名の補完
			*: <br>
			*: 以下の例では、groupcommandコマンドに対して、システム上の全てのグループ名を補完候補として提供している。
			*: <syntaxhighlight lang="fish">complete -c groupcommand -f -a "(__fish_complete_groups)"</syntaxhighlight>
			*: <br>
	* <code>__fish_complete_pids</code>		* <code>__fish_complete_pids</code>
	*: 実行中のプロセスIDの補完		*: 実行中のプロセスIDの補完
			*: <br>
			*: 以下の例では、killprocessコマンドに対して、システム上の実行中のプロセスIDを補完候補として提供している。
			*: <syntaxhighlight lang="fish">complete -c killprocess -f -a "(__fish_complete_pids)"</syntaxhighlight>
			*: <br>
	* <code>__fish_complete_list</code>		* <code>__fish_complete_list</code>
	*: 指定されたリストから項目を補完する。		*: 指定されたリストから項目を補完する。
			*: <br>
			*: 以下の例では、mycommandコマンドに対して、option1、option2、option3を補完候補として提供している。
			*: <syntaxhighlight lang="fish">complete -c mycommand -f -a "(__fish_complete_list , 'option1' 'option2' 'option3')"</syntaxhighlight>
			*: <br>
			* <code>__fish_complete_command</code>
			*: 環境変数<code>PATH</code>に指定している実行可能ファイルを補完する。
			*: <br>
			*: 以下の例では、runコマンドに対して、システムにインストールされている全てのコマンドを補完候補として提供している。
			*: <syntaxhighlight lang="fish">complete -c run -f -a "(__fish_complete_command)"</syntaxhighlight>
			*: <br>
	* <code>__fish_complete_subcommand</code>		* <code>__fish_complete_subcommand</code>
	*: サブコマンドの補完を支援する。		*: サブコマンドの補完を支援する。
			*: <br>
			*: 以下の例では、gitコマンドに対して、add、commit、pushをサブコマンドとして補完候補に提供している。
			*: <syntaxhighlight lang="fish">complete -c git -f -n "__fish_use_subcommand" -a "(__fish_complete_subcommand -d 'Git command' -s add -s commit -s push)"</syntaxhighlight>
			*: <br>
	* <code>__fish_complete_suffix</code>		* <code>__fish_complete_suffix</code>
	*: 指定された接尾辞を持つファイルを補完する。		*: 指定された接尾辞を持つファイルを補完する。
	* <~~code~~>~~__fish_complete_command~~</~~code~~>		*: <br>
	*: ~~環境変数<code>PATH~~<~~/code~~>~~に指定している実行可能ファイルを補完する。~~		*: 以下の例では、openfileコマンドに対して、現在のディレクトリ内の.txt拡張子を持つファイルを補完候補として提供している。
			*: <syntaxhighlight lang="fish">complete -c openfile -f -a "(__fish_complete_suffix .txt)"</syntaxhighlight>
			*: <br>
	* <code>__fish_complete_history</code>		* <code>__fish_complete_history</code>
	*: コマンド履歴から項目を補完する。		*: コマンド履歴から項目を補完する。
	* <code>__fish_print_hostnames</code>		* <code>__fish_print_hostnames</code>
	*: <u>/etc/hosts</u>ファイルとmDNSから取得したホスト名を補完する。		*: <u>/etc/hosts</u>ファイルとmDNSから取得したホスト名を補完する。
			*: <br>
			*: 以下の例では、some_commandコマンドに対して、システムが知りうるホスト名を補完候補として提供している。
			*: <syntaxhighlight lang="fish">complete -c some_command -f -a "(__fish_print_hostnames)"</syntaxhighlight>
			*: <br>
	* <code>__fish_print_interfaces</code>		* <code>__fish_print_interfaces</code>
	*: システムのネットワークインターフェースを補完する。		*: システムのネットワークインターフェースを補完する。
239行目:		279行目:
	* <code>__fish_apropos</code>		* <code>__fish_apropos</code>
	*: aproposコマンドの結果を基に補完候補を生成する。		*: aproposコマンドの結果を基に補完候補を生成する。
	~~<br>~~
	~~以下の例では、some_commandコマンドに対して、システムが知りうるホスト名を補完候補として提供している。<br>~~
	~~<syntaxhighlight lang="fish">~~
	~~complete -c some_command -f -a "(__fish_print_hostnames)"~~
	~~</syntaxhighlight>~~
	<br>		<br>
	また、組み込み関数を組み合わせてカスタム関数内で使用することにより、より複雑な補完ロジックを実現することができる。<br>		また、組み込み関数を組み合わせてカスタム関数内で使用することにより、より複雑な補完ロジックを実現することができる。<br>

Wiki: /* 組み込み関数 */

2024-10-10T20:23:36Z

組み込み関数

@@ 207行目: / 207行目: @@
 * <code>__fish_complete_path</code>
 *: ファイルパスの補完
 * <code>__fish_complete_groups</code>
 *: グループ名の補完
 <br><br>

Wiki: /* 外部コマンドの使用 */

2024-10-10T20:06:06Z

外部コマンドの使用

← 古い版		2024年10月11日 (金) 05:06時点における版
257行目:		257行目:
	== 外部コマンドの使用 ==		== 外部コマンドの使用 ==
	<u>/<Fishのインストールディレクトリ>/share/fish/functions</u>ディレクトリに定義した関数を使用して、動的に補完候補を生成することができる。<br>		<u>/<Fishのインストールディレクトリ>/share/fish/functions</u>ディレクトリに定義した関数を使用して、動的に補完候補を生成することができる。<br>
			<br><br>

			== エスケープと文字列操作 ==
			Fishの文字列操作関数である<code>string replace</code>、<code>string match</code>等を使用して、補完候補を処理することができる。<br>
	<br><br>		<br><br>

Wiki: /* 補完の削除 */

2024-10-10T20:04:33Z

補完の削除

@@ 238行目: / 238行目: @@
   complete -c <コマンド> -e
   </syntaxhighlight>
 <br><br>

Wiki: /* 組み込み関数 */

2024-10-10T19:59:35Z

組み込み関数

@@ 209行目: / 209行目: @@
 * <code>__fish_complete_groups</code>
 *: グループ名の補完
 <br><br>

Wiki: /* 動的補完 */

2024-10-10T19:57:18Z

動的補完

← 古い版		2024年10月11日 (金) 04:57時点における版
52行目:		52行目:

	== 動的補完 ==		== 動的補完 ==
	~~補完候補を動的に生成する場合は、コマンド置換を使用する。~~<br>		補完候補を動的に生成する場合は、コマンド置換を使用して動的に補完候補を生成する。<br>
	<br>		<br>
	<syntaxhighlight lang="fish">		<syntaxhighlight lang="fish">
	complete -c ssh -a "(command cat ~/.ssh/config \| string match -r '^Host\s+(\S+)' \| string replace -r '^Host\s+' '')" -d "Known host"		complete -c ssh -a "(command cat ~/.ssh/config \| string match -r '^Host\s+(\S+)' \| string replace -r '^Host\s+' '')" -d "Known host"
			</syntaxhighlight>
			<br>
			以下の例では、systemctl --state=helpの出力を動的に処理して、補完候補を生成している。<br>
			<br>
			<syntaxhighlight lang="fish">
			complete -c systemctl -l state -d 'List of unit states' -xa '(systemctl --state=help --no-legend --no-pager \| string match -v "*:")'
	</syntaxhighlight>		</syntaxhighlight>
	<br><br>		<br><br>

Wiki: /* 組み込み関数 */

2024-10-10T19:55:14Z

組み込み関数

@@ 203行目: / 203行目: @@
 * <code>__fish_complete_groups</code>
 *: グループ名の補完
 <br><br>

Wiki: /* 条件付き補完 */

2024-10-10T19:53:10Z

条件付き補完

← 古い版		2024年10月11日 (金) 04:53時点における版
40行目:		40行目:
	complete -c gcc -s O -a "0 1 2 3" -d "Optimization level"		complete -c gcc -s O -a "0 1 2 3" -d "Optimization level"
	end		end
			</syntaxhighlight>
			<br>
			また、<code>-n "<条件>"</code>オプションを使用して、特定の条件下でのみ補完を行うことができる。<br>
			<br>
			以下の例では、変数$commandsに含まれるサブコマンドがまだ入力されていない場合にのみ、それらのサブコマンドを補完候補として提示する。<br>
			<br>
			<syntaxhighlight lang="fish">
			complete -c systemctl -n "not __fish_seen_subcommand_from $commands" -a "$commands"
	</syntaxhighlight>		</syntaxhighlight>
	<br><br>		<br><br>

Wiki: /* サブコマンドの補完 */

2024-10-10T14:15:55Z

サブコマンドの補完

@@ 79行目: / 79行目: @@
   </syntaxhighlight>
 <br><br>
 == 組み込み関数 ==

Wiki: ページの作成:「== 概要 == Fishシェルの補完システムは非常に強力で柔軟性がある。

Fishの補完システムを理解するには、これらの概念を理解して、実際に補完スクリプトを記述することが重要である。
また、既存の補完スクリプト (~/.config/fish/completionsディレクトリ) を参考にする。

補完システムの詳細を知りたい場合は、Fishの公式サイトにある[https…」

2024-10-10T13:55:16Z

ページの作成:「== 概要 == Fishシェルの補完システムは非常に強力で柔軟性がある。 Fishの補完システムを理解するには、これらの概念を理解して、実際に補完スクリプトを記述することが重要である。 また、既存の補完スクリプト (~/.config/fish/completionsディレクトリ) を参考にする。 補完システムの詳細を知りたい場合は、Fishの公式サイトにある[https…」

新規ページ

== 概要 ==
Fishシェルの補完システムは非常に強力で柔軟性がある。 
 
Fishの補完システムを理解するには、これらの概念を理解して、実際に補完スクリプトを記述することが重要である。 
また、既存の補完スクリプト (~/.config/fish/completionsディレクトリ) を参考にする。 
 
補完システムの詳細を知りたい場合は、Fishの公式サイトにある[https://fishshell.com/docs/current/completions.html# Writing your own completions]を参照すること。 
 

== 補完関数 ==
<code>complete</code>コマンドを使用して、補完関数を定義する。 
 
<syntaxhighlight lang="fish">
# 基本構文

complete -c <コマンド> <オプション> -a '<補完候補>' -d '<補完候補の説明>'
</syntaxhighlight>
 
* -c <コマンド>
*: 補完を定義するコマンドを指定する。
* -a '<補完候補>' または -a "<補完候補>"
*: 補完候補を指定する。
* -d '<補完候補の説明>' または -d "<補完候補の説明>"
*: 補完候補の説明を提供する。
 

== オプションの補完 ==
コマンドのオプションを補完する場合は、<code>-s</code> (短いオプション)、または、<code>-l</code> (長いオプション) を使用する。 
 
<syntaxhighlight lang="fish">
complete -c cat -s n -l number -d "Enumerate lines"
</syntaxhighlight>
 

== 条件付き補完 ==
Fishでは、条件に基づいて異なる補完を定義することができる。 
 
<syntaxhighlight lang="fish">
if command -q gcc
complete -c gcc -s O -a "0 1 2 3" -d "Optimization level"
end
</syntaxhighlight>
 

== 動的補完 ==
補完候補を動的に生成する場合は、コマンド置換を使用する。 
 
<syntaxhighlight lang="fish">
complete -c ssh -a "(command cat ~/.ssh/config | string match -r '^Host\s+(\S+)' | string replace -r '^Host\s+' '')" -d "Known host"
</syntaxhighlight>
 

== 補完スクリプト ==
複雑な補完ロジックは、別のファイルに記述して、<code>source</code>コマンドで読み込むことができる。 
 
<syntaxhighlight lang="fish">
source ~/.config/fish/completions/mycommand.fish
</syntaxhighlight>
 

== 補完の優先順位 ==
<code>-n</code>オプションを使用して、特定の状況下でのみ補完を適用できる。 
 
<syntaxhighlight lang="fish">
complete -c git -n "__fish_use_subcommand" -a clone -d "Clone a repository"
</syntaxhighlight>
 

== サブコマンドの補完 ==
多くのコマンドはサブコマンドを持つ。 
これらは、一般的に、<code>__fish_use_subcommand</code>関数を使用して処理する。 
 
<syntaxhighlight lang="fish">
complete -c git -f -n "__fish_use_subcommand" -a "clone" -d "Clone a repository"
</syntaxhighlight>
 
<syntaxhighlight lang="fish">
complete -c git -f -n "__fish_use_subcommand" -a "commit" -d "Record changes to the repository"
</syntaxhighlight>
 

== 組み込み関数 ==
Fishには補完を支援するための多くの組み込み関数がある。 
 
* <code>__fish_complete_directories</code>
*: ディレクトリの補完
* <code>__fish_complete_path</code>
*: ファイルパスの補完
* <code>__fish_complete_groups</code>
*: グループ名の補完
 

== 補完の削除 ==
特定のコマンドの全ての補完を削除することができる。 
<syntaxhighlight lang="fish">
complete -c <コマンド> -e
</syntaxhighlight>
 

== 補完のテスト ==
特定のコマンドの補完をテストできる。 
 
<syntaxhighlight lang="fish">
fish_complete_path <コマンド>
</syntaxhighlight>
 

__FORCETOC__
[[カテゴリ:シェルスクリプト]]