Powershell - Convention de nommage

Au début, on écrit tous des petits scripts dans son coin pour gagner du temps sur une tâche. Puis le script évolue, il automatise davantage, devient indispensable pour toi.
Parfois même, tu le partages en interne dans ton entreprise ou en public (blog perso, GitHub, etc.). Bref, ton petit script finit par devenir grand.
Il est donc essentiel de suivre un "cadre", et ça commence par la façon de nommer les choses dans ton code.

PowerShell n'est pas sensible à la casse, c'est-à-dire qu'il ne fait pas de distinction entre $UserName et $username, mais il reste important de suivre des conventions.

Notation camelCase

Utilisé pour les variables. On commence par une minuscule et chaque mot suivant débute par une majuscule.

❌ Ne fais pas :

$User
$file_path
$My_Super_Variable

✅ Fais plutôt :

$user
$filePath
$mySuperVariable

Notation PascalCase

Pour les noms de scripts

Chaque mot commence par une majuscule.

❌ Pour un script ne fais pas :

userinfo.ps1

✅ Fais plutôt :

Get-UserInfo.ps1

Pour les noms de fonctions

❌ Pour une fonction ne fais pas

function set_file_permission {
   # toncode
}

✅ Définis ton nom de fonction en PascalCase

function Set-FilePermission {
   # toncode
}

Pour les paramètres d'une fonction

❌ Pour les paramètres d'une fonction ne fais pas

function New-MyCustomUser {
   param(
      [string]$username
   )
   # toncode
}

✅ Définis tes noms de paramètres en PascalCase

function New-MyCustomUser{
   param(
      [string]$UserName
   )
   # toncode
}

Format Verbe-Nom pour les fonctions et scripts

Une fonction ou un script doit porter un nom clair sous la forme Verbe-Nom pour indiquer son action. Il existe plusieurs verbes approuvés comme Get, Set ou New.
Pour la liste complète, Get-Verb dans PowerShell ou consulte la documentation Microsoft : https://learn.microsoft.com/en-us/powershell/scripting/developer/cmdlet/approved-verbs-for-windows-powershell-commands

Le nom du script est, selon moi, un point à ne pas négliger : sinon vous finirez avec 100 fichiers nommés run.ps1 ou script.ps1… et bon courage pour vous y retrouver.

✅ Exemples pour les fonctions :

function Get-UserInfo
function Set-FilePermission
function Remove-OldFiles

✅ Exemples pour les noms de fichiers :

Set-FilePermission.ps1
Remove-OldFiles.ps1
Get-UserInfo.ps1
Invoke-ADCleanup.ps1