Microsoft Visual Studio Code

Das Softwarepaket Microsoft Visual Studio Code ermöglicht neben der Installation des Programms auch die automatische Installation von Erweiterungen (Extensions) auf den Windows-Clients.

Für die Installation von Erweiterungen stehen drei Möglichkeiten zur Verfügung:

  • Installation über die Produkteigenschaft Optionale Erweiterungen in der IServ-Softwareverteilung.

  • Installation über eine Konfigurationsdatei extensions.txt in der IServ-Freigabe.

  • Installation über lokal hinterlegte Erweiterungsdateien im Format .vsix.

Die Installation über VSIX-Dateien kann zusätzlich zu einer der beiden anderen Möglichkeiten verwendet werden.

Hinweis

Wenn unter \\iserv\appdata\microsoft-vs-code eine Datei namens extensions.txt vorhanden ist, wird die Produkteigenschaft Optionale Erweiterungen ignoriert. Die Installation der VSIX-Dateien ist davon nicht betroffen.

Erweiterungs-IDs ermitteln

Für die Installation über das Eingabefeld oder die extensions.txt wird die eindeutige Extension-ID benötigt. Diese besteht üblicherweise aus dem Namen des Herausgebers und dem Namen der Erweiterung, getrennt durch einen Punkt.

Beispiele:

  • esbenp.prettier-vscode für Prettier - Code formatter.

  • dbaeumer.vscode-eslint für ESLint.

  • ms-python.python für Python.

Die Extension-ID kann direkt in Visual Studio Code oder über den Visual Studio Marketplace ermittelt werden.

Extension-ID in Visual Studio Code ermitteln

  1. Öffnen Sie Visual Studio Code.

  2. Öffnen Sie über das Erweiterungssymbol in der linken Seitenleiste die Erweiterungsverwaltung oder verwenden Sie die Tastenkombination Strg+Umschalt+X.

  3. Suchen Sie nach der gewünschten Erweiterung und öffnen Sie deren Detailseite.

  4. Klicken Sie mit der rechten Maustaste auf die Erweiterung und wählen Sie Copy Extension ID (Extension-ID kopieren). Je nach Version ist der Eintrag auch über das Kontextmenü der Erweiterung erreichbar.

  5. Fügen Sie die kopierte ID in die gewünschte Konfiguration ein.

Kontextmenü einer VS-Code-Erweiterung mit dem Eintrag Copy Extension ID

Extension-ID im Visual Studio Marketplace ermitteln

  1. Öffnen Sie den Visual Studio Marketplace.

  2. Suchen Sie die gewünschte Erweiterung und öffnen Sie deren Detailseite.

  3. Ermitteln Sie die Extension-ID aus dem Parameter itemName in der Adresszeile.

Beispiel einer Marketplace-Adresse:

https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode

Die gesuchte Extension-ID lautet in diesem Beispiel esbenp.prettier-vscode.

Marketplace-Detailseite mit markierter Extension-ID in der Adresszeile

Erweiterungen über die Weboberfläche installieren

Über die Produkteigenschaft Optionale Erweiterungen können mehrere Extension-IDs angegeben werden.

  1. Navigieren Sie in der IServ-Weboberfläche zu Netzwerk > Softwarepakete.

  2. Öffnen Sie das Softwarepaket Microsoft Visual Studio Code.

  3. Tragen Sie im Feld Optionale Erweiterungen die gewünschten Extension-IDs ein.

  4. Trennen Sie mehrere IDs durch das Pipe-Zeichen |. Geben Sie die IDs hintereinander ohne Zeilenumbruch ein.

  5. Übernehmen Sie die Konfiguration und starten Sie die Installation des Softwarepakets auf den gewünschten Clients.

Beispiel:

esbenp.prettier-vscode|dbaeumer.vscode-eslint|ms-python.python
Produkteigenschaft Optionale Erweiterungen in der IServ-Softwareverteilung

Hinweis

Für diese Installationsart darf unter \\iserv\appdata\microsoft-vs-code keine extensions.txt vorhanden sein, da diese andernfalls Vorrang hat.

Erweiterungen über eine Konfigurationsdatei installieren

Alternativ zum Eingabefeld können die Extension-IDs in einer Textdatei auf dem IServ-Server hinterlegt werden. Diese Vorgehensweise ist insbesondere bei einer größeren Anzahl an Erweiterungen geeignet.

Hinweis

Für den Zugriff auf die IServ-Freigabe sind entsprechende Berechtigungen erforderlich. Gegebenenfalls muss der verwendete Benutzeraccount Mitglied der IServ-Gruppe Admins sein.

  1. Erstellen Sie eine Textdatei mit dem Namen extensions.txt.

  2. Tragen Sie jede zu installierende Extension-ID in eine eigene Zeile ein. Verwenden Sie hier kein Pipe-Zeichen als Trennzeichen.

  3. Öffnen Sie im Windows-Explorer das Verzeichnis \\iserv\appdata\microsoft-vs-code.

  4. Kopieren Sie die Datei extensions.txt in dieses Verzeichnis.

  5. Starten Sie die Installation des Softwarepakets Microsoft Visual Studio Code erneut auf den gewünschten Clients.

