リポジトリの codespace にあるファイルを自動的に開く

概要

他のユーザーがリポジトリに codespace を作成するときに確認しておくと便利な特定のファイルがある場合は、VS Code Web クライアントでそのファイルが自動的に開かれるように設定することができます。 この設定は、リポジトリの開発コンテナー構成ファイルで行います。

指定した 1 つ以上のファイルが開かれるのは、Web クライアントで codespace が初めて開かれたときのみです。 指定したファイルをユーザーが閉じた場合、同じユーザーが次にその codespace を開いたときまたは再起動したときに、それらのファイルを自動的に再び開く処理は行われません。

ファイルが自動的に開かれるように設定する

1. リポジトリに作成された codespace は、devcontainer.json ファイルに設定を追加することで構成できます。 リポジトリに devcontainer.json ファイルがまだ含まれていない場合、今から追加できます。 「開発コンテナー構成のリポジトリへの追加」をご覧ください。

2. devcontainer.json ファイルを編集し、customizations.codespaces.openFiles プロパティを追加します。 customizations プロパティは、ファイルの最上位レベルの、JSON オブジェクト内にあります。 次に例を示します。

   JSON

   "customizations": {
     "codespaces": {
       "openFiles": [
         "README.md",
         "scripts/tsconfig.json",
         "docs/main/CODING_STANDARDS.md"
       ]
     }
   }
   

   openFiles プロパティの値は、リポジトリ内の 1 つ以上のファイルの配列です。 パスはリポジトリのルートからの相対パスです (絶対パスはサポートされていません)。 Web クライアントでは、指定した順序でファイルが開かれ、配列の最初のファイルがエディターに表示されます。

3. ファイルを保存し、リポジトリの必要なブランチに加えた変更をコミットします。

参考資料

• 「開発コンテナーの概要」