Примечание. Closure Linter устарел и редко используется в Google. Смотрите эту страницу для получения дополнительной информации
Этот документ описывает, как установить и использовать Closure Linter.
Установить замыкающий линтер
Используйте утилиту Python pip
для загрузки и установки Closure Linter.
линукс
Чтобы установить Closure Linter в Linux, выполните следующие команды:
$ sudo apt-get install python-pip $ sudo pip install https://github.com/google/closure-linter/zipball/master
Mac OS X
Чтобы установить Closure Linter на Mac OS X, выполните следующую команду:
$ sudo easy_install pip $ sudo pip install https://github.com/google/closure-linter/zipball/master
Окна
Чтобы установить Closure Linter в Windows:
- Загрузите и установите Python для Windows.
- Выполните следующую команду:
> pip install https://github.com/google/closure-linter/zipball/master
Примечание. Поддержка Windows для Closure Linter является экспериментальной.
Найдите проблемы со стилем
Чтобы запустить Closure Linter для одного файла, попробуйте:
$ gjslint path/to/my/file.js
Вы должны увидеть такие результаты:
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 ":"
Вы также можете рекурсивно проверить весь каталог, например:
$ gjslint -r path/to/my/directory
По умолчанию Closure Linter проверяет наличие правильных аннотаций JsDoc. Если вы не хотите проверять отсутствие аннотаций JsDoc в своем проекте, отключите проверку следующим образом:
$ gjslint --nojsdoc -r path/to/my/directory
Хотя этот флаг отключает проверку отсутствия аннотаций JsDoc, линтер по-прежнему проверяет правильность использования существующих аннотаций JsDoc.
Флаг --strict
Если вы хотите, чтобы Closure Linter был более строгим в отношении правил стиля, таких как интервалы, типы JsDoc и авторские теги, используйте флаг --strict
командной строки. Вы должны использовать --strict
, если вы добавляете код в библиотеку Closure .
Устранение проблем со стилем
В любой из приведенных выше команд вы можете заменить fixjsstyle
на gjslint
, чтобы автоматически исправить многие ошибки, которые проверяет gjslint
.
Например:
$ fixjsstyle path/to/file1.js path/to/file2.js
Вы должны сделать резервную копию своих файлов или сохранить их в системе управления исходным кодом перед использованием fixjsstyle
на случай, если скрипт внесет изменения, которые вам не нужны.