Настройка параметров проекта и редактора

3 мин

Вы настроили контейнер разработки для одного из проектов вашего агентства. Теперь он будет "просто работать" для тех, кто имеет Docker и расширение "Контейнеры разработки". При этом все равно придется устанавливать зависимости. Кроме того, они могут использовать некоторые неизвестные расширения Visual Studio Code.

К счастью, можно полностью настроить и автоматизировать все настройки проекта с помощью файла devcontainer.json.

Подробное рассмотрение devcontainer.json

Давайте рассмотрим основные параметры в файле из .devcontainer/devcontainer.json проекта панели мониторинга продуктов. Файл довольно длинный, поэтому давайте рассмотрим его по разделам.

Конфигурация построения

Свойство image определяет, как будет создан контейнер, основываясь на том, что называется образом контейнера.

"image": "mcr.microsoft.com/devcontainers/python:0-3.11"
},

Этот образ размещен в репозитории devcontainers/images, где можно проверка его дальше. Образы в этом репозитории — это все предварительно созданные образы, которые ускоряют рабочий процесс и приводят к более .devcontainer/devcontainer.json простой конфигурации.

Вы также можете использовать файлы, известные как Dockerfile или файл Docker Compose, для настройки установки. Эти файлы могут жить в .devcontainer папке и позволяют дополнительно настроить определенные требования к установке, например установку дополнительного программного обеспечения. Дополнительные сведения см. в документации по контейнеру разработки.

Функции

Функции контейнера разработки — это автономные, совместно используемые единицы кода установки и конфигурации контейнера разработки. Имя исходит от того, что ссылка на одну из них позволяет быстро и легко добавлять средства, среду выполнения или библиотеку "Функции" в контейнер разработки для использования вами или вашими коллегами.

При использовании команды "Контейнеры разработки VS Code": добавление файлов конфигурации контейнеров разработки вы представляете список сценариев для настройки существующих конфигураций контейнеров разработки, таких как установка Git или Azure CLI.

Параметры проектов

Более поздний раздел файла связан непосредственно с конфигурацией проекта.

customizations задает определенные свойства продукта для продуктов, поддерживающих контейнеры разработки, такие как VS Code и GitHub Codespaces.

Например, можно задать vscode.settings для копирования параметров компьютера в контейнер. Это параметры, которые могут присутствовать в вашей установке Visual Studio Code. После добавления в settings эти конкретные параметры VS Code будут доступны любому пользователю, открывающему этот проект.

В этом контейнере Python эти параметры отображаются на базовом изображенииmcr.microsoft.com/devcontainers/python:0-3.11. Они предоставляют пользователю улучшенный интерфейс редактирования Python.

Массив в свойстве customizations.vscode можно использоватьextensions, чтобы указать, какие расширения Visual Studio Code должны быть установлены в Visual Studio Code при подключении к контейнеру. Обычная настройка Visual Studio Code и все уже имеющиеся расширения не будут присутствовать при использовании контейнеров разработки. Расширения указаны здесь с идентификаторами.

postCreateCommand

Свойство postCreateCommand позволяет выполнять все команды, которые требуется выполнить после создания контейнера. Как вы, возможно, помните из первого упражнения, для установки зависимостей нужно было выполнить команду pip3. Но как вы узнаете, что это нужно сделать? Возможно, вы не будете этого знать. Вы можете настроить его здесь, чтобы оно произошло автоматически, и другие не должны беспокоиться об этом.