Wie man dateispezifische Einstellungen in Vim mit Modeline ändert

Während Plugins zweifellos eine der größten Stärken von Vim sind, machen mehrere andere Funktionen es zu einem der leistungsstärksten und funktionsreichsten Texteditoren/IDEs, die Linux-Nutzern heute zur Verfügung stehen. Eine dieser Funktionen ist die Möglichkeit, dateispezifische Einstellungen zu ändern. Diese Fähigkeit kann über die Modeline-Funktion des Editors aufgerufen werden.

In diesem Artikel werden wir besprechen, wie Sie die Modeline-Funktion von Vim anhand leicht verständlicher Beispiele nutzen können.

Aber bevor wir damit beginnen, ist es erwähnenswert, dass alle in diesem Tutorial genannten Beispiele, Befehle und Anweisungen auf Ubuntu 16.04 - Ubuntu 22.04 getestet wurden.

VIM Modeline

Verwendung

Wie bereits erwähnt, ermöglicht die Modeline-Funktion von Vim, dateispezifische Änderungen vorzunehmen. Angenommen, Sie möchten alle in einer bestimmten Datei Ihres Projekts verwendeten Tabs durch Leerzeichen ersetzen und sicherstellen, dass alle anderen Dateien von dieser Änderung nicht betroffen sind. Dies ist ein ideales Anwendungsbeispiel, bei dem Ihnen die Modeline hilft, was Sie tun möchten.

Was Sie tun können, ist, die folgende Zeile am Anfang oder Ende der betreffenden Datei einzufügen:

# vim: set expandtab:

Es besteht eine hohe Wahrscheinlichkeit, dass, wenn Sie versuchen, die oben genannte Übung durchzuführen, um den Anwendungsfall auf Ihrem Linux-Rechner zu testen, die Dinge nicht wie erwartet funktionieren. Wenn das der Fall ist, machen Sie sich keine Sorgen, da die Modeline-Funktion in einigen Fällen zuerst aktiviert werden muss (sie ist aus Sicherheitsgründen standardmäßig auf Systemen wie Debian, Ubuntu, Gentoo und OSX deaktiviert).

Um die Funktion zu aktivieren, öffnen Sie die .vimrc-Datei (die sich in Ihrem Home-Verzeichnis befindet) und fügen Sie dann die folgende Zeile hinzu:

set modeline

Jetzt, wann immer Sie einen Tabulator eingeben und die Datei speichern (wo der expandtab Modeline-Befehl eingegeben wurde), wird der Tabulator automatisch in Leerzeichen umgewandelt.

Betrachten wir ein weiteres Anwendungsbeispiel. Angenommen, der Standard-Tabulator in Vim ist auf 4 eingestellt, aber für eine bestimmte Datei möchten Sie ihn auf 8 erhöhen. Dazu müssen Sie die folgende Zeile am Anfang oder Ende der Datei hinzufügen:

// vim: noai:ts=8:

Versuchen Sie jetzt, einen Tabulator einzugeben, und Sie werden sehen, dass die Anzahl der abgedeckten Leerzeichen 8 beträgt.

Sie haben vielleicht bemerkt, dass ich gesagt habe, dass diese Modeline-Befehle irgendwo in der Nähe des oberen oder unteren Teils der Datei eingegeben werden müssen. Wenn Sie sich fragen, warum das so ist, liegt der Grund darin, dass die Funktion so konzipiert ist. Die folgenden Zeilen (aus der offiziellen Vim-Dokumentation) sollten dies klarer machen:

“ Die Modeline kann nicht irgendwo in der Datei sein: sie muss in den ersten oder letzten paar Zeilen sein. Der genaue Ort, an dem Vim nach der Modeline sucht, wird durch die Variable modelines gesteuert; siehe :help modelines . Standardmäßig ist sie auf 5 Zeilen eingestellt*.”

Und hier ist, was der Befehl :help modelines (auf den in den obigen Zeilen verwiesen wird) sagt:

Wenn 'modeline' aktiviert ist, gibt 'modelines' die Anzahl der Zeilen an, die auf Set-Befehle überprüft werden. Wenn 'modeline' deaktiviert ist oder 'modelines' null ist, werden keine Zeilen überprüft.

Versuchen Sie, den Modeline-Befehl über die standardmäßigen 5 Zeilen (entweder von unten oder von oben) hinaus zu setzen, und Sie werden feststellen, dass die Tabulatoren auf den Vim-Standard zurückgesetzt werden - in meinem Fall sind das 4 Leerzeichen.

Sie können dieses Verhalten jedoch ändern, wenn Sie möchten, indem Sie den folgenden Befehl in Ihrer .vimrc-Datei verwenden.

set modelines=[neuer-wert]

Zum Beispiel habe ich den Wert von 5 auf 10 erhöht.

set modelines=10

Das bedeutet, dass ich jetzt den Modeline-Befehl irgendwo zwischen den ersten oder letzten 10 Zeilen der Datei setzen kann.

Wenn Sie während der Bearbeitung einer Datei zu irgendeinem Zeitpunkt die aktuellen modeline-bezogenen Einstellungen sowie den letzten Ort, an dem sie gesetzt wurden, sehen möchten, können Sie Folgendes eingeben (im Befehlsmodus des Vim-Editors):

:verbose set modeline? modelines?

Zum Beispiel ergab der obige Befehl in meinem Fall die folgende Ausgabe:

 modeline  
      Zuletzt gesetzt von ~/.vimrc  
 modelines=10  
      Zuletzt gesetzt von ~/.vimrc

Hier sind einige wichtige Punkte, die Sie über die Modeline-Funktion von Vim wissen sollten:

• Diese Funktion ist standardmäßig für Vim im nocompatible (nicht Vi-kompatiblen) Modus aktiviert, aber einige bemerkenswerte Distributionen von Vim deaktivieren diese Option in der systemweiten vimrc aus Sicherheitsgründen.
• Die Funktion ist standardmäßig deaktiviert, wenn Sie als Root bearbeiten (wenn Sie die Datei mit ‘sudo’ geöffnet haben, gibt es kein Problem - die Funktion funktioniert).
• Mit ‘ set‘ endet die Modeline am ersten Doppelpunkt, der nicht auf einen Backslash folgt. Und ohne ‘ set‘ kann kein Text den Optionen folgen. Zum Beispiel ist / vim: noai:ts=4:sw=4 / eine ungültige Modeline.

Sicherheitsbedenken

Leider kann die Modeline-Funktion von Vim verwendet werden, um die Sicherheit zu gefährden. Tatsächlich wurden in der Vergangenheit mehrere sicherheitsrelevante Modeline-Probleme gemeldet, darunter Shell-Befehlsinjektion, Ausführung beliebiger Befehle, unbefugter Zugriff und mehr. Zugegeben, die meisten davon sind alt und wären mittlerweile behoben worden, aber es gibt einen Hinweis darauf, dass die Modeline-Funktion von Hackern missbraucht werden könnte.

Fazit

Modeline mag eine fortgeschrittene Funktion des Vim-Editors sein, aber sie ist nicht sehr schwer zu verstehen. Es besteht kein Zweifel, dass es eine gewisse Lernkurve gibt, aber das ist nicht viel verlangt, angesichts wie nützlich die Funktion ist. Natürlich gibt es Sicherheitsbedenken, was bedeutet, dass Sie Ihre Optionen abwägen sollten, bevor Sie die Funktion aktivieren und verwenden.

Haben Sie jemals die Modeline-Funktion verwendet? Wie war Ihre Erfahrung? Teilen Sie uns (und der gesamten HowtoForge-Community) in den Kommentaren unten mit.