Cómo usar linter de cierre

Nota: La función de cierre de Linter está obsoleta y rara vez se utiliza en Google. Consulta esta página para obtener más información

En este documento, se describe cómo instalar y usar Closure Linter.

Instalar Clinure Linter

Usa la utilidad pip de Python para descargar e instalar Closure Linter.

Linux

Para instalar Linter 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 Linter 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 Linter Linter en Windows, sigue estos pasos:

  1. Descarga y, luego, instala Python para Windows.
  2. Ejecuta el siguiente comando:
> pip install https://github.com/google/closure-linter/zipball/master

Nota: La compatibilidad de Windows con Closure Linter es experimental.

Problemas de estilo

Para ejecutar el linter de cierre 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 revisar de forma recursiva un directorio completo, como este:

$ gjslint -r path/to/my/directory

De forma predeterminada, el Closure Linter verifica la presencia de las anotaciones JsDoc correctas. Si no deseas verificar las anotaciones de JsDoc faltantes en tu proyecto, inhabilita la verificación de la siguiente manera:

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

Aunque esta marca inhabilita las comprobaciones de las anotaciones JsDoc faltantes, el linter aún verifica que las anotaciones JsDoc existentes se usen de forma correcta.

La marca --strict

Si deseas que Cinta-Linter sea más estricta acerca de las reglas de estilo, como el espaciado, los tipos 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 cierres.

Solucionar problemas de estilo

En cualquiera de los comandos anteriores, puedes sustituir fixjsstyle por gjslint para corregir de forma automática 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 origen antes de usar fixjsstyle, en caso de que la secuencia de comandos realice cambios que no deseas.