Как использовать замыкающий линтер

Примечание: Closure Linter устарел и теперь редко используется в Google. Подробнее см. на этой странице .

В этом документе описывается, как установить и использовать Closure Linter.

Установить закрытие 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:

  1. Загрузите и установите Python для Windows.
  2. Выполните следующую команду: 
> pip install https://github.com/google/closure-linter/zipball/master

Примечание: поддержка Closure Linter в Windows является экспериментальной.

Найти проблемы стиля

Чтобы запустить 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 . Если вы добавляете код в Closure Library , обязательно используйте --strict .

Исправить проблемы стиля

В любой из приведенных выше команд вы можете заменить gjslint на fixjsstyle , чтобы автоматически исправить многие ошибки, которые проверяет gjslint .

Например:

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

Перед использованием fixjsstyle следует создать резервную копию файлов или сохранить их в системе управления исходным кодом на случай, если скрипт внесет нежелательные изменения.