Triez vos dépendances !

29 avril 2023

Le contexte

La gestion des dépendances est un aspect primordial de tout projet. Dans le monde de Node.js, npm est l’outil standard pour installer et gérer les dépendances, mais n’oublions pas ses cousins yarn ou encore pnpm. Le fichier package.json liste toutes les dépendances et leurs versions.

Lorsque l’on travaille sur un projet en équipe, il est important que le fichier package.json soit maintenu de manière cohérente. Et c’est là que le package sort-package-json entre en jeu.

sort-package-json

Il permet de trier le fichier package.json par ordre alphabétique selon les noms de packages. Cela permet évidemment de maintenir une cohérence dans l’ordre des dépendances, facilitant ainsi la lecture et la maintenance du fichier.

Illustration d'un balai

Au-delà des dépendances, qui sont triées par défaut si vous n’avez fait que des installations en ligne de commande (npm install XXX), sort-package-json va aussi trier les autres champs du fichier, comme l’auteur, le nom du projet, sa version, etc.

Pour cela, ce package utilise des règles définies ici.

Son utilisation

Pour l’utiliser, rien de plus simple ! Un simple npx sort-package-json et le tour est joué !

Mais vous pouvez aussi l’intégrer à une stratégie plus large de standardisation sur votre projet, par exemple en l’ajoutant aux tâches exécutées par vos hooks Git avec Husky, comme décrit dans la documentation ici.