VS-Code-Extension im Marketplace veröffentlichen mit vsce

Eine VS-Code-Extension veröffentlichen Sie mit dem offiziellen Kommandozeilenwerkzeug vsce. Sie brauchen dafür einen Publisher im Visual Studio Marketplace und ein Zugriffstoken. Nach vsce login lädt vsce publish die Extension hoch, und nach einer kurzen automatischen Prüfung ist sie in VS Code auffindbar. Wer auch Editoren erreichen will, die nicht auf den Microsoft-Marketplace zugreifen, veröffentlicht dieselbe Extension zusätzlich auf Open VSX.

Wie Sie die Extension selbst bauen, zeigt der Artikel VS-Code-Extension erstellen mit Yeoman.

Der Ablauf im Überblick

1. vsce installieren
2. Zugriffstoken erstellen in Azure DevOps
3. Publisher anlegen im Marketplace
4. package.json und README vorbereiten
5. Lokal paketieren und testen mit vsce package
6. Veröffentlichen mit vsce publish
7. Optional: zusätzlich auf Open VSX

Schritt 1: vsce installieren

npm install --global @vscode/vsce

Alternativ nehmen Sie das Paket als Entwicklungsabhängigkeit ins Projekt auf und rufen es über npx vsce auf. Das hat den Vorteil, dass alle Beteiligten und die CI dieselbe Version nutzen. Das ältere Paket ohne den Namensraum @vscode sollten Sie nicht mehr verwenden.

Schritt 2: Zugriffstoken erstellen

Der Marketplace nutzt zur Authentifizierung Azure DevOps. So erstellen Sie ein persönliches Zugriffstoken (Personal Access Token):

1. Mit einem Microsoft-Konto bei Azure DevOps anmelden und, falls noch nicht vorhanden, eine Organisation anlegen.
2. In den Benutzereinstellungen „Personal access tokens“ öffnen und ein neues Token erstellen.
3. Bei der Organisation „All accessible organizations“ wählen.
4. Unter den Berechtigungen den Bereich „Marketplace“ mit dem Recht „Manage“ aktivieren.
5. Ablaufdatum festlegen und das Token sofort sicher speichern, es wird nur einmal angezeigt.

Die häufigste Fehlerquelle sind ein falscher Organisationsbereich oder fehlende Marketplace-Rechte. Dann meldet vsce einen Autorisierungsfehler. Microsoft passt die Anmeldeverfahren für Azure DevOps immer wieder an. Prüfen Sie deshalb in der aktuellen Dokumentation, ob für Ihr Konto inzwischen auch eine Anmeldung ohne persönliches Token, etwa über Azure-Anmeldedaten, vorgesehen ist.

Schritt 3: Publisher anlegen

Ein Publisher ist die Identität, unter der Ihre Extensions erscheinen. Sie legen ihn auf der Verwaltungsseite des Visual Studio Marketplace mit demselben Microsoft-Konto an. Die Publisher-ID ist dauerhaft und Teil der Extension-Kennung, etwa meinpublisher.wortzaehler. Den Anzeigenamen können Sie später ändern.

Anschließend melden Sie sich in der Kommandozeile an:

vsce login meinpublisher

vsce fragt nach dem Token und speichert es lokal. Optional können Sie den Publisher mit einer eigenen Domain verifizieren lassen. Ihr Eintrag erhält dann ein Verifizierungszeichen, was Vertrauen schafft.

Schritt 4: package.json und README vorbereiten

Diese Felder sollten vor der ersten Veröffentlichung gesetzt sein:

Die README.md wird zur Detailseite im Marketplace. Beschreiben Sie Funktionen, Befehle, Einstellungen und bekannte Einschränkungen, gern mit Screenshots oder animierten Bildern. Bilder müssen über HTTPS eingebunden sein. SVG-Grafiken akzeptiert der Marketplace in der README nur eingeschränkt, etwa von bekannten Badge-Diensten. Die CHANGELOG.md erscheint als eigener Reiter.

Welche Lizenz zu Ihrer Extension passt, erklärt der Artikel Open-Source-Lizenz für Plugins wählen.

Was ins Paket gehört

