Exile on Keyboard St. - Blog sur Linux et Debian

Aller au contenu | Aller au menu | Aller à la recherche

dimanche 29 octobre 2017

IntelliJ IDEA: Quel formatage pour votre code Java

Beaucoup de développeurs, même expérimentés, ne prêtent pas (ou pas assez) attention au formatage du code.

Pourtant, l'utilisation d'un template de formatage de code présente les entre autres les avantages suivants:

  • le code est plus facile à lire
  • Les lignes blanches successives et inutiles sont évitées
  • En Java, le pavé des imports sera toujours cohérent entre les développeurs
  • Il permet de voir facilement les blocs, même ceux ne contenant qu'une instruction
  • Une fois un template de formatage choisi dans une équipe, les conflits à l'update sont évités et les merges facilités

Malheureusement, la plupart des projets de développement n'imposent pas un template de formatage et les développeurs se contentent trop souvent du template par défaut de leur environnement de développement. Et comme tous les développeurs n'utilisent pas le même IDE ...

Eclipse propose par exemple trois templates par défaut, qui tous utilisent des tabulations pour indenter le code ... Pire, le profile "Java Conventions" utilise à la fois des tabulations et des espaces. C'est bien dommage qu'Eclipse propose de formater le code avec des tabulations, ce que très peu de gens font encore. Parait t'il qu'historiquement, ce choix avait pour but de "sauver" de l'espace disque !!! Cette époque là est bien révolue. Enfin, pour modifier la façon de formater le code par défaut d'Eclipse, il faut dupliquer le profile avant de pouvoir le modifier, ce qui n'est pas très commode. IntelliJ IDEA n'impose pas cette restriction.

Dans ce billet, on va quand même dupliquer le profile par défaut d'IntelliJ, pour pouvoir exporter nos paramètres et aussi revenir facilement au profile par défaut.

Interdire la détection de l'indentation existante

Première chose à faire dans IntelliJ IDEA, décocher la case "Detect and use existing file indents for editing". En effet, avec cette option, si un fichier est indenté avec des tabulations, IntelliJ considèrera qu'il faut continuer d'indenter de cette façon !!!

Utiliser EditorConfig ou pas ?

EditorConfig est un format de fichier texte permettant de définir des profiles de formatage de code, via quelques propriétés. Ce format est censé être supporté par de nombreux éditeurs, ce qui est très séduisant. Malheureusement, trop peu de propriétés sont implémentées par exemple par le plugin EditorConfig pour IntelliJ, et on est donc amené à définir le reste du paramétrage dans la configuration standard de l'éditeur. J'y reviendrai peut être dans un billet séparé. Pour l'instant, on va cocher qu'on n'utilise pas EditorConfig.

Onglet 'Tabs and Indents'

On ne change rien dans cette section puisqu'IntelliJ utilise par défaut les espaces pour l'indentation et 4 de plus à chaque bloc. Ce formatage nous convient.

Onglet 'Spaces'

Dans cette section, on va cocher dans la sous-section 'Within' la case 'Array initializer braces', ce qui permet de mieux voir les paramètres dans les appels à log4j ou java.util.logging.

Onglet 'Wrapping and braces'

C'est dans cette section que l'on va modifier le plus de choses.

Concernant la position des accolades, on va adopter le style Allman, c'est à dire positionner les accolades sur la ligne suivante.

Toutes les valeurs de la sous section 'Braces placement' seront donc positionnées à 'Next line'.

Une fois qu'on a fait cela, il est logique:

  • dans 'if() statement' de cocher 'else on new line'
  • dans 'try statement' de cocher 'catch on new line' et 'finally on new line'
  • dans 'do while statement' de cocher 'while on new line'

Enfin, afin que les blocs soient bien visibles, même ceux ne contenant qu'une instruction, on va position à 'always' les propriétés 'Force braces' des sous-sections suivantes:

  • 'if() statement'
  • 'for() statement'
  • 'while() statement'
  • 'do while() statement'

