Nota: Closure Linter está obsoleto y ya casi no se usa en Google. Consulta esta página para obtener más información.
En este documento, se describe cómo instalar y usar Closure Linter.
Instala Closure Linter
Usa la utilidad pip de Python para descargar e instalar Closure Linter.
Linux
Para instalar Closure Linter en Linux, ejecuta los siguientes comandos:
$ sudo apt-get install python-pip $ sudo pip install https://github.com/google/closure-linter/zipball/master
Mac OS X
Para instalar Closure Linter en Mac OS X, ejecuta el siguiente comando:
$ sudo easy_install pip $ sudo pip install https://github.com/google/closure-linter/zipball/master
Windows
Para instalar Closure Linter en Windows, haz lo siguiente:
- Descarga e instala Python para Windows.
- Ejecuta el siguiente comando:
> pip install https://github.com/google/closure-linter/zipball/master
Nota: La compatibilidad con Windows para Closure Linter es experimental.
Cómo encontrar problemas de diseño
Para ejecutar Closure Linter en un solo archivo, prueba lo siguiente:
$ gjslint path/to/my/file.js
Debes ver resultados como los siguientes:
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 ":"
También puedes verificar de forma recursiva un directorio completo, de la siguiente manera:
$ gjslint -r path/to/my/directory
De forma predeterminada, Closure Linter verifica la presencia de anotaciones JSDoc correctas. Si no quieres verificar si faltan anotaciones de JsDoc en tu proyecto, inhabilita la verificación de la siguiente manera:
$ gjslint --nojsdoc -r path/to/my/directory
Si bien esta marca inhabilita las verificaciones de las anotaciones de JsDoc faltantes, el verificador de código sigue verificando que las anotaciones de JsDoc existentes se usen correctamente.
La marca --strict
Si quieres que Closure Linter sea más estricto con las reglas de estilo, como el espaciado, los tipos de JsDoc y las etiquetas de autor, usa la marca de línea de comandos --strict. Debes usar --strict si contribuyes con código a la biblioteca de Closure.
Cómo corregir problemas de diseño
En cualquiera de los comandos anteriores, puedes sustituir fixjsstyle por gjslint para corregir automáticamente muchos de los errores que gjslint verifica.
Por ejemplo:
$ fixjsstyle path/to/file1.js path/to/file2.js
Debes crear una copia de seguridad de tus archivos o almacenarlos en un sistema de control de código fuente antes de usar fixjsstyle, en caso de que la secuencia de comandos realice cambios que no desees.