GitHub Codespaces の既定のエディターを設定する

[設定] ページでは、codespace を作成したり既存の codespace を開いたりするときに、次のいずれかの方法で開くように、エディターの基本設定を設定できます。

Visual Studio Code (desktop application)
Visual Studio Code (web client application)
JetBrains Gateway - JetBrains IDE で codespace を開く場合
JupyterLab - Project Jupyter の Web インターフェイス

新しい codespace をテンプレートから作成すると、常に Visual Studio Code Web クライアントで開きます。サポートされているエディターでは、既存の codespace を開くことができます。詳しくは、「既存の codespace を開く」を参照してください。

GitHub Codespaces の既定のエディターとして Visual Studio Code を使う場合は、Visual Studio Code と、Visual Studio Code 用の GitHub Codespaces 拡張機能をインストールする必要があります。詳しくは、Visual Studio Code のダウンロードページと、Visual Studio Code マーケットプレースの GitHub Codespaces 拡張機能をご覧ください。

JetBrains IDE の codespace で作業する場合は、JetBrains Gateway をインストールする必要があります。詳しくは、「JetBrains IDE で GitHub Codespaces を使う」を参照してください。

既定のエディターを設定する

GitHub で、任意のページの右上隅にある自分のプロフィール写真をクリックしてから、 [設定] をクリックします。
サイドバーの [コード、プラン、自動化] セクションで、[ Codespaces] をクリックします。
Editor preference で、必要なオプションを選びます。
- Visual Studio Code または JetBrains Gateway を選ぶ場合、選んだアプリケーションをローカルコンピューターにインストールしていることを確認する必要があります。
- Visual Studio Code を選ぶ場合、codespace を次回作成するか開いたときに、デスクトップアプリケーションで GitHub Codespaces が自動的に開きます。
  
  正常に開かれるには、ブラウザーと Visual Studio Code の両方へのアクセスを許可することが必要な場合があります。
- JetBrains Gateway を選ぶ場合、codespace を次回作成するか開いたときに、Gateway アプリケーションが自動的に開きます。
  
  この方法で初めて codespace を開いたときは、アプリケーションを開く権限を付与する必要があります。
  
  Gateway が自動的に開いてから、codespace が自動的に選択されます。その後、JetBrains IDE をこれまでに選んでいなければ、これを選び、 [接続] をクリックして、JetBrains クライアント内にある codespace を開きます。詳しくは、「JetBrains IDE で GitHub Codespaces を使う」を参照してください。
  
  Gateway アプリケーションから codespace に接続するには、codespace で実行されている SSH サーバーが必要です。接続する codespace では、SSH サーバーを実行している必要があります。既定の開発コンテナーイメージには、自動的に開始される SSH サーバーが含まれています。 codespaces が既定のイメージから作成されていない場合は、devcontainer.json ファイル内の features オブジェクトに次を追加することで、SSH サーバーをインストールして起動できます。
```
"features": {
    // ...
    "ghcr.io/devcontainers/features/sshd:1": {
        "version": "latest"
    },
    // ...
}
```
- JupyterLab を選ぶ場合は、開いている codespace に JupyterLab をインストールする必要があります。既定の開発コンテナーイメージには JupyterLab が含まれているため、既定のイメージから作成された codespace には常に JupyterLab がインストールされます。既定のイメージについて詳しくは、「開発コンテナーの概要」と devcontainers/images リポジトリをご覧ください。開発コンテナー構成で既定のイメージを使用していない場合は、devcontainer.json ファイルに ghcr.io/devcontainers/features/python 機能を追加して JupyterLab をインストールできます。オプション "installJupyterlab": trueを含める必要があります。詳しくは、devcontainers/features リポジトリにある python 機能の Readme をご覧ください。

参考資料

「codespace のカスタマイズ」
「Codespaces を管理する」

GitHub Codespaces の既定のエディターを設定する

この記事の内容

既定のエディターを設定する

参考資料