Přizpůsobení nastavení projektu a editoru

Dokončeno

Nastavili jste vývojový kontejner pro jeden z projektů vaší agentury. Teď bude fungovat jen pro každého, kdo má Docker a rozšíření Dev Containers. Budou muset stále instalovat závislosti. Budou také pravděpodobně potřebovat některá rozšíření Visual Studio Code, o kterých neví.

Naštěstí můžete veškerá nastavení projektu plně přizpůsobit a automatizovat pomocí souboru devcontainer.json.

Bližší pohled na devcontainer.json

Pojďme se podívat na hlavní možnosti v .devcontainer/devcontainer.json souboru z projektu Řídicí panel Produktů. Je trochu dlouhý na to, aby se dal prohlížet najednou, a proto se na něj podíváme po částech.

Konfigurace sestavení

Vlastnost image definuje způsob vytvoření kontejneru na základě toho, co se označuje jako image kontejneru.

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

Tato image je hostovaná v úložišti devcontainers/images, kde ji můžete dále rezervovat. Image v tomto úložišti jsou všechny předem připravené image, které urychlují pracovní postup a vedou k jednodušší .devcontainer/devcontainer.json konfiguraci.

Ke konfiguraci nastavení můžete také použít soubory označované jako Dockerfile nebo soubor Docker Compose. Tyto soubory můžou být ve vaší .devcontainer složce aktivní a umožňují vám dále nakonfigurovat určité požadavky na nastavení, jako je instalace dalšího softwaru. Další informace najdete v naší dokumentaci k vývojovému kontejneru.

Funkce

Funkce vývojového kontejneru jsou samostatné, sdíletelné jednotky instalačního kódu a konfigurace vývojového kontejneru. Název pochází z myšlenky, že odkazování na jeden z nich vám umožní rychle a snadno přidat do vývojového kontejneru další nástroje, modul runtime nebo knihovnu "Funkce" pro použití vámi nebo vašimi spolupracovníky.

Když použijete příkaz VS Code pro Dev Containers: Přidání konfiguračních souborů vývojového kontejneru, zobrazí se seznam skriptů pro přizpůsobení existujících konfigurací vývojového kontejneru, jako je instalace Gitu nebo Azure CLI.

Nastavení projektu

Pozdější část souboru se zabývá přímo konfigurací projektu.

customizations nastaví vlastnosti specifické pro produkty, které podporují vývojové kontejnery, jako jsou VS Code a GitHub Codespaces.

Můžete například nastavit vscode.settings kopírování nastavení specifických pro počítač do kontejneru. Je možné, že tato nastavení budete mít ve své vlastní instalaci nástroje Visual Studio Code. Tím, že je přidáte do settingssouboru , zajistíte, aby každý, kdo otevře tento projekt, získal tato konkrétní nastavení VS Code.

V tomto kontejneru Pythonu uvidíte tato nastavení v základní imagi mcr.microsoft.com/devcontainers/python:0-3.11. Poskytují uživateli vylepšené prostředí pro úpravy Pythonu.

  • Pole v rámci customizations.vscode vlastnosti můžete použít extensions k určení, která rozšíření editoru Visual Studio Code by se měla nainstalovat v editoru Visual Studio Code, když se připojí k kontejneru. Vaše normální nastavení editoru Visual Studio Code a všechna rozšíření, která už máte, nebudou k dispozici, když používáte Dev Containers. Rozšíření jsou zde uvedena s jejich ID.

postCreateCommand

Tato postCreateCommand vlastnost umožňuje spustit všechny požadované příkazy po vytvoření kontejneru. Pokud si pamatujete, tak v prvním cvičení bylo třeba nainstalovat závislosti spuštěním příkazu pip3. Ale jak se jako uživatel dozvíte, že to je třeba udělat? Možná ani nebudete muset. Tady ho můžete nakonfigurovat tak, aby se to stalo automaticky a ostatní se o něj nemusí starat.

V dalším cvičení upravíte soubor devcontainer.json s cílem automatizovat několik aspektů projektu, aby s ním mohli jiní vývojáři okamžitě úspěšně pracovat.