Tags

,

Dans la première partie de cet article, j’ai formulé des recommandations visant à éviter certains pièges lors du choix et de la configuration des règles Checkstyle. Cela notamment afin d’éviter de décourager les  développeurs avec des règles irréalistes ou hors contexte.

Reste à nous occuper des règles particulièrement pénibles à corriger, très laborieuses, telles que les espaces superflus, l’organisation des “imports” par ordre alphabétique, ou des variables selon leur visibilité.
Ce serait une perte de temps énorme que d’avoir à se soucier de tous ces problèmes syntaxiques. Heureusement la plupart des IDE actuels fournissent des outils qui, moyennant une configuration appropriée, peuvent réaliser automatiquement tous ces traitements. Je prendrai ici le cas d’Eclipse.

Bien configurer l’IDE pour éluder les contraintes de Checkstyle

Les “Save Actions” d’Eclipse permettent de systématiser le formatage du code ainsi que l’organisation des imports et des déclarations au moment de la sauvegarde des fichiers source. Cette option peut être utilisée de façon à résoudre toutes les règles de formatage de Checkstyle sans qu’aucune action spécifique ne soit nécessaire.

Cela nécessite de coordonner les règles Checkstyle avec les outils suivants :

  • l’outil de formatage automatique du code (Window > Preferences > Java > Code Style > Formatter) ;
  • l’outil d’organisation des imports (Window > Preferences > Java > Code Style > Organize Imports) ;
  • l’outil d’organisation des déclarations (Window > Preferences > Java > Appearance > Members Sort Order) ;

Puis de configurer les “Save Actions” (Window > Preferences > Java > Editor > Save Actions) pour exécuter ces trois outils automatiquement à chaque sauvegarde.

Save Actions Eclipse

Save Actions Eclipse

Cette configuration occulte la majorité des erreurs rébarbatives de Checkstyle et en simplifie donc énormément l’utilisation au quotidien.

Dernier point : en phase de développement, il est pénible d’être perturbé par des erreurs Checkstyle alors que ce sont les problèmes de compilation qui nous importent à ce moment-là.
Pour éviter ce désagrément, il est préférable d’appliquer un filtre à la vue “Problems” d’Eclipse pour masquer les erreurs Checkstyle.

Modification du filtre de la vue Problems pour masquer les erreurs Checkstyle.

Modification du filtre de la vue Problems pour masquer les erreurs Checkstyle.

Ainsi, les erreurs Checkstyle sont tout de même signalées dans l’éditeur, mais n’apparaissent plus dans la vue Problems. On utilisera alors la vue “Statistiques des erreurs Checkstyle” pour traiter celles-ci.

Séparer les erreurs de compilation des problèmes Checkstyle

Séparer les erreurs de compilation des problèmes Checkstyle

En limitant considérablement les contraintes induites par l’utilisation de Checkstyle, ces recommandations permettent d’exploiter pleinement cet outil. Une fois de plus, une bonne configuration de l’IDE est primordiale.

Advertisements