Anpassa projekt- och redigeringsinställningar

  • 3 minuter

Du har konfigurerat en utvecklingscontainer för ett av byråns projekt. Det kommer nu att "bara fungera" för alla som har Docker och Dev Containers-tillägget. De måste fortfarande installera beroenden. De kan också behöva vissa Visual Studio Code-tillägg som de inte känner till.

Som tur är kan du anpassa och automatisera alla projektkonfigurationer med hjälp av filen devcontainer.json.

En närmare titt på devcontainer.json

Nu ska vi titta på de viktigaste alternativen i filen .devcontainer/devcontainer.json från projektet Produktöversikt. Det är lite lång tid att titta på allt på en gång, så låt oss titta på det i avsnitt.

Byggkonfiguration

Egenskapen image definierar hur containern ska skapas, baserat på vad som kallas en container avbildning.

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

Den här avbildningen finns i lagringsplatsen devcontainers/images, där du kan kolla in den ytterligare. Avbildningarna på den här lagringsplatsen är alla fördefinierade avbildningar, vilket påskyndar arbetsflödet och resulterar i en enklare .devcontainer/devcontainer.json konfiguration.

Du kan också använda filer som kallas Dockerfile eller en Docker Compose-fil för att konfigurera konfigurationen. Dessa filer kan finnas i mappen .devcontainer och du kan konfigurera vissa installationskrav ytterligare, till exempel att installera ytterligare programvara. Du kan läsa mer i vår dokumentation om utvecklingscontainern .

Funktioner

Utvecklingscontainer Funktioner är fristående, delningsbara enheter för installationskod och konfiguration av utvecklingscontainer. Namnet kommer från tanken att om du refererar till en av dem kan du snabbt och enkelt lägga till fler verktyg, körexempel eller biblioteksfunktioner i din utvecklingscontainer för dig eller dina samarbetspartners att använda.

När du använder KOMMANDOT VS Code Dev Containers: Lägg till Dev Container Configuration Filesvisas en lista med skript för att anpassa befintliga konfigurationer av dev-container, till exempel installation av Git eller Azure CLI.

Projektinställningar

Ett senare avsnitt i filen handlar direkt om projektkonfiguration.

customizations anger produktspecifika egenskaper för produkter som stöder dev-containrar, till exempel VS Code och GitHub Codespaces.

Du kan till exempel ange vscode.settings för att kopiera datorspecifika inställningar till containern. Du kan ha de här inställningarna i din egen Visual Studio Code-konfiguration. Genom att lägga till dem i settingsser du till att alla som öppnar det här projektet får dessa specifika VS Code-inställningar.

I den här Python-containern kan du se de här inställningarna i basavbildningen mcr.microsoft.com/devcontainers/python:0-3.11. De ger användaren en förbättrad Python-redigeringsupplevelse.

  • Du kan använda matrisen extensions i egenskapen customizations.vscode för att ange vilka Visual Studio Code-tillägg som ska installeras i Visual Studio Code när det ansluter till containern. Din normala Visual Studio Code-konfiguration och alla tillägg som du redan har kommer inte att finnas när du använder Dev Containers. Tillägg anges här med sina ID-nummer.

postCreateCommand

Med egenskapen postCreateCommand kan du köra alla kommandon som du vill när containern har skapats. Om du kommer ihåg från den första övningen var du tvungen att köra kommandot pip3 för att installera beroenden. Men hur skulle du kunna göra det? Du kanske inte gör det. Du kan konfigurera det här så att det sker automatiskt och andra inte behöver oroa sig för det.

I nästa övning ändrar du filen devcontainer.json för att automatisera flera aspekter av projektet som konfigurerar andra utvecklare för omedelbar framgång.