Come utilizzare Closure Linter

Nota: Closure Linter è deprecato e raramente viene utilizzato all'interno di Google. Consulta questa pagina per saperne di più

Questo documento descrive come installare e utilizzare Closure Linter.

Installa 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 il comando seguente:

$ 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.

Trova problemi di stile

Per eseguire Closure Linter su un singolo file, prova a:

$ gjslint path/to/my/file.js

Dovresti vedere risultati come questo:

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, come segue:

$ gjslint -r path/to/my/directory

Per impostazione predefinita, Closure Linter controlla la presenza di annotazioni JsDoc corrette. Se non vuoi verificare le annotazioni JsDoc mancanti nel progetto, disattiva il controllo in questo modo:

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

Sebbene questo flag disattivi i controlli per le annotazioni JsDoc mancanti, il linter verifica comunque che le annotazioni JsDoc esistenti vengano utilizzate correttamente.

Bandiera --strict

Se vuoi impostare Closure Linter in modo più rigoroso sulle regole di stile, ad esempio spaziatura, tipi JsDoc e tag autore, utilizza il flag della riga di comando --strict. Devi utilizzare --strict se contribuisci al codice alla Closure Library.

Risolvi i problemi di stile

In uno dei comandi riportati sopra, puoi sostituire fixjsstyle con gjslint per correggere automaticamente molti degli errori controllati da gjslint.

Ad esempio:

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

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