5.2 : Structurer un dépôt de scripts

Le test des trente secondes

Voici comment savoir si votre référentiel est bien rangé.

Un collègue arrive, clone le dépôt, et doit répondre seul à trois questions : qu’est-ce qu’il y a là-dedans, où se trouve ce que je cherche, et comment l’utiliser sans rien casser ?

S’il vous appelle, la structure est mauvaise. Pas parce qu’il manque de compétence, mais parce que le dépôt ne se raconte pas lui-même.

Cette leçon décrit une structure qui passe ce test.


L’arborescence

Voici la structure de référence pour le dépôt scripts-powershell de Nordika.

scripts-powershell/
├── README.md
├── CHANGELOG.md
├── .gitignore
├── .gitattributes
│
├── active-directory/
│   ├── New-Collaborateur.ps1
│   ├── Disable-CompteInactif.ps1
│   └── Get-GroupesUtilisateur.ps1
│
├── postes/
│   ├── Logon.ps1
│   └── Set-Imprimantes.ps1
│
├── serveurs/
│   ├── Check-Espace.ps1
│   └── Purge-Profils.ps1
│
├── modules/
│   └── Nordika.Common/
│       ├── Nordika.Common.psm1
│       └── Nordika.Common.psd1
│
├── config/
│   ├── serveurs.json
│   └── mappages.json.example
│
└── docs/
    ├── procedure-arrivee.md
    └── procedure-depart.md

Les principes derrière ce découpage

Un dossier par domaine fonctionnel, pas par type de fichier. active-directory, postes, serveurs répondent à la question que se pose l’utilisateur : « sur quoi ça agit ? ». Un découpage en scripts/, fonctions/, tests/ ne l’aide pas.

Deux niveaux au maximum. Au-delà, on ne trouve plus rien sans chercher. Si un dossier contient trente fichiers, c’est le signe qu’il faut le découper, pas ajouter un niveau.

Le code partagé dans modules/. Dès qu’une fonction est utilisée par deux scripts, elle sort du script et rejoint un module. Cela évite la duplication, et surtout les corrections faites à un endroit et oubliées ailleurs.