Create a Formatter Extension for VSCode
Zusammenfassung
Kurz
Der vollständige Artikel führt durch den Aufbau einer einfachen VS-Code-Formatter-Erweiterung: Projektgenerator, Manifest, Formatierungsprovider und Aktivierung über `onLanguage`. Das Beispiel fügt einen Kommentar ein und zeigt eine optionale Ein/Aus-Einstellung, die der Provider bei jedem Formatierungsaufruf prüft; produktionsreife Formatierlogik oder umfassende Tests behandelt der Beitrag nicht.
Mittel
Der vollständige Artikel zeigt, wie eine einfache Formatter-Erweiterung für Visual Studio Code entsteht. Nach dem Erzeugen eines Projekts mit dem VS-Code-Erweiterungsgenerator und der Installation der Abhängigkeiten stellt der Autor wichtige Manifest-Felder sowie die Funktionen `activate` und `deactivate` vor. Die Formatierung wird über `registerDocumentFormattingEditProvider` und einen `DocumentSelector` bereitgestellt. Das Beispiel fügt einen Kommentar am Dokumentanfang ein, falls er noch fehlt.
Der Beitrag erläutert außerdem, dass der Formatter erst verfügbar ist, wenn die Erweiterung aktiviert wurde. Als passende Möglichkeit empfiehlt der Autor `onLanguage`, damit die Erweiterung bei Bedarf für ausgewählte oder beliebige Sprachen startet. Für die Manifest-Kategorie soll „Formatters“ eingetragen werden. Optional lässt sich über `contributes.configuration` eine Ein/Aus-Einstellung anbieten. Der Artikel prüft diese Einstellung beim Formatieren, damit Änderungen sofort wirksam werden, da `activate` beim Ändern der Konfiguration nicht erneut aufgerufen wird. Als Grund für die Einstellung nennt der Autor mögliche Konflikte, wenn mehrere Formatter dieselbe Sprache bearbeiten. Die Umsetzung bleibt ein Demonstrationsbeispiel; eine produktionsreife Formatierlogik und umfassende Tests werden nicht behandelt.
Ausführlich lesen
Der vollständige Artikel von Itsuki erklärt anhand eines einfachen Beispiels, wie sich eine Formatter-Erweiterung für Visual Studio Code erstellen lässt. Als Ausgangspunkt empfiehlt er, mit dem Befehl `npx --package yo --package generator-code -- yo code` ein Erweiterungsprojekt anzulegen und anschließend dessen Abhängigkeiten mit `npm install` zu installieren. Vor dem Ausführen soll geprüft werden, ob die in `package.json` angegebene VS-Code-Version zur installierten Version passt. Der Artikel zeigt außerdem, wie sich die erzeugte Erweiterung mit F5 in einem Development-Host-Fenster starten und der zunächst enthaltene „Hello World“-Befehl ausprobieren lässt.
Zur Einordnung des Projekts beschreibt der Autor `package.json` als Erweiterungsmanifest. Darin stehen sowohl übliche Node.js-Angaben als auch VS-Code-spezifische Felder. `publisher` und `name` bilden laut Artikel die eindeutige Erweiterungskennung; zum Veröffentlichen sei ein Publisher-Eintrag erforderlich. `main` verweist auf den Einstiegspunkt. In `extension.ts` wird die Erweiterung mit `activate` aktiviert und ihre Funktionen werden registriert; `deactivate` dient der Bereinigung und sei meist nicht nötig. Registrierte Befehle müssen laut Artikel eine zur Manifest-Angabe passende Kennung haben, und dieselbe Befehlskennung dürfe nicht doppelt registriert werden.
Für die Formatierung nennt der Beitrag drei Schritte: einen `DocumentFormattingEditProvider` registrieren und dessen Logik implementieren, die Kategorie „Formatters“ im Manifest eintragen und optional eine Einstellung zum Ein- und Ausschalten anbieten. Der Provider wird über `vscode.languages.registerDocumentFormattingEditProvider` registriert. Ein `DocumentSelector` legt fest, für welche Dokumente er gilt; `provideDocumentFormattingEdits` erhält unter anderem das Dokument, Formatierungsoptionen und ein Abbruchsignal und liefert Textänderungen oder ein asynchrones Ergebnis zurück. Das Beispiel wählt Dateien mit dem Schema `file` und beliebiger Sprache aus und fügt am Dokumentanfang einen Kommentar ein, sofern dieser dort noch nicht steht.
Ein weiterer Schwerpunkt ist die Aktivierung: Im Beispiel wird der Formatter zunächst erst aktiv, nachdem der „Hello World“-Befehl ausgeführt wurde. Der Artikel führt dies auf die Aktivierungsereignisse im Manifest zurück und empfiehlt, die Erweiterung nur bei Bedarf zu starten. Als Möglichkeit zeigt er `onLanguage`, entweder für bestimmte Sprachen oder allgemein. Für eigene, im Manifest definierte Sprachen sei laut Beitrag seit VS Code 1.74 keine entsprechende Aktivierungsangabe erforderlich.
Abschließend empfiehlt der Autor eine konfigurierbare Aktivierung des Formatters, weil mehrere Formatter für dieselbe Sprache miteinander in Konflikt geraten könnten. Die Prüfung der Einstellung erfolgt im Formatierungsaufruf, damit Änderungen sofort greifen; `activate` werde beim Ändern der Einstellung nicht erneut ausgeführt. Der Beitrag behandelt die Umsetzung an einem Demonstrationsbeispiel. Er erläutert keine produktionsreife Formatierlogik, umfassende Fehlerbehandlung oder Tests; seine Aussagen zu Versions- und Aktivierungsverhalten werden im Text nicht unabhängig überprüft.
Gegengeprüft von Claude Haiku 5.5: kleine Mängel
Es wurden keine Fragen zur Einordnung angegeben, daher ist die Liste leer. Die Zusammenfassung wurde als mittlere Fassung geprüft. Die kurze Fassung enthält dieselbe nicht belegte Aussage zum Umfang und ist sonst inhaltlich treu.
In der Zusammenfassung, laut Prüfung nicht im Bericht belegt
- Die Aussage, produktionsreife Formatierlogik und umfassende Tests würden nicht behandelt, steht so nicht im Bericht; der Bericht nennt das Beispiel lediglich als Demo
Wie die Modelle den Bericht einordnen
Ansicht
Filter
Kein Modell sieht bei diesem Bericht einen Bezug zu einer der 44 Sammelfragen.