Quelques bonnes pratiques

1. Fonctionnement

Nous avons vu précédemment que pour obtenir des informations sur une cmdlet il fallait utiliser la cmdlet Get-Help.

Utilisons donc cette cmdlet pour comprendre le fonctionnement de la cmdlet Get-Member :

get-help get-member 

Ci-dessous le retour :

PS C:\Users\damien.vanrobaeys> get-help get-member 
NAME 
    Get-Member 
 
SYNOPSIS 
    Gets the properties and methods of objects. 
 
SYNTAX 
    Get-Member [[-Name] <System.String[]>] [-Force] [-InputObject 
<System.Management.Automation.PSObject>] [-MemberType  
{AliasProperty | CodeProperty | Property | NoteProperty | 
    ScriptProperty | Properties | PropertySet | Method |  
CodeMethod | ScriptMethod | Methods | ParameterizedProperty |  
MemberSet | Event | Dynamic | All}] [-Static] [-View {Extended | 
    Adapted | Base | All}] [<CommonParameters>] 
 
DESCRIPTION 
    The `Get-Member` cmdlet gets the members, the properties and 
methods, of objects. 
    To specify the object, use the InputObject parameter or pipe 
an object to `Get-Member`. To get information about static members, 
the members of the class, not of the instance, use the 
    Static...

1. Que signifie commenter son code ?

Commenter son code signifie fournir des informations sur ce que fait le script ou telle commande. Cela se traduit par un ajout de texte au-dessus ou à côté d’une ligne de code. Certains préfèrent également ajouter un bloc de commentaire au début du script pour indiquer ce qu’il fait et comment l’utiliser.

Une des règles primordiales lorsque vous réalisez un script PowerShell est de penser aux choses suivantes :

Il est donc important de commenter votre code afin de donner le maximum d’indications sur :

2. Pourquoi est-ce important ?

Prenons les exemples suivants :

À première vue, le script paraît long et complexe. Cependant, si celui-ci est commenté, il sera relativement plus simple de se l’approprier et comprendre son fonctionnement....

1. Qu’est-ce que l’indentation ?

L’indentation correspond au fait d’utiliser la tabulation entre les éléments d’un script. Il s’agit simplement de l’utilisation de la touche [Tab].

L’indentation, ou l’utilisation de la touche [Tab], se fait sur une ligne ou un bloc de lignes et a pour effet de décaler cette ligne ou bloc d’un cran vers la droite.

2. Indentation en exemple

Prenons par exemple la commande suivante ouverte dans Notepad++ :

Ici, aucune indentation n’est appliquée, aucune tabulation.

L’utilisation de la tabulation sur cette ligne aura donc pour effet de décaler la ligne vers la droite :

3. Pourquoi indenter le code ?

L’indentation de votre code permet de le rendre clair et lisible pour vous et pour les autres. Au même titre que le fait de commenter, l’indentation permet de comprendre facilement un script.

Lorsque nous créons un script, il faut penser plus loin, c’est-à-dire à la personne qui devra se charger de le maintenir, de le modifier… Écrire un script en un seul bloc, sur la même ligne, sans indentation, peut être clair aux yeux de celui qui l’écrit mais sera la plupart du temps difficilement lisible pour un œil extérieur. En ce qui nous concerne, la première chose que nous faisons lorsque nous ouvrons un script d’un collègue ou trouvé sur Internet est de l’indenter, si cela n’est pas fait.

4. Règles d’indentation

Chaque personne a sa manière de coder, il n’y a pas réellement de bonnes ou mauvaises façons...

1. Pourquoi ?

Écrire des scripts ou commandes peut parfois paraître fastidieux lorsque nous ne connaissons pas très bien les cmdlets à utiliser ou que nous tapons vite sur le clavier sans vérifier. Cela peut avoir pour effet d’entraîner des erreurs de saisie et donc d’exécution du script ou code. Cela peut également nous faire perdre du temps pour comprendre d’où vient le problème.

C’est pour cela que la saisie semi-automatique des commandes ou l’autocomplétion peut être un véritable atout.

2. Fonctionnement

