So verwenden Sie einen geschlossenen Linter

Hinweis: Die Schließung von Linter wurde verworfen und wird innerhalb von Google nur noch selten verwendet. Weitere Informationen

In diesem Dokument wird die Installation und Verwendung von Closure Linter beschrieben.

Schließen von Linter

Mit dem Python-Dienstprogramm pip können Sie Closure Linter herunterladen und installieren.

Linux

Führen Sie die folgenden Befehle aus, um Closure Linter unter Linux zu installieren:

$ sudo apt-get install python-pip
$ sudo pip install https://github.com/google/closure-linter/zipball/master

Mac OS X

Führen Sie den folgenden Befehl aus, um Closure Linter unter Mac OS X zu installieren:

$ sudo easy_install pip
$ sudo pip install https://github.com/google/closure-linter/zipball/master

Windows

So installieren Sie Closure Linter unter Windows:

  1. Laden Sie Python für Windows herunter und installieren Sie es.
  2. Führen Sie folgenden Befehl aus:
> pip install https://github.com/google/closure-linter/zipball/master

Hinweis: Die Windows-Unterstützung für Closure Linter ist experimentell.

Stilprobleme finden

Wenn Sie den Closure Linter für eine einzelne Datei ausführen möchten, versuchen Sie Folgendes:

$ gjslint path/to/my/file.js

Das Ergebnis sollte so aussehen:

Line 46, E:0110: Line too long (87 characters).
Line 54, E:0214: Missing description in @return tag
Line 66, E:0012: Illegal semicolon after function declaration
Line 150, E:0120: Binary operator should go on previous line "+"
Line 175, E:0011: Missing semicolon after function assigned to a variable
Line 210, E:0121: Illegal comma at end of array literal
Line 220, E:0002: Missing space before ":"

Sie können auch rekursiv ein ganzes Verzeichnis prüfen:

$ gjslint -r path/to/my/directory

Der Closure Linter prüft standardmäßig, ob korrekte JsDoc-Annotationen vorhanden sind. Wenn Sie in Ihrem Projekt nicht auf fehlende JsDoc-Annotationen prüfen möchten, deaktivieren Sie die Prüfung so:

$ gjslint --nojsdoc -r path/to/my/directory

Obwohl dieses Flag die Prüfung auf fehlende JsDoc-Annotationen deaktiviert, überprüft der Linter noch immer, ob JsDoc-Annotationen korrekt verwendet werden.

--strict-Flag

Wenn Sie möchten, dass Closure Linter Stilregeln wie Abstände, JsDoc-Typen und Autoren-Tags strenger verfolgt, verwenden Sie das Befehlszeilen-Flag --strict. Sie müssen --strict verwenden, wenn Sie Code zur Closure Library beitragen.

Stilprobleme beheben

In jedem der oben genannten Befehle können Sie gjslint durch fixjsstyle ersetzen, um viele der Fehler, die von gjslint geprüft werden, automatisch zu beheben.

Beispiel:

$ fixjsstyle path/to/file1.js path/to/file2.js

Sichern Sie Ihre Dateien oder speichern Sie sie in einem Versionsverwaltungssystem, bevor Sie fixjsstyle verwenden, falls das Skript Änderungen vornimmt, die Sie nicht vornehmen möchten.