Remarque: Closure Linter est obsolète et n'est que rarement utilisé au sein de Google. Pour en savoir plus, consultez cette page.
Ce document explique comment installer et utiliser Closure Linter.
Installation de l'outil lint de fermeture
Utilisez l'utilitaire Python pip pour télécharger et installer Closure Linter.
Linux
Pour installer Closure Linter sous Linux, exécutez les commandes suivantes:
$ sudo apt-get install python-pip $ sudo pip install https://github.com/google/closure-linter/zipball/master
Mac OS X
Pour installer Closure Linter sous Mac OS X, exécutez la commande suivante:
$ sudo easy_install pip $ sudo pip install https://github.com/google/closure-linter/zipball/master
Windows
Pour installer Closure Linter sous Windows:
- Téléchargez et installez Python pour Windows.
- exécutez la commande suivante :
> pip install https://github.com/google/closure-linter/zipball/master
Remarque : La compatibilité de Windows avec Closure Linter est expérimentale.
Trouver des problèmes de style
Pour exécuter l'outil lint de fermeture sur un seul fichier:
$ gjslint path/to/my/file.js
Vous devez obtenir des résultats semblables à ceux-ci :
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 ":"
Vous pouvez également vérifier un répertoire entier de manière récursive, comme ceci:
$ gjslint -r path/to/my/directory
Par défaut, l'outil lint de fermeture vérifie la présence d'annotations JsDoc correctes. Si vous ne souhaitez pas rechercher d'annotations JsDoc manquantes dans votre projet, désactivez la vérification comme suit:
$ gjslint --nojsdoc -r path/to/my/directory
Bien que cet indicateur désactive les vérifications concernant les annotations JsDoc manquantes, l'outil lint vérifie toujours que les annotations JsDoc existantes sont utilisées correctement.
L'indicateur --strict
Si vous souhaitez que Closure Linter respecte les règles de style telles que l'espacement, les types JsDoc et les tags d'auteur, utilisez l'option de ligne de commande --strict. Vous devez utiliser --strict si vous contribuez au code de la bibliothèque Closure.
Résoudre les problèmes de style
Dans l'une des commandes ci-dessus, vous pouvez remplacer fixjsstyle par gjslint pour corriger automatiquement bon nombre des erreurs détectées par gjslint.
Exemple :
$ fixjsstyle path/to/file1.js path/to/file2.js
Vous devez sauvegarder vos fichiers ou les stocker dans un système de gestion de code source avant d'utiliser fixjsstyle, au cas où le script apporte les modifications que vous ne souhaitez pas.