Onglet 'Blank lines'

Dans la sous-section 'Keep maximum blank lines', on positionnera les 3 propriétés suivantes à 1 au lieu de 2:

  • In declarations:
  • In code:
  • Before '{':

En effet, je trouve que trop de lignes blanches n'aide pas à la lisibilité mais nous oblige à scroller.

Onglets 'JavaDoc', 'Imports' et 'Arrangement'

Je ne modifie rien pour l'instant.

Onglet 'Code generation'

Dans la section 'Final modifier' on coche les deux cases:

  • Make generated local variables final
  • Make generated parameters final

Vous pouvez utiliser le Formateur de code Java pour IDEA défini ci-dessous en le téléchargeant avec le lien précédent.

lundi 9 octobre 2017

Disposer de la complétion Bash avec Maven

L'outil de build Maven utilisé pour les projets Java a au moins un inconvénient, à savoir que par défaut aucune complétion n'est proposée dans le Terminal.

Que ce soit pour la liste des cibles ou phases ou des options comme skipTests ou maven.test.skip, dont personne ne se souvient et que tout le monde utilise ... (mai cela est une autre affaire), rien n'est proposé pour aider le développeur que vous êtes.

Heureusement, quelqu'un s'est chargé d'écrire un fichier de complétion Bash pour Maven.

Il suffit d'aller voir le dépôt maven-bash-completion et de copier le fichier de complétion dans /etc/bash.completion.d:

sudo \
    wget https://raw.github.com/dimaj/maven-bash-completion/master/bash_completion.bash \
    --output-document /etc/bash_completion.d/mvn

Vous verrez qu'ensuite, tout est plus agréable. Par exemple les cibles sont proposées quand on appuie sur TAB, exactement comme c'est le cas avec .... un Makefile !!!

dimanche 24 septembre 2017

Sublime Text en version 3 et avec le dépôt Debian

L'éditeur de texte Sublime Text est sorti récemment en version 3.

Ce build 3143 est le build final de la version 3 et aussi la première mise à jour depuis le build 3126 qui datait quand même du 23 septembre 2016 !

C'est donc l'occasion de mettre à jour votre éditeur préféré. Pour cela, il existe maintenant un dépôt pour les principales distributions Linux.

Sur Debian, on procèdera comme suit:

Ajout de la clé GPG:

user@machine:~$ wget -qO - https://download.sublimetext.com/sublimehq-pub.gpg | sudo apt-key add -
[sudo] password for user: 
OK

Ajout du dépôt:

user@machine:~$ echo "deb https://download.sublimetext.com/ apt/stable/" | sudo tee /etc/apt/sources.list.d/sublime-text.list

Puis:

user@machine:~$ sudo apt-get install sublime-text

Si Sublime Text n'était pas déjà installé, il sera mis à jour:

user@machine:~$ subl --version
Sublime Text Build 3143

Les commandes précédentes installent la version stable de l'éditeur. Pour disposer de la version de développement, il faut acheter une license.

Chose intéressante, une license personnelle donne le droit d'utiliser Sublime Text au travail ! Des fois que votre employeur soit quelque peu radin ...

jeudi 31 août 2017

Ajouter un Hook de Pre Commit dans IntelliJ IDEA

La boite de dialogue de commit d'IntelliJ IDEA propose entre autres de faire les actions suivantes avant le commit:

  • Reformatter le code
  • Optimiser les imports
  • Chercher les TODO

....

En revanche rien n'est prévu par défaut dans IntelliJ pour ajouter un script utlisateur de pre commit, qui par exemple va vérifier que vos traces ajoutées à des fins de debug ont bien été enlevées avant le commit.

Pour ajouter un Hook de pre commit, il faut installer un plugin, nommé Pre Commit Hook Plugin, qui va se charger d'éxécuter avant commit un script que vous aurez créé à la racine de votre projet et nommé pre-commit-hook.sh.

Le script sera appelé avec en paramètres les fichiers participant au commit. Il vous suffit donc dans le script de renvoyer le code retour 1 si vous avez oublié des traces de debug.

