Dans PowerShell, comment définir une fonction dans un fichier et l'appeler depuis la ligne de commande PowerShell ?

Question

J'ai un fichier .ps1 dans lequel je veux définir des fonctions personnalisées.

Imaginons que le fichier s'appelle MyFunctions.ps1, et que son contenu soit le suivant :

Write-Host "Installing functions"
function A1
{
    Write-Host "A1 is running!"
}
Write-Host "Done"

Pour exécuter ce script et théoriquement enregistrer la fonction A1, je navigue vers le dossier dans lequel réside le fichier .ps1 et j'exécute le fichier :

.\MyFunctions.ps1

Ces sorties :

Installing functions
Done

Pourtant, lorsque j'essaie d'appeler A1, j'obtiens simplement une erreur indiquant qu'il n'existe pas de commande/fonction de ce nom :

The term 'A1' is not recognized as the name of a cmdlet, function, script file, or operable program. Check the spelling
 of the name, or if a path was included, verify that the path is correct and try again.
At line:1 char:3
+ A1 <<<<
    + CategoryInfo          : ObjectNotFound: (A1:String) [], CommandNotFoundException
    + FullyQualifiedErrorId : CommandNotFoundException

Je dois mal comprendre certains concepts de PowerShell. Ne puis-je pas définir des fonctions dans les fichiers script ?

Nota que j'ai déjà défini ma politique d'exécution sur 'RemoteSigned'. Et je sais qu'il faut exécuter les fichiers .ps1 en plaçant un point devant le nom du fichier : . \myFile.ps1

Answer 1

Essayez ceci sur la ligne de commande PowerShell :

. .\MyFunctions.ps1
A1

L'opérateur point est utilisé pour l'inclusion de script, alias "dot-sourcing" (ou "notation de la source par points" )

Answer 2

Ce dont vous parlez s'appelle _sourcing par points . Et c'est le mal. Mais ne vous inquiétez pas, il existe un moyen plus simple et plus efficace de faire ce que vous voulez. modules_ (cela semble bien plus effrayant que cela ne l'est). Le principal avantage de l'utilisation de modules est que vous pouvez les décharger du shell si nécessaire, et que cela empêche les variables des fonctions de s'introduire dans le shell (une fois que vous avez créé le source d'un fichier de fonction, essayez d'appeler une des variables d'une fonction dans le shell, et vous verrez ce que je veux dire).

Tout d'abord, renommez le fichier .ps1 qui contient toutes vos fonctions en MyFunctions.psm1 (vous venez de créer un module !). Maintenant, pour qu'un module se charge correctement, vous devez faire certaines choses spécifiques avec le fichier. Tout d'abord, pour que Import-Module puisse voir le module (vous utilisez cette cmdlet pour charger le module dans le shell), il doit se trouver à un emplacement spécifique. Le chemin par défaut du dossier des modules est $home \Documents\WindowsPowerShell\Modules.

Dans ce dossier, créez un dossier nommé MyFunctions, et placez-y le fichier MyFunctions.psm1 (le fichier du module doit se trouver dans un dossier portant exactement le même nom que le fichier PSM1).

Une fois que c'est fait, ouvrez PowerShell, et exécutez cette commande :

Get-Module -listavailable

Si vous en voyez un appelé MyFunctions, c'est que vous avez bien fait, et votre module est prêt à être chargé (il s'agit juste de s'assurer que tout est bien configuré, vous ne devez le faire qu'une fois).

Pour utiliser le module, tapez ce qui suit dans le shell (ou mettez cette ligne dans votre $profile, ou mettez cette ligne comme première ligne dans un script) :

Import-Module MyFunctions

Vous pouvez maintenant exécuter vos fonctions. Ce qui est bien, c'est qu'une fois que vous avez 10 à 15 fonctions, vous allez oublier le nom de certaines d'entre elles. Si vous les avez placées dans un module, vous pouvez exécuter la commande suivante pour obtenir la liste de toutes les fonctions de votre module :

Get-Command -module MyFunctions

C'est plutôt sympa, et le petit effort qu'il faut faire pour installer la face avant en vaut BEAUCOUP la peine.

Answer 3

. "$PSScriptRoot\MyFunctions.ps1" MyA1Func

Disponible à partir de la v3, avant cela voir Comment puis-je obtenir l'emplacement du système de fichiers d'un script PowerShell ? . C'est TRÈS courant.

P.S. Je n'adhère pas à la règle du "tout est un module". Mes scripts sont utilisés par d'autres développeurs hors GIT, donc je n'aime pas mettre des trucs à un endroit spécifique ou modifier les variables d'environnement du système avant que mon script ne s'exécute. C'est juste un script (ou deux, ou trois).

Answer 4

Vous pouvez certainement définir des fonctions dans des fichiers script (j'ai ensuite tendance à les charger via mon profil Powershell au chargement).

Tout d'abord, vous devez vérifier que la fonction est chargée en cours d'exécution :

ls function:\ | where { $_.Name -eq "A1"  }

Et vérifiez qu'il apparaît dans la liste (il devrait y avoir une liste de 1 !), puis faites-nous savoir quel résultat vous obtenez !

Answer 5

Vous pouvez ajouter une fonction à :

c:\Users\David\Documents\WindowsPowerShell\profile.ps1

Et la fonction sera disponible.