Автоматическое открытие файлов в пространствах кода для репозитория

Вы можете автоматически открывать определенные файлы, когда кто-то создает пространство кода для репозитория и открывает пространство кода в веб-клиенте Visual Studio Code.

Кто может использовать эту функцию?

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

В этой статье

Обзор

Если есть определенный файл, который полезен пользователям, чтобы увидеть, когда они создают пространство кода для репозитория, этот файл можно открыть автоматически в веб-клиенте VS Code. Этот параметр настраивается в файле конфигурации контейнера разработки для репозитория.

Указанный файл или файлы открываются только при первом открытии пространства кода в веб-клиенте. Если пользователь закрывает указанные файлы, эти файлы не будут автоматически повторно открываться при следующем открытии или перезапуске пространства кода.

Примечание. Эта автоматизация применяется только к веб-клиенту VS Code, а не к классическому приложению VS Code или другим поддерживаемым редакторам.

Настройка автоматического открытия файлов

  1. Вы можете настроить пространства кода, созданные для репозитория, добавив параметры в 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 свойства — это массив одного или нескольких файлов в репозитории. Пути относительно корневого каталога репозитория (абсолютные пути не поддерживаются). Файлы открываются в веб-клиенте в указанном порядке с первым файлом в массиве, отображаемым в редакторе.

  3. Сохраните файл и зафиксируйте изменения в требуемой ветви репозитория.

Дополнительные материалы