Utiliser l'outil lint de fermeture

Remarque : Closure Linter est obsolète et n'est presque plus utilisé chez Google. Pour en savoir plus, consultez cette page.

Ce document explique comment installer et utiliser Closure Linter.

Installer Closure Linter

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 sur 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 sur Windows :

  1. Téléchargez et installez Python pour Windows.
  2. Exécutez la commande suivante :
> pip install https://github.com/google/closure-linter/zipball/master

Remarque : La compatibilité de Closure Linter avec Windows est expérimentale.

Trouver les problèmes de style

Pour exécuter Closure Linter sur un seul fichier, essayez :

$ 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 de manière récursive un répertoire entier, comme ceci :

$ gjslint -r path/to/my/directory

Par défaut, Closure Linter vérifie la présence d'annotations JSDoc correctes. Si vous ne souhaitez pas rechercher les 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 des annotations JSDoc manquantes, le linter vérifie toujours que les annotations JSDoc existantes sont utilisées correctement.

Indicateur --strict

Si vous souhaitez que Closure Linter soit plus strict concernant les règles de style telles que les espaces, les types JSDoc et les balises d'auteur, utilisez l'indicateur de ligne de commande --strict. Vous devez utiliser --strict si vous contribuez du code à 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 la plupart des erreurs que gjslint recherche.

Exemple :

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

Nous vous recommandons de sauvegarder vos fichiers ou de les stocker dans un système de contrôle de code source avant d'utiliser fixjsstyle, au cas où le script apporterait des modifications indésirables.