VS Code拡張機能 PR File Search 作って見た。
今回は、最近開発したVisual Studio Code拡張機能「PR File Search」についてご紹介します。
この拡張機能は、プルリクエスト(PR)関連のファイル検索を劇的に簡単にするものです。
PRと書いてますが、実際は master とのファイル差分を見ているので
もちろんPRを出す前でも利用できます。
Command P
で新しいファイルを開き
それ以降はこの拡張機能の Command Control P
で作業中ファイルから探せます。
なぜこの拡張機能を作ったのか?
大規模なプロジェクトで作業していると、PRで変更したファイルを素早く見つけて確認したいことがよくあります。しかし、既存の方法では時間がかかったり、面倒だったりしました。そこで、この問題を解決するための拡張機能を作ることにしました。
具体的には React Redux など作業ファイルが膨大になりがちな作業環境で欲しかったので作ってます。
PR File Searchの主な特徴
- 高速検索: ローカルのGit操作を使用しているため、非常に高速です。
- 簡単操作: カスタムキーバインディング(MacではCmd+Ctrl+P、WindowsとLinuxではCtrl+Alt+P)で簡単に起動できます。
- 包括的な検索: ステージされたファイル、未ステージのファイル、新規ファイルを含む全ての変更ファイルを検索対象とします。
- 削除ファイルの除外: 検索結果から削除されたファイルを自動的に除外します。
使い方
- VS CodeでGitリポジトリを開きます。
- 変更を含むブランチにチェックアウトします。
- キーボードショートカットを使用して検索機能を起動します。
- 表示されたリストから目的のファイルを選択して開きます。
技術的な詳細
この拡張機能は、git diff
コマンドを利用して現在のブランチとメインブランチ(main
またはmaster
)の差分を取得しています。パフォーマンスを向上させるため、結果のキャッシュは行わず、毎回新鮮な結果を提供します。
インストール方法
Visual Studio Code Marketplaceからインストールできます。
今後の展望
現在、以下の機能を検討しています:
- メインブランチ名のカスタマイズオプション
- ファイルタイプによるフィルタリング
- 差分の表示機能
おわりに
PR File Searchは、日々のコーディング作業を少しでも効率化したいという思いから生まれました。皆さんのワークフローの改善に役立てば幸いです。
ぜひ試してみてください!フィードバックやプルリクエストも大歓迎です。GitHubリポジトリでお待ちしています。
Happy coding!