Le principe est très simple, lorsque nous saisissons le début d’une cmdlet, PowerShell va nous aider à trouver la bonne en affichant les différentes possibilités. Cela fonctionne pour les cmdlets, mais également pour les paramètres des cmdlets. Cela nous permettra donc pour une cmdlet de chercher un paramètre précis.

3. Comment l’utiliser ?

Son utilisation se fait très facilement en utilisant la touche [Tab].

Cela aura pour effet d’afficher la cmdlet qui se rapproche le plus de votre saisie. Si cela ne correspond pas à vos attentes, il suffira d’utiliser à nouveau la touche [Tab] jusqu’à trouver la cmdlet souhaitée.

Dans l’exemple suivant...

1. Qu’est-ce qu’un alias ?

PowerShell offre la possibilité d’utiliser (et même de créer) des alias.

Les alias sont ce que l’on peut appeler des raccourcis de commandes, des versions abrégées. Ils sont généralement utilisés pour coder plus vite et pour réduire le nombre de caractères et lignes d’un script.

Voici quelques exemples d’alias, avec la cmdlet d’origine puis l’alias correspondant entre parenthèses :

Get-Item (gi), Get-ChildItem (gci), Get-WMIObject (gwmi), Get-Content (gc), New-Item (ni), Remove-Item (del), Add-Content (ac), Get-Command (gcm), Get-Module (gcmo), Copy-Item (cp, cpi, copy), Get-Process (gps).

Cependant, même si PowerShell permet l’utilisation d’alias, cela ne signifie pas que c’est recommandé.

Au contraire, une des bonnes pratiques est de ne pas utiliser d’alias dans son script.

2. Pourquoi ne pas utiliser d’alias ?

La raison est simple : il faut penser à celui qui doit relire le code. En effet, les alias sont quelque chose de connu, mais tout le monde ne connaît pas tous les alias par cœur.

Une cmdlet se présente sous la forme d’un verbe et d’un nom (verb + noun). Même si vous ne connaissez...

1. Qu’est-ce que le module PSScriptAnalyzer ?

Une bonne manière de vérifier si votre script ou code respecte certaines règles ou bonnes pratiques est d’utiliser le module nommé PSScriptAnalyzer.

PSScriptAnalyzer est un module qui permet de vérifier si votre script ou code respecte certaines règles définies.

Il permet aussi de vérifier le formatage, les indentations de votre code.

2. Comment l’installer ?

Ce module peut s’installer facilement depuis la PowerShell Gallery.

Pour installer le module, utilisez la commande suivante :

Install-Module -Name PSScriptAnalyzer 

3. Les règles que le module va vérifier

Il est possible de lister les différentes règles que le module va vérifier en analysant un script via la commande suivante :

Get-ScriptAnalyzerRule 

Ci-dessous un aperçu :

Les règles sont classées en différentes catégories de sévérité :

L’ajout d’un Out-Gridview à la commande permet d’y voir plus clair.

Nous allons afficher maintenant uniquement les règles avec la sévérité Warning :

Get-ScriptAnalyzerRule -Severity Warning | select RuleName 

Ci-dessous les différentes règles trouvées :

CommonName 
---------- 
Align assignment statement 
Avoid Using Cmdlet Aliases or omitting the 'Get-' prefix. 
Changing automtic variables might have undesired side effects 
Switch Parameters Should Not Default To True 
Avoid Default Value For Mandatory Parameter 
Avoid Using Empty Catch Block 
Avoid global aliases. 
Avoid global functiosn and aliases 
No Global Variables 
Avoid Invoking Empty Members 
Avoid long lines 
Avoid using null or empty HelpMessage parameter attribute. 
Avoid overwriting built in cmdlets 
Reserved Cmdlet Chars 
Reserved Parameters 
Avoid Using ShouldContinue Without Boolean Force Parameter 
Avoid Using Deprecated Manifest Fields 
Avoid Using Invoke-Expression 
Avoid Using Plain Text For Password Parameter 
Avoid Using Get-WMIObject, Remove-WMIObject, Invoke-WmiMethod,  
Register-WmiEvent, Set-WmiInstance 
Avoid Using Write-Host 
Use compatible commands ...