Uwaga: aplikacja Closure Linter została wycofana i rzadko jest używana w Google. Więcej informacji znajdziesz na tej stronie
Ten dokument opisuje, jak zainstalować i używać Closure Linter.
Zainstaluj Linter
Użyj narzędzia Python pip, aby pobrać i zainstalować Closure Linter.
Linux
Aby zainstalować Closure Linter w Linuksie, 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ć 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ć Closure Linter w systemie Windows:
- Pobierz i zainstaluj Pythona na urządzenia z systemem Windows.
- Uruchom to polecenie:
> pip install https://github.com/google/closure-linter/zipball/master
Uwaga: obsługa Windows Closure Linter jest w fazie eksperymentalnej.
Problemy ze stylem
Aby uruchomić aplikację Closure Linter w jednym pliku, wykonaj te czynności:
$ gjslint path/to/my/file.js
Powinny pojawić się takie wyniki:
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ż cyklicznie sprawdzać cały katalog, na przykład:
$ gjslint -r path/to/my/directory
Domyślnie aplikacja Closure Linter sprawdza, czy znajdują się prawidłowe adnotacje JsDoc. Jeśli nie chcesz sprawdzać, czy w projekcie brakuje adnotacji JsDoc, wyłącz ten selektor:
$ gjslint --nojsdoc -r path/to/my/directory
Ta flaga wyłącza sprawdzanie brakujących adnotacji JsDoc, ale operator sprawdza, czy istniejące adnotacje JsDoc są używane poprawnie.
Flaga --strict
Jeśli chcesz, aby funkcja Closure Linter była bardziej rygorystyczna w zakresie reguł stylu, takich jak odstępy, typy JsDoc czy tagi autorów, możesz używać flagi wiersza poleceń --strict. Musisz użyć tagu --strict, jeśli publikujesz kod w Bibliotece zamkniętej.
Rozwiązywanie problemów ze stylem
W każdym z powyższych poleceń możesz zastąpić fixjsstyle w celu gjslint, aby automatycznie naprawić wiele błędów, które gjslint sprawdza.
Przykład:
$ fixjsstyle path/to/file1.js path/to/file2.js
Przed użyciem fixjsstyle należy utworzyć kopię zapasową plików lub zapisać je w systemie kontroli źródła, na wypadek, gdyby skrypt wprowadził niepożądane zmiany.