ニュース

Visual Studio CodeでGitHubリポジトリを「読む」のに便利な拡張機能が登場

わざわざローカルにクローンしなくてもOK。そのままVisual Studio Code上で閲覧できる

樽井秀人

2021年6月16日 11:00

「Remote Repositories」拡張機能

　米国時間6月10日に公開された「Visual Studio Code」の2021年5月アップデート（v1.57）では、これまでプレビュー版として同梱されていた「Remote Repositories」が「Visual Studio Code」から切り離され、単独の拡張機能としてリリースされた。「Visual Studio Marketplace」などから導入する必要があるが、「GitHub」のリポジトリを「読む」機会の多い開発者は入れておいて損はない拡張機能だ。

　開発者の仕事は、なにも自分のプロジェクトでコーディングするだけではない。同時に自分のプロジェクトで使えそうなライブラリを試したり、デバッグのために開発プラットフォームや外部ライブラリを調査したり、外部の開発者から送られてきたプルリクエストをレビューしたりといった、さまざまな業務を並行して行うのが一般的だ。コードを「書く」よりも「読む」ことの方がずっと多い開発者も少なくないだろう。

　しかし、「GitHub」のリポジトリを読むには手間がかかる。まず、ローカルにリポジトリをクローンする必要がある。小規模なリポジトリならばすぐに済むが、大規模なリポジトリであればかなりの時間がかかる。また、すでにクローン済みであっても、コードを読む前にプルしなければならない。これを忘れると、クローンしたあとに改変されたコードがある場合、古いコードを読むことになってしまう。また、信頼できないリポジトリであれば、クローンしたあとに誤って実行しないように注意する必要もあるだろう。

　そうした手間を大幅に簡略化してくれるのが、今回正式リリースされた「Remote Repositories」拡張機能だ。この拡張機能を利用すると、「Visual Studio Code」から直接リポジトリのコードを閲覧することが可能。検索や編集、コミットもできるが、事前にクローンしておく必要はない。現在は「GitHub」のリモートリポジトリにしか対応していないが、近々「Azure Repos」にも対応するという。

　「Remote Repositories」拡張機能を利用するには、コマンドパレット（［F1］キー）で「Remote Repositories: Open Repository」コマンドを実行する。するとコマンドが列挙されるので、「Open Repository from GitHub」を選択する。初回利用時はここで「GitHub」へのサインインが求められるので、案内に従ってサインインしておく。これで「GitHub」のリポジトリの検索と閲覧が可能になるはずだ。

コマンドパレット（［F1］キー）で「Remote Repositories: Open Repository」コマンドを実行

「Open Repository from GitHub」を選択

初回利用時はここで「GitHub」へのサインインが求められる

「GitHub」のリポジトリの検索と閲覧が可能に

　「Remote Repositories」拡張機能で開いたリモートリポジトリはローカルにすべてコピーされず、「仮想ワークスペース」に展開される。アクセスしたコンテンツだけがオンデマンドで取得される仕組みで、一部機能は制限されるものの、エクスプローラーや検索機能、タイムラインビュー、クイックオープン、ソースコントロールなど、だいたいの機能は利用できる。「GitHub」上でソースコードをナビゲーションするよりも手軽でよい。常に最新のコードが表示される点や、そのままビルド・実行できないため安心できる点も、閲覧専用で使う分には魅力だ。それでもなおセキュリティが不安であれば、「Visual Studio Code」の「制限モード」を併用することもできる。

画面左下の緑の［GitHub］ラベルが「仮想ワークスペース」であることを示す。ポップアップから「仮想ワークスペース」で利用不能な機能をチェックできる

エクスプローラーや検索機能、タイムラインビュー、クイックオープン、ソースコントロールなど、だいたいの機能は利用可能。コードの閲覧が捗る

　さらに本拡張機能は「GitHub Pull Requests」とも連携できるようになっており、ローカルにコードをクローンすることなくプルリクエストをすばやくチェックできる。ブランチの切り替えもステータスバーから簡単に行えるため、異なるブランチを同時に操作することも可能だ。「Remote Repositories」の能力を超える高度な操作を行う場合は、ローカルにクローンするか、コンテナーボリュームにクローンするか、「GitHub Codespace」で開くかを選択できる。

　なお、本拡張機能は単独でリリースされたものの、開発ステータスはまだプレビューなので利用の際は注意。