Formatage du code

Code Java

Le plugin maven Spotless est activé pour le formatage du code Java. Ce plugin permet de reformater en utilisant prettier-java et se charge également d'optimiser les imports.

Il peut être exécuté de deux façons différentes :

• vérification (mvn spotless:check) : vérifie que le code respecte le formatage recommandé par prettier-java. Si ce n'est pas le cas, le build maven va échouer. Ce mode est automatiquement appliqué dans la phase verify de maven, et sert notamment dans le build jenkins.
• reformatage automatique (mvn spotless:apply) : applique automatiquement le bon format aux différents fichiers. Attention, cette commande va évidemment modifier les fichiers. Cela dit, je n'ai jamais eu de problème, mais partir du principe que cela ne marchera correctement que si le code compile.

Le code style de Vitam a été modifié pour le rendre compatible (le plus possible, ce n'est malheureusement pas parfait). Télécharger et activer le nouveau code style depuis ici.

Il existe un plugin IntelliJ permettant de lancer le reformatage avec Spotless depuis l'IDE. Le plugin s'appelle Spotless Applier.

Tout ceci s'applique à Vitam Core et à Vitam UI.

Code TypeScript

De la même façon que pour le code java, Prettier est installé et configuré pour le code TypeScript de Vitam UI.

De la même façon que pour le code Java, il peut être utilisé de deux façons différentes :

• vérification (npm run prettier:ci). Vérifie que le code respecte le formatage attendu, échoue dans le cas contraire. Exécuté notamment dans le build jenkins
• reformatage (npm run prettier). Reformate le code selon les règles de Prettier.

Il existe aussi un plugin IntelliJ (nommé "Prettier") pour exécuter Prettier automatiquement à l'enregistrement d'un fichier. La configuration recommandée est la suivante, dans Languages & Frameworks > JavaScript > Prettier :

• Automatic Prettier Configuration
• Run for files : laisser par défaut
• Run on save