Jak korzystać z Linter

Uwaga: narzędzie Closure Linter zostało wycofane i jest już rzadko używane w Google. Więcej informacji znajdziesz na tej stronie.

W tym dokumencie opisujemy, jak zainstalować i używać narzędzia Closure Linter.

Instalowanie narzędzia Closure Linter

Użyj narzędzia pip w Pythonie, aby pobrać i zainstalować Closure Linter.

Linux

Aby zainstalować narzędzie Closure Linter w systemie Linux, wykonaj te polecenia:

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

Mac OS X

Aby zainstalować narzędzie Closure Linter w systemie Mac OS X, wykonaj to polecenie:

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

Windows

Aby zainstalować narzędzie Closure Linter w systemie Windows:

  1. Pobierz i zainstaluj Pythona dla Windowsa.
  2. Uruchom to polecenie:
> pip install https://github.com/google/closure-linter/zipball/master

Uwaga: obsługa narzędzia Closure Linter w systemie Windows jest eksperymentalna.

Znajdowanie problemów ze stylem

Aby uruchomić narzędzie Closure Linter na jednym pliku, spróbuj:

$ gjslint path/to/my/file.js

Powinny pojawić się wyniki podobne do tych:

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 ":"

Możesz też rekursywnie sprawdzić cały katalog, np. tak:

$ gjslint -r path/to/my/directory

Domyślnie narzędzie Closure Linter sprawdza, czy występują prawidłowe adnotacje JsDoc. Jeśli nie chcesz sprawdzać w projekcie brakujących adnotacji JsDoc, wyłącz to sprawdzanie w ten sposób:

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

Chociaż ta flaga wyłącza sprawdzanie brakujących adnotacji JsDoc, linter nadal weryfikuje, czy istniejące adnotacje JsDoc są używane prawidłowo.

Flaga --strict

Jeśli chcesz, aby narzędzie Closure Linter bardziej rygorystycznie sprawdzało reguły stylu, takie jak odstępy, typy JsDoc i tagi autora, użyj flagi wiersza poleceń --strict. Jeśli przesyłasz kod do biblioteki Closure, musisz użyć tagu --strict.

Rozwiązywanie problemów ze stylem

W dowolnym z powyższych poleceń możesz zastąpić fixjsstyle znakiem gjslint, aby automatycznie naprawić wiele błędów sprawdzanych przez polecenie fixjsstyle.gjslint

Na przykład:

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

Przed użyciem fixjsstyle utwórz kopię zapasową plików lub zapisz je w systemie kontroli wersji, aby w razie wprowadzenia przez skrypt niechcianych zmian móc je przywrócić.