IDE Arduino: modifier les paramètres du formatage automatique

C'est bien connu, l'option "Formatage automatique" disponible dans le menu "Outils" de l'IDE Arduino est bien utile pour améliorer la lisibilité d'un sketch.

Ce qui est peut-être un peu moins connu, c'est qu'il est possible de modifier certaines caractéristiques du formatage comme, par exemple, le nombre d'espaces utilisés à chaque indentation.

Les paramètres du formatage automatique se trouvent dans un fichier intitulé "formatter.conf", qui se trouve dans le répertoire "lib". 

Il est déconseillé de modifier directement ce fichier car, si vous le faites, vos modifications disparaîtront inévitablement lors d'une future mise à jour de l'IDE Arduino. Il est plutôt recommandé de placer une copie de ce fichier dans le même répertoire que le fichier "preferences.txt", et d'effectuer des modifications sur cette copie.

(Si vous ne connaissez pas l'emplacement du fichier "preferences.txt", vous pouvez le voir dans le bas de la fenêtre "Paramètres" dans l'IDE Arduino.)

Le fichier "formatter.conf" peut être ouvert avec n'importe quel éditeur de texte.

Modifier l'indentation

Par défaut, l'indentation est réglée à 2 espaces. Si vous préférez, par exemple, une indentation de 4 espaces, il s'agit de remplacer l'instruction "indent=spaces=2" par "indent=spaces=4". (L'IDE Arduino doit être redémarré pour que les modification prennent effet).

Disposition des accolades: attachées, ou détachées?

Si vous désirez que l'accolade d'ouverture soit toujours placée à la fin de la même ligne que la fonction à laquelle elle est rattachée, écrivez "style=attach" dans le fichier "formatter.conf":

Si vous préférez que l'accolade d'ouverture soit placée sur sa propre ligne, vous écrivez plutôt "style=break" dans le fichier "formatter.conf":

Sinon, le comportement par défaut consiste à ne pas modifier le style déjà utilisé. Par exemple, le sketch ci-dessous comporte un mélange des deux types de disposition,  et il sera laissé intact par le formatage automatique si vous n'avez pas apporté de modification au fichier "formatter.conf":

Séparer les blocs?

Avec l'instruction "break-blocks", les blocs if, for, while, etc. sont automatiquement précédés et suivis d'une ligne blanche:

Vous trouverez d'autres options de formatage sur la page d'Artistic Style.

À lire également

Retirer les cartes inutiles dans les menus de l'IDE Arduino

Yves Pelletier (Twitter, Facebook)