えいあーるれいの技術日記

ROS2やM5 Stack、Ubuntuについて書いています

Remote Repositoriesを使ってみる。GitHubリポジトリをVSCodeで直接編集!?

Remote-repositoriesというVSCodeのツールが発表されました。

code.visualstudio.com

このツールは、オンライン接続を前提としてGitHubリポジトリVSCode上で取り扱うことができるとても強力なツールです。

わずか数ステップでGitHubリポジトリをコミットでき、ディスクを全く圧迫しない(findコマンドで検出できない)ため、GitHub上で面倒なタブ移動とVSCodeならではのClone作業のどちらも不要になります。

しかも、一度登録すれば簡単にリポジトリに復帰することができるので、ブラウザのGitHubVSCodeで読むということが簡単に実現してしまいます。

少し試してみたので、主な機能について紹介したいと思います。

インストール

VSCodeは予めインストールされていることを前提とします。

「Extensions」タブにおいて「remote repositories」と入力して検索して、「Remote Repositories」をインストールします。

f:id:Ray_ar:20210617111705p:plain

GitHubアカウントの紐づけ

GitHubリポジトリへのアクセスは、1度だけGitHubアカウントを登録する必要があります。

この登録することでどのリポジトリからもワンクリックアクセスが可能になります

登録にはGitHubに登録されているウェブブラウザが必要です(開いたタブでログインすればOKです)

f:id:Ray_ar:20210617114416p:plain

GitHubリポジトリへのURLを貼り付け、Enterを押すと、初回のみ自動的にWebブラウザが開くので、ログインするなりして登録します。

f:id:Ray_ar:20210617115943p:plain

これでリポジトリを取得できます(Cloneしていません)。

編集作業(めちゃ快適)

GitHubへのコミットはなんとわずか2ステップ!

  1. なにかしら変更を加える
  2. "Source Controll"タブに移動し、コミットメッセージを入力する
  3. チェックボタンを押す

f:id:Ray_ar:20210617105630p:plain

結果、チェックボタンを押した時点でのコミットがGitHubリポジトリに上書きされ、ログが残りました。

f:id:Ray_ar:20210617105644p:plain

ブランチの作成やチェックアウトも簡単です。これまでのGitHub連携のときと同様に使うことができます。

注意点

GitHubの仮想環境にアクセスしているらしいので、次の点に注意が必要です。下記は、Remote Repositoriesの翻訳です。

デバッグ、ターミナル、タスク - 現在はサポートされていません。ターミナルはローカルファイルシステム上で開き、リモートリポジトリの仮想ファイルシステムにはアクセスできません。

・限定的な言語インテリジェンス - 多くの言語がリモートリポジトリの仮想環境をまだ理解していないため、インテリセンスやGo to Definitionなどの機能が影響を受ける可能性があります。

・検索 - GitHubの検索には、ブランチのインデックスを作成できないなどの制限があります。リモートリポジトリでは、インデックスを有効にすることでこの制限を回避し、全文検索を行うことができます。インデクシングは、GitHub からリポジトリの浅いクローンを取得してローカルで全文検索を行うもので、GitHub のファジーなデフォルトブランチのネイティブ検索よりも強力です。リモートリポジトリのインデックス化は、検索ビューから有効にできます。

・エクステンションの制限 - すべてのエクステンションが仮想ワークスペースでの実行をサポートしているわけではありませんが、時間の経過とともにサポートするエクステンションが増えていきます。ローカルファイルへのアクセスに大きく依存しているエクステンションは、この設定をサポートできません。詳細については、以下の仮想ワークスペースのセクションを参照してください。

コンパイルや実行は難しいみたいですねー。PCに保存されているわけではなく、あくまでリモートアクセスらしいです。

そのため、この機能の使いみちとしてはドキュメント・Wiki編集が向いてそうです。

開発途上ということもあり、これからもっといい機能が追加されるといいですね。

少なくとも軽く確認したいのにクローンをいちいち行うのが面倒な人やファイル管理が面倒な人向けだなーと思いました。

VSCodeとは?

VSCode (Visual Studio Code)はMicrosoftが開発するクロスプラットホームなIDE機能付きエディタです。軽量・Git付き・リモートアクセス可・GUIの美しさなどのエディタに求める要素をほぼ全て詰め込んだ非常に強力なツールで、2019年の時点で51%のシェアを誇る大人気エディタとなりました。

VSCodeに外部プラグインを作ったり(PlatformIO)、VSCodeを他のエディタのベース(Arduino 2.0)にすることもできるなどの圧倒的な拡張性があるのも特徴。

オススメ書籍(画像は商品リンクにつながっています)