Nützliche Vim-Editor-Plugins für Softwareentwickler – Teil 2: Syntastic

Es besteht kein Zweifel, dass Vim ein leistungsfähiger Programmiereditor ist, aber es sind die Plugins des Editors, die Ihnen helfen, das Beste aus ihm herauszuholen. Im ersten Teil dieser Artikelserie haben wir ein paar programmbezogene Vim-Plugins (Tagbar und delimitMate) diskutiert. Auf dem gleichen Weg, in diesem Artikel, werden wir ein weiteres nützliches Vim-Plugin diskutieren, das sich an Softwareentwickler richtet – Syntastic.

Synthastic

Wenn Ihre Softwareentwicklung mit Sprachen wie C und C++ arbeitet, ist es selbstverständlich, dass die Behebung von Kompilierzeitfehlern Teil Ihrer täglichen Arbeit sein würde. Oftmals entstehen Kompilierungsfehler durch falsche Syntax im Quellcode, da Entwickler diese beim Betrachten des Codes nicht beachten.

Was passiert, wenn ich Ihnen sage, dass es ein Vim-Plugin gibt, das Informationen über Syntaxfehler liefert, ohne dass Sie Ihren Code kompilieren müssen? Ja, ein solches Plugin existiert, und sein Name ist Syntastisch.

„Syntastic ist ein Plugin zur Syntaxprüfung für Vim, das Dateien über externe Syntaxprüfer ausführt und dem Benutzer alle daraus resultierenden Fehler anzeigt. Dies kann auf Anfrage oder automatisch beim Speichern von Dateien erfolgen“, heißt es in der offiziellen Dokumentation des Plugins. „Wenn Syntaxfehler erkannt werden, wird der Benutzer benachrichtigt und ist zufrieden, weil er seinen Code nicht kompilieren oder sein Skript ausführen musste, um ihn zu finden.“

Die Installation dieses Plugins ist ähnlich wie bei der Installation derjenigen, die im ersten Teil besprochen wurden – alles, was Sie tun müssen, ist, die folgenden Befehle auszuführen:

cd ~/.vim/bundle/
git clone https://github.com/scrooloose/syntastic.git

Sobald das Plugin erfolgreich installiert wurde (d.h. die obigen Befehle sind erfolgreich), müssen Sie nichts weiter tun – es wird automatisch geladen, wenn der Vim-Editor gestartet wird.

Um das Plugin zu verwenden, öffnen Sie nun eine Quellcodedatei und speichern Sie sie mit dem Befehl :w Vim. Nach einer sehr kurzen Pause werden Sie feststellen, dass Syntaxfehler – falls vorhanden – in Ihrem Code markiert werden. Der folgende Screenshot soll Ihnen beispielsweise eine Vorstellung davon geben, wie das Plugin die Fehler hervorhebt:

Vim Syntaxfehler-Hervorhebung

Das Zeichen „>>“ am Anfang einer Zeile zeigt an, dass es ein Problem mit dem in dieser Zeile geschriebenen Code gibt. Um zu wissen, was genau der Fehler ist, oder zumindest eine grobe Vorstellung davon zu bekommen, bringen Sie den Cursor auf diese Zeile – die Fehlerbeschreibung wird unten im Vim-Fenster angezeigt.

Syntaxfehler in Vim anzeigen

Auf diese Weise können Sie die meisten syntaxbedingten Fehler beheben, ohne den Code überhaupt zu kompilieren.

Wenn Sie den Befehl :Errors ausführen, wird die Beschreibung aller syntaxbedingten Fehler in der aktuellen Quelldatei angezeigt. Wenn ich beispielsweise den Befehl :Errors in meinem Fall ausführe, werden die folgenden Informationen angezeigt:

Syntastischer :Errors Befehl

Beachten Sie, dass die Informationen, die der Befehl :Errors anzeigt, nicht automatisch aktualisiert werden, d.h. auch nach der Behebung eines Fehlers wird die Beschreibung im unteren Bereich angezeigt, bis Sie den Befehl :Errors erneut ausführen.

Erwähnenswert ist, dass es viele Konfigurationsmöglichkeiten gibt, die Syntastic noch benutzerfreundlicher machen. Sie können beispielsweise die folgende Zeile in Ihre .vimrc-Datei einfügen, wenn Sie möchten, dass der Befehl :Errors die Ausgabe automatisch aktualisiert, wenn ein Fehler behoben wird:

let g:syntastic_always_populate_loc_list = 1

Eine weitere wichtige Einschränkung, die das standardmäßige Syntastic-Verhalten hat, ist, dass Sie den Befehl :w ausführen müssen, um das Plugin dazu zu bringen, fehlerhafte Zeilen anzuzeigen – das ist beim Bearbeiten einer Datei in Ordnung, wird aber ein wenig seltsam, wenn Sie gerade eine Quelldatei geöffnet haben.

Um sicherzustellen, dass Syntastic die Fehler beim Öffnen einer Datei automatisch markiert, fügen Sie die folgende Zeile zu Ihrer .vimrc-Datei hinzu:

let g:syntastic_check_on_open = 1

Wenn Sie möchten, dass der Cursor beim Speichern oder Öffnen einer Datei zum ersten erkannten Problem springt, fügen Sie die folgende Zeile in Ihre .vimrc-Datei ein:

let g:syntastic_auto_jump = 1

Es gibt zwei weitere Werte, die Sie der oben genannten Variable zuweisen können: 2 und 3. Hier ist, was die offizielle Dokumentation über diese beiden Werte sagt:

„Bei Einstellung auf 2 springt der Cursor zum ersten erkannten Problem, aber nur, wenn es sich um einen Fehler handelt“, und „bei Einstellung auf 3 springt der Cursor zum ersten erkannten Fehler, falls vorhanden. Wenn alle erkannten Probleme Warnungen sind, springt der Cursor nicht.“

Die folgenden Informationen sollten auch für Sie von Nutzen sein:

„Verwenden Sie :SyntasticCheck, um manuell nach Fehlern zu suchen“. “ Verwenden Sie :Errors, um das Fenster der Standortliste zu öffnen, und :lclose, um es zu schließen. Sie können die Fehlerliste mit :SyntasticReset löschen und mit :SyntasticToggleMode zwischen aktiver (Überprüfung beim Schreiben des Puffers) und passiver (manueller) Prüfung wechseln.“

Hinweis: Syntastic ist nicht nur auf Code beschränkt, der in C und C++ geschrieben wurde. Es unterstützt auch eine riesige Liste anderer Programmiersprachen – siehe hier, um mehr darüber zu erfahren.

Fazit

Syntastic ist zweifellos ein sehr nützliches Vim-Plugin, da es Ihnen den Aufwand einer häufigen Kompilierung erspart, wenn es um syntaxbezogene Fehler geht. Und nicht zu vergessen, dass auch viel Zeit gespart wird.

Wie Sie bemerkt haben, wird Syntastic noch nützlicher, wenn Sie einige seiner wichtigsten Optionen konfiguriert haben. Um Ihnen den Einstieg zu erleichtern, enthält die offizielle Dokumentation einen Abschnitt „Empfohlene Einstellungen“ – gehen Sie diese durch. Es gibt auch einen netten kleinen FAQ-Bereich, falls Sie auf Fehler stoßen oder Zweifel oder Fragen haben.

Das könnte Dich auch interessieren …