Beispiel für den Inhalt der extensions.txt:

esbenp.prettier-vscode
dbaeumer.vscode-eslint
ms-python.python
extensions.txt mit drei Extension-IDs, jeweils in einer eigenen Zeile

Warnung

Sobald die Datei extensions.txt vorhanden ist, wird ausschließlich diese Datei für die Installation über Extension-IDs verwendet. Einträge im Feld Optionale Erweiterungen werden dann nicht berücksichtigt. Dies gilt auch bei einer leeren Datei.

Erweiterungen über VSIX-Dateien installieren

Einige Erweiterungen liegen als Installationsdateien im Format .vsix vor. Diese können beispielsweise verwendet werden, wenn eine Erweiterung nicht direkt über eine Extension-ID installiert werden soll oder als Datei bereitgestellt wird.

  1. Beschaffen Sie die passende VSIX-Datei aus einer vertrauenswürdigen Quelle.

  2. Öffnen Sie im Windows-Explorer die IServ-Freigabe \\iserv\appdata\microsoft-vs-code.

  3. Kopieren Sie die gewünschten Dateien mit der Endung .vsix direkt in dieses Verzeichnis.

  4. Starten Sie die Installation des Softwarepakets Microsoft Visual Studio Code erneut auf den gewünschten Clients.

Während der Installation werden alle im Verzeichnis gefundenen VSIX-Dateien auf den jeweiligen Client kopiert und anschließend über Visual Studio Code installiert.

IServ-Freigabe microsoft-vs-code mit mehreren VSIX-Dateien

Hinweis

VSIX-Dateien werden zusätzlich zu den Erweiterungen aus dem Eingabefeld oder der extensions.txt installiert. Die Existenz einer extensions.txt verhindert die VSIX-Installation nicht.

Warnung

Es werden alle VSIX-Dateien berücksichtigt, die direkt im angegebenen Verzeichnis liegen. Legen Sie dort deshalb nur die Erweiterungen ab, die auf den Clients installiert werden sollen. Achten Sie auf die Kompatibilität der Dateien mit der installierten Visual-Studio-Code-Version.

Kombination der Installationsmöglichkeiten

Die verschiedenen Möglichkeiten lassen sich wie folgt kombinieren:

Vorhandene Konfiguration

Berücksichtigte Extension-IDs

VSIX-Dateien

Nur Eingabefeld

Aus dem Eingabefeld

Keine, sofern nicht hinterlegt

Nur extensions.txt

Aus der Datei

Keine, sofern nicht hinterlegt

Eingabefeld und extensions.txt

Nur aus der Datei

Keine, sofern nicht hinterlegt

Eingabefeld und VSIX-Dateien

Aus dem Eingabefeld

Werden zusätzlich installiert

extensions.txt und VSIX-Dateien

Aus der Datei

Werden zusätzlich installiert

Alle drei Möglichkeiten

Nur aus der Datei

Werden zusätzlich installiert

Ein mögliches Verzeichnis mit einer Kombination aus Konfigurationsdatei und VSIX-Dateien sieht beispielsweise so aus:

\\iserv\appdata\microsoft-vs-code\
|-- extensions.txt
|-- beispiel-erweiterung-1.vsix
|-- beispiel-erweiterung-2.vsix

Hinweis

Die Erweiterungen werden bei der Installation in einem zentral verwalteten Erweiterungsverzeichnis auf dem Windows-Client abgelegt. Dadurch stehen die so installierten Erweiterungen über die vom Softwarepaket angelegten Programmverknüpfungen zur Verfügung.

Hinweise zur Installation und Aktualisierung

  • Die Erweiterungen werden im Rahmen der Installation des Softwarepakets Microsoft Visual Studio Code eingerichtet. Das bloße Ändern der Produkteigenschaft oder das Ablegen einer Datei auf der Freigabe installiert noch keine Erweiterungen auf bereits eingerichteten Clients.

  • Bei einer erneuten Installation löscht das Softwarepaket den Inhalt des zentral verwalteten Erweiterungsverzeichnisses C:\ProgramData\VSCode\extensions, sofern dieses vorhanden ist. Danach werden die konfigurierten Erweiterungen erneut installiert.

  • Manuell in diesem verwalteten Verzeichnis abgelegte Erweiterungen können dadurch entfernt werden. Persönliche, getrennt verwaltete Erweiterungsverzeichnisse der Benutzer sind hiervon nicht ausdrücklich erfasst.

  • Zur Installation anhand einer Extension-ID muss die Erweiterung für den jeweiligen Client erreichbar sein. Für VSIX-Dateien wird dagegen die zuvor in der Freigabe hinterlegte Datei verwendet.

  • Schlägt die Installation einer Erweiterung fehl, kann dadurch die gesamte Softwarepaketinstallation als fehlgeschlagen gemeldet werden.

Warnung

Prüfen Sie vor der Verteilung einer größeren Anzahl an Erweiterungen die Funktion auf einem Testclient. Fehlerhafte Extension-IDs, nicht erreichbare Quellen oder inkompatible VSIX-Dateien können die Installation verhindern.