Ainsi vous éviterez les commits supplémentaires avec le message signficatif: "Oopppps: forgot to remove debug traces" !

Un exemple de script de pre commit:

#!/bin/bash

for file in "$@"; do
    grep -H -n DBG_TRACE "$file" && exit 1
done

exit 0

Le Pre Commit Hook Plugin est hébergé sur GitHub.

samedi 4 mars 2017

Trouver facilement votre adresse ip sans parser la sortie de la commande ifconfig

Combien de fois avez-vous eu besoin de connaître l'adresse IP de telle ou telle interface réseau sur une machine physique ou virtuelle ?

Quand on pose cette question la réponse ne se fait pas attendre:

Baahhh, tu n'as qu'à parser la sortie d'ifconfig !

En effet, la sortie de la commande ifconfig ressemblant à ceci:

debian@debian-jessie:~$ /sbin/ifconfig eth0
eth0      Link encap:Ethernet  HWaddr 08:00:27:ae:00:9f  
          inet adr:10.0.2.15  Bcast:10.0.2.255  Masque:255.255.255.0
          adr inet6: fe80::a00:27ff:feae:9f/64 Scope:Lien
          UP BROADCAST RUNNING MULTICAST  MTU:1500  Metric:1
          RX packets:155 errors:0 dropped:0 overruns:0 frame:0
          TX packets:136 errors:0 dropped:0 overruns:0 carrier:0
          collisions:0 lg file transmission:1000 
          RX bytes:43715 (42.6 KiB)  TX bytes:22029 (21.5 KiB)

Il est possible de parser cette sortie par exemple de la façon suivante:

    /sbin/ifconfig eth0 2> /dev/null | grep 'inet adr:' | cut -d : -f2 | awk '{ print $1}'

Déjà, c'est un peu lourdingue. Ensuite, on ne teste aucune erreur possible, par exemple si la sortie affiche "inet addr" avec deux "d" au lieu d'un, ce qui est le cas sur certaines distributions Linux, on voit ben qu'il faudra modifier la commande grep.

En fait, vous n'êtes pas obligés de parser la sortie d'ifconfig, et on peut obtenir cette adresse ip beaucoup plus simplement avec la commande ifdata.

Pour l'installer:

sudo apt-get install moreutils

Et pour afficher l'adresse:

debian@debian-jessie:/home/debian# ifdata -pa eth0
10.0.2.15

Comme vous le voyez la commande ifdata est très simple à utiliser et elle nous permet également de connaitre toutes les caractéristiques de ce réseau comme l'adresse de broadcast, le masque de sous-réseau, ...

Par exemple pour l'adresse de broadcast:

debian@debian-jessie:/home/debian# ifdata -pb eth0
10.0.2.255

Et pour voir l'ensemble des flags possibles de la commande:

debian@debian-jessie:/home/debian# ifdata 
Usage: ifdata [options] iface
     -e   Reports interface existence via return code
     -p   Print out the whole config of iface
    -pe   Print out yes or no according to existence
    -pa   Print out the address
    -pn   Print netmask
    -pN   Print network address
    -pb   Print broadcast
    -pm   Print mtu
    -ph   Print out the hardware address
    -pf   Print flags
    -si   Print all statistics on input
   -sip   Print # of in packets
   -sib   Print # of in bytes
   -sie   Print # of in errors
   -sid   Print # of in drops
   -sif   Print # of in fifo overruns
   -sic   Print # of in compress
   -sim   Print # of in multicast
    -so   Print all statistics on output
   -sop   Print # of out packets
   -sob   Print # of out bytes
   -soe   Print # of out errors
   -sod   Print # of out drops
   -sof   Print # of out fifo overruns
   -sox   Print # of out collisions
   -soc   Print # of out carrier loss
   -som   Print # of out multicast
  -bips   Print # of incoming bytes per second
  -bops   Print # of outgoing bytes per second

- page 1 de 2