Come utilizzare Closure Linter

Nota: Closure Linter è ritirato e non viene quasi più utilizzato in Google. Per maggiori informazioni, visita questa pagina.

Questo documento descrive come installare e utilizzare Closure Linter.

Installare Closure Linter

Utilizza l'utilità Python pip per scaricare e installare Closure Linter.

Linux

Per installare Closure Linter su Linux, esegui questi comandi:

$ sudo apt-get install python-pip
$ sudo pip install https://github.com/google/closure-linter/zipball/master

Mac OS X

Per installare Closure Linter su Mac OS X, esegui questo comando:

$ sudo easy_install pip
$ sudo pip install https://github.com/google/closure-linter/zipball/master

Windows

Per installare Closure Linter su Windows:

  1. Scarica e installa Python per Windows.
  2. Esegui questo comando:
> pip install https://github.com/google/closure-linter/zipball/master

Nota:il supporto di Windows per Closure Linter è sperimentale.

Trovare problemi di stile

Per eseguire Closure Linter su un singolo file, prova:

$ gjslint path/to/my/file.js

Dovresti vedere risultati simili a questi:

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 ":"

Puoi anche controllare in modo ricorsivo un'intera directory, in questo modo:

$ gjslint -r path/to/my/directory

Per impostazione predefinita, Closure Linter verifica la presenza di annotazioni JsDoc corrette. Se non vuoi verificare la presenza di annotazioni JsDoc mancanti nel tuo progetto, disattiva il controllo nel seguente modo:

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

Anche se questo flag disattiva i controlli per le annotazioni JsDoc mancanti, il linter verifica comunque che le annotazioni JsDoc esistenti siano utilizzate correttamente.

Il flag --strict

Se vuoi che Closure Linter sia più rigoroso in merito alle regole di stile come spaziatura, tipi JsDoc e tag autore, utilizza il flag della riga di comando --strict. Devi utilizzare --strict se contribuisci con codice alla libreria Closure.

Risolvere i problemi di stile

In uno qualsiasi dei comandi precedenti, puoi sostituire fixjsstyle con gjslint per correggere automaticamente molti degli errori che gjslint controlla.

Ad esempio:

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

Prima di utilizzare fixjsstyle, devi eseguire il backup dei file o archiviarli in un sistema di controllo del codice sorgente, nel caso in cui lo script apporti modifiche indesiderate.