Die Datei .vscodeignore bestimmt, was nicht ins Paket kommt, ähnlich wie .gitignore. Typische Einträge sind Quellcode bei gebündelten Extensions, Testdateien, Konfigurationsdateien und node_modules, wenn ein Bundler alle Abhängigkeiten einbaut. Mit vsce ls sehen Sie vorab, welche Dateien im Paket landen würden.

Schritt 5: Lokal paketieren und testen

vsce package

Der Befehl erzeugt eine Datei wie wortzaehler-1.0.0.vsix. Installieren Sie sie in einer normalen VS-Code-Instanz über die Erweiterungsansicht („Aus VSIX installieren …“) oder per Kommandozeile mit code --install-extension wortzaehler-1.0.0.vsix. So prüfen Sie, ob die Extension auch außerhalb der Entwicklungsumgebung funktioniert, insbesondere wenn ein Bundler im Spiel ist.

Eine .vsix-Datei eignet sich auch, um Extensions intern weiterzugeben, ohne sie öffentlich zu machen.

Schritt 6: Veröffentlichen

vsce publish

vsce paketiert die Extension erneut und lädt sie hoch. Die Version können Sie direkt mit erhöhen lassen:

vsce publish patch   # 1.0.0 -> 1.0.1
vsce publish minor   # 1.0.0 -> 1.1.0
vsce publish 2.0.0   # feste Version

Dabei passt vsce die package.json an und legt, sofern ein Git-Repository vorhanden ist, einen Commit mit Tag an. Nach dem Upload prüft der Marketplace das Paket automatisch. Meist ist die Extension nach wenigen Minuten in der Suche zu finden.

Vorabversionen

Mit vsce publish --pre-release veröffentlichen Sie eine Vorabversion. Nutzer können in VS Code gezielt auf diese Version wechseln. Da der Marketplace nur Versionen im Format Major.Minor.Patch kennt, empfiehlt die Dokumentation eine Konvention, etwa gerade Minor-Versionen für reguläre Releases und ungerade für Vorabversionen.

Automatisch veröffentlichen per CI

vsce liest das Token aus der Umgebungsvariable VSCE_PAT. In GitHub Actions oder anderen CI-Systemen hinterlegen Sie es als geheime Variable und führen bei einem neuen Tag npx vsce publish aus. Das sorgt für reproduzierbare Releases und verhindert, dass versehentlich lokale Dateien ins Paket geraten. Das Ablaufdatum des Tokens sollten Sie sich notieren, sonst schlägt die nächste Veröffentlichung überraschend fehl.

Zusätzlich auf Open VSX veröffentlichen

Open VSX ist ein herstellerunabhängiges Verzeichnis unter dem Dach der Eclipse Foundation. Viele Editoren auf VS-Code-Basis beziehen ihre Extensions von dort, weil die Nutzungsbedingungen des Microsoft-Marketplace dessen Verwendung auf Microsoft-Produkte beschränken.

So veröffentlichen Sie dort:

1. Mit einem GitHub-Konto bei open-vsx.org anmelden und die Publisher-Vereinbarung der Eclipse Foundation akzeptieren.
2. In den Einstellungen ein Zugriffstoken erzeugen.
3. Einmalig einen Namensraum anlegen, der Ihrer Publisher-ID entspricht: npx ovsx create-namespace meinpublisher -p <token>.
4. Veröffentlichen: npx ovsx publish -p <token> oder eine fertige Datei mit npx ovsx publish wortzaehler-1.0.0.vsix -p <token>.

In der CI liest ovsx das Token aus der Variable OVSX_PAT. Am einfachsten ist es, die .vsix einmal zu bauen und dieselbe Datei an beide Verzeichnisse zu übergeben.

Nach der Veröffentlichung

• Statistiken prüfen: Die Verwaltungsseite zeigt Installationen und Bewertungen.
• Issues pflegen: Verlinken Sie in package.json über bugs Ihren Issue-Tracker, damit Fehlerberichte dort landen.
• Kompatibilität im Blick behalten: VS Code erscheint in kurzen Abständen. Testen Sie regelmäßig mit der Insiders-Version.
• Zurückziehen bei Bedarf: vsce unpublish meinpublisher.wortzaehler entfernt die Extension vollständig.

Allgemeine Fragen zu Stores, Lizenzen und Pflege über die Jahre behandelt der Bereich Add-ons veröffentlichen und pflegen.