So verwenden Sie einen geschlossenen Linter

Hinweis: Closure Linter ist veraltet und wird bei Google kaum noch verwendet. Weitere Informationen finden Sie auf dieser Seite.

In diesem Dokument wird beschrieben, wie Sie Closure Linter installieren und verwenden.

Closure Linter installieren

Verwenden Sie das Python-Dienstprogramm pip, um Closure Linter herunterzuladen und zu 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.

Probleme mit Stilen finden

So führen Sie den Closure Linter für eine einzelne Datei aus:

$ 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 ein ganzes Verzeichnis rekursiv prüfen:

$ gjslint -r path/to/my/directory

Standardmäßig prüft der Closure Linter, ob die richtigen JsDoc-Anmerkungen vorhanden sind. Wenn Sie nicht nach fehlenden JsDoc-Anmerkungen in Ihrem Projekt suchen möchten, deaktivieren Sie die Prüfung so:

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

Mit diesem Flag werden zwar Prüfungen auf fehlende JsDoc-Annotationen deaktiviert, der Linter prüft aber weiterhin, ob vorhandene JsDoc-Annotationen korrekt verwendet werden.

Das Flag „--strict“

Wenn Sie möchten, dass Closure Linter strengere Stilregeln wie Abstände, JsDoc-Typen und Autortags verwendet, verwenden Sie das Befehlszeilenflag --strict. Wenn Sie Code für die Closure-Bibliothek beitragen, müssen Sie --strict verwenden.

Stilprobleme beheben

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

Beispiel:

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

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