vscode-quick-highlight-extension
English / 日本語
目次:
概要
選択したテキストをハイライト表示します。
ハイライトは明示的に消すまでハイライトされ続けます。一時的に注意しておきたいワードをハイライトしておくのに便利な機能拡張です。
SublimeText 用プラグイン HighlightWords のような機能を目標として開発されました。
使い方
ショートカットの設定
ショートカットキーを設定して使う事を想定した機能拡張です。まずはショートカットの設定を行って下さい。
- 「Preferences」>「Keyboard Shortcuts」( Win:
ctrl+k,ctrl+s/ mac:cmd+k,cmd+s)を開く - 次のコマンド ID またはコマンド名でコマンドを検索します
tettekete.toggle-highlight-wordまたはQuickHighlight: Toggle highlight
- キーバインドを設定する
ハイライトする・ハイライトを解除する
エディタ上でテキストを選択し、以下のいずれかの方法でハイライト、またはハイライトの解除が出来ます。
- 設定したショートカットキーを入力する
- コマンドパレットから
QuickHighlight: Toggle highlightを実行する - コンテキストメニューを開き
Quick Highlight>Toggle highlightを選ぶ
ハイライトの解除については後述する Quick Highlight パネルからも実施出来ます。
全てのハイライトを削除する
以下のいずれかの方法で全てのハイライトを解除できます。
- ハイライトされたテキスト上でコンテキストメニューを開き
Remove all highlightを選ぶ - コマンドパレットから
QuickHighlight: Remove all highlightを実行する - 後述する
Quick Highlightパネルから削除を行う
ハイライトワードを巡回する
ハイライトワード内にカーソルを移動するか、ハイライトワードを選択した状態で以下のいずれかの方法でハイライトを巡回できます。
- コマンドパレットから
QuickHighlight: Go to next highlightまたはQuickHighlight: Go to previous highlightを選ぶ - コンテキストメニューを開き、
Quick HighlightサブメニューからGo to next highlightまたはGo to previous highlightを選ぶ
他、後述する Quick Highlight パネルから対象ワードをクリックする（Go to next highlight）したり、同コンテキストメニューから巡回用のコマンドを選ぶことでも巡回できます。
Quick Highlight パネル
VSCode 下部パネルをの Quick Highlight タブではハイライトワードの管理が可能です。
- ハイライトの削除
- 対象テキストをロールオーバーしたときに現れる右端の × ボタンをクリックする
- 対象テキスト行で右クリックし、コンテキストメニューから
Remove highlightを実行する
- 全てのハイライトを削除する
- ルートノードをロールオーバーしたときに現れる右端のゴミ箱アイコンをクックする
- ハイライトの巡回
- 対象ワードをクリックする（
Go to next highlight） - コンテキストメニューから
Go to ...を選ぶ
- 対象ワードをクリックする（
コマンド一覧
QuickHighlight: Toggle highlight
コマンドID: tettekete.toggle-highlight-word
選択中のテキストがハイライトされている場合、ハイライトを解除します。 選択中のテキストがハイライトされていない場合、ハイライト対象にします。
QuickHighlight: Remove all highlight
コマンドID: tettekete.remove-all-highlight
全てのハイライトを解除します。
QuickHighlight: Go to next highlight
コマンドID: tettekete.goto-next-highlight
ハイライトテキストを選択しているか、ハイライトテキスト内にカーソルがあるとき、次のハイライトワードへ移動します。
QuickHighlight: Go to previous highlight
コマンドID: tettekete.goto-prev-highlight
ハイライトテキストを選択しているか、ハイライトテキスト内にカーソルがあるとき、前のハイライトワードへ移動します。
QuickHighlight: Toggle Config: Case Sensitivity
コマンドID: tettekete.toggle-config-case-sensitive
後述するコンフィグの Case Insensitive 設定をトグル変更します。
Note:
- すでにハイライトされているテキストの設定は変わりません
- ハイライトを特定するための内部 ID も変わるため、すでに生成されているテキストのハイライトが解除しにくくなる場合があります。その場合は Quick Highlight パネルからから解除を行って下さい。
QuickHighlight: Toggle Config: Word Boundary Handling
コマンドID: tettekete.toggle-config-automatic-word-boundary-handling
後述するコンフィグの Automatic Word Boundary Handling 設定をトグル変更します。
Note:
- すでにハイライトされているテキストの設定は変わりません
- ハイライトを特定するための内部 ID も変わるため、すでに生成されているテキストのハイライトが解除しにくくなる場合があります。その場合は Quick Highlight パネルからから解除を行って下さい。。
コンフィグ項目一覧
Border Only
コンフィグID: quick-highlight.borderOnly
デフォルトは OFF です。
チェックすると背景色は変更せず、ボーダーラインのみによるハイライト表示を行います。
Case Insensitive
コンフィグID: quick-highlight.caseInsensitive
デフォルトは OFF です。
チェックすると大文字小文字を無視してマッチしたワードをハイライトします。
Automatic Word Boundary Handling
コンフィグID: quick-highlight.automaticWordBoundaryHandling
チェックを外すと通常の検索を行った場合と同じように単純にマッチするテキストをハイライト対象とします。
デフォルトは ON です。この場合、例えばスペース等の単語境界に囲まれた moon をハイライト対象とした場合、自動的に独立したワードとしての moon と見做します。つまり moonlight の中の moon はハイライトしません。
逆に moonlight の中の moon を選択してハイライトを行った場合、moon も moonlight の中の moon もハイライトします。