Visual Studio Codeでパス補完機能を細かく設定して自分好みにできる拡張機能「Path Autocomplete」

Visual Studio Codeではデフォルトの状態でも、ある程度パスの入力補助がついていますが、拡張機能を使うことでさらに細かい設定ができて便利になります。
今回はパス入力を効率化する「Path Autocomplete」についてまとめておきます。
Path Autocomplete

Path Autocompleteはsrcやhref属性のパス候補を表示してくれる拡張機能です。
他に似た有名な拡張機能に「Path Intellisense」がありますが、Path Autocompleteは候補に表示したくないファイルを、いま開いているファイルの拡張子に合わせて条件を細かく設定できます。
Path Intellisenseも候補に表示するファイルの設定はできますが、全ファイル共通の設定になってしまいます。
たとえば、.scssファイルを開いているときは.scssファイルもインポートするために使いますが、.htmlを開いているときは.scssファイルは候補に出したくないなどの細かい設定ができます。
フォルダ分けしておけばあまり困ることはありませんが、条件設定の細かさからPath Autocompleteを使っています。
ただし、Path Intellisenseの方がインストール数は断然多いので、とりあえずメジャーな方を使っておくという意味ではPath Intellisenseの方が良いかもしれません。
基本的な使い方
拡張機能を有効化後は、デフォルトの自動補完機能を無効化するために、下記設定を追加します。
{
"javascript.suggest.paths": false,
"typescript.suggest.paths": false,
}あとはパスを入力しようとすると自動で候補が表示されます。
| 入力 | 表示される候補 |
|---|---|
| ./ | 現在のディレクトリからのファイル候補 |
| / | ルートディレクトリからのファイル候補 |
| ~/ | ユーザーのディレクトリからのファイル候補 |
Visual Studio Codeデフォルトの補完機能には「~/」でのユーザーディレクトリからの候補選択ができないので、これを入力することで拡張機能がインストールされているかどうか判断できます。
もしくは、「Path Autocomplete」で補完されるサジェストの項目がアクティブになったときに、フォルダ・ファイル名の右隣にパスが表示されます。

設定の変更
候補に表示しないファイルを指定する
デフォルトの状態だと、すべてのファイルが候補として表示されてしまうため、表示したくないファイルは「”path-autocomplete.excludedItems”」に設定しておくことで非表示にできます。
*(アスタリスク)を使いながら、どの拡張子やフォルダを候補に表示しないか入力します。
そして、{ "when": "" }の中に条件を適用するファイルを指定します。
**を指定すると全ファイルになりますし、**/*.htmlとすると.htmlファイルのみで条件が適用されます。
{
"path-autocomplete.excludedItems": {
"**/.*un~": { "when": "**" },
"**/*.js": { "when": "**/*.ts" },
"**/*.map": { "when": "**" },
"**/{.git,node_modules}": { "when": "**" }
}
}フォルダ補完後の自動スラッシュ入力
デフォルトだとフォルダ補完後に自動でスラッシュは入力されないので、自分で入力する必要がありますが「”path-autocomplete.enableFolderTrailingSlashboolean”」を「true」にするとスラッシュが自動で入力されるようになります。
{
"path-autocomplete.enableFolderTrailingSlashboolean": true,
}Markdownやプレーンテキストでも補完できるようにする
Markdownやプレーンテキスト以外でも補完機能を使えるようにするためには「”path-autocomplete.triggerOutsideStrings”」を「true」にすると補完できるようになります。
{
"path-autocomplete.triggerOutsideStrings": true
}引用符の外側でも補完できるようにする
デフォルトだと””の中でのみ発火しますが、「”path-autocomplete.triggerOutsideStrings”」を「true」にするとどこでも補完できるようになります。
{
"path-autocomplete.triggerOutsideStrings": true
}どこでも発火されてしまうと逆に邪魔になることの方が多いですし、引用符外で使うこともないので基本的にはデフォルトのままで良さそうです。
絶対パスの設定
デフォルトだと絶対パスはワークスペースのルートパス内にされます。
基本的にはこの設定の方が便利だと思いますが、ディスクルートパスへの絶対パスに変更するためには、「”path-intellisense.absolutePathToWorkspace”」を「false」に設定します。
{
"path-intellisense.absolutePathToWorkspace": false,
}マッピング設定
特定フォルダを絶対パスのルートに設定したい場合や、Webpackでパスを使用したい場合は「”path-intellisense.mappings”」でマッピング設定ができます。
"path-autocomplete.pathMappings": {
"/": "${folder}/src",
"/test": "${folder}/src/Actions/test",
"$root": ${folder}/src
}「${folder}」を使うと、ワークスペースのトップのパスが指定されます。
Visual Studio Codeのデフォルト機能だとこの辺りの設定ができないので、この辺の設定ができるのが補完機能の拡張機能を使うメリットです。


Visual Studio Codeで「.html」拡張子以外のファイルでもEmmetを使えるようにする
JavaScriptで簡単にCookie操作ができるライブラリ「js-cookie」
Nuxt.jsの基本と最初のセットアップ「プロジェクトの作成と起動をするまでの流れ」
Apacheのテストページを非表示にする方法
WordPressのプラグインはどれを入れたら良い?とりあえず最初に導入をオススメするプラグイン一覧
EJSのincludeで別ファイルを読み込むときの画像パスを指定する方法
Webサイト制作の基礎の基礎、HTMLって何?
WordPressで既に公開済みの記事の更新を、指定した日付に反映する方法「PublishPress Revisions」
Movable TypeでAssetURLやEntryPermalink・ContentPermalinkで出力されるパスを絶対パスから相対パスに変える
Google Maps APIでピンの見た目をカスタマイズする方法
AirPodsで片耳を外しても再生が止まらないようにする方法
MacのKeynoteにハイライトされた状態でコードを貼り付ける方法
iTerm2でマウスやトラックパッドの操作を設定できる環境設定の「Pointer」タブ
DeepLで「インターネット接続に問題があります」と表示されて翻訳できないときに確認すること
Ulyssesの「第2のエディタ」表示を使って2つのシートを横並びに表示する
Path Finder 9.3.5のアップデート内容はラベル・タグ周りの修正!そしていつの間にかカラーラベルのカスタマイズが可能に!
Macの圧縮・解凍アプリケーションまとめ
ターミナルに表示されるmacのコンピュータ名を変更する方法
既存プロジェクトにCompassが導入されている場合に備えて、最低限Sassのコンパイルだけでも行えるようにしておく
Figmaで企業やサービスのブランドロゴやカラーをすぐ参照できるプラグイン「Brandfetch」
macOSのシステム環境設定「アクセシビリティ」内にあるVoiceOverの設定見直し
動画の圧縮をFinder右クリックメニューの「選択したビデオファイルをエンコード」から行う
一瞬で日時を取得するKeyboard Maestroのタイムスタンプ機能についてまとめる
Alfred 4のファイル検索時にプレビュー表示ができるPreviewsの設定項目まとめ