Automatisches Öffnen von Dateien in den Codespaces für ein Repository

Du kannst festlegen, dass bestimmte Dateien automatisch geöffnet werden, wenn jemand einen Codespace für dein Repository erstellt und den Codespace im Visual Studio Code-Webclient öffnet.

Wer kann dieses Feature verwenden?

People with write permissions to a repository can create or edit the codespace configuration.

In diesem Artikel

Übersicht

Wenn Benutzer*innen beim Erstellen eines Codespaces für dein Repository eine bestimmte Datei angezeigt werden soll, kannst du festlegen, dass diese automatisch im VS Code-Webclient geöffnet wird. Diese Einstellung kannst du in der Konfigurationsdatei des Entwicklungscontainers für dein Repository vornehmen.

Die von dir angegebenen Dateien werden nur geöffnet, wenn ein Codespace zum ersten Mal im Webclient geöffnet wird. Wenn eine Benutzerin die angegebenen Dateien schließt, werden diese nicht automatisch erneut geöffnet, wenn diese*r den Codespace das nächste Mal öffnet oder neu startet.

Note

Diese Automatisierung gilt nur für den VS Code-Webclient, nicht für die VS Code-Desktopanwendung oder andere unterstützte Editors.

Festlegen der automatischen Dateiöffnung

  1. Füge einer devcontainer.json-Datei Einstellungen hinzu, um die für dein Repository erstellten Codespaces zu konfigurieren. Wenn dein Repository noch keine devcontainer.json-Datei enthält, kannst du jetzt eine hinzufügen. Weitere Informationen findest du unter Hinzufügen einer Entwicklungscontainerkonfiguration zu deinem Repository.

  2. Bearbeite die devcontainer.json-Datei, und füge eine customizations.codespaces.openFiles-Eigenschaft hinzu. Die customizations-Eigenschaft befindet sich innerhalb des umschließenden JSON-Objekts am Anfang der Datei. Beispiel:

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

    Der Wert der openFiles-Eigenschaft ist ein Array aus mindestens einer Datei in deinem Repository. Die Pfade sind relativ zum Stammverzeichnis des Repositorys (absolute Pfade werden nicht unterstützt). Die Dateien werden im Webclient in der angegebenen Reihenfolge geöffnet, wobei die erste Datei im Array im Editor angezeigt wird.

  3. Speichere die Datei, und committe deine Änderungen in den gewünschten Branch des Repositorys.

Weiterführende Themen