Partager via

Utilisation de Visual Studio Code pour le développement PowerShell

Visual Studio Code (VS Code) est un éditeur de script multiplateforme de Microsoft. Avec l’extension PowerShell , elle offre une expérience d’édition de script riche et interactive, ce qui facilite l’écriture de scripts PowerShell fiables. Visual Studio Code avec l’extension PowerShell est l’éditeur recommandé pour l’écriture de scripts PowerShell.

Il prend en charge les versions PowerShell suivantes :

  • PowerShell 7.2 et versions ultérieures (Windows, macOS et Linux)
  • Windows PowerShell 5.1 (Windows uniquement) avec .NET Framework 4.8

Remarque

Visual Studio Code n’est pas identique à Visual Studio.

Commencer

Avant de commencer, vérifiez que PowerShell existe sur votre système. Pour les charges de travail modernes sur Windows, macOS et Linux, consultez les liens suivants :

Pour les charges de travail Windows PowerShell traditionnelles, consultez Installation de Windows PowerShell.

Important

Le Windows PowerShell ISE est toujours disponible pour Windows. Toutefois, elle n'est plus en développement actif de fonctionnalités. L’ISE fonctionne uniquement avec PowerShell 5.1 et versions antérieures. En tant que composant de Windows, il continue d’être officiellement pris en charge pour les correctifs de maintenance de sécurité et de haute priorité. nous n’avons pas l’intention de supprimer l’ISE de Windows.

Installer VS Code et l’extension PowerShell

  1. Installez Visual Studio Code. Pour plus d’informations, consultez la vue d’ensemble Configuration de Visual Studio Code.

    Il existe des instructions d’installation pour chaque plateforme :

  2. Installez l’extension PowerShell.

    1. Lancez l’application VS Code en tapant code dans une console ou code-insiders si vous avez installé Visual Studio Code Insiders.
    2. Lancez Ouverture Rapide sur Windows ou Linux en appuyant sur Ctrl+P. Sur macOS, appuyez sur Cmd+P.
    3. Dans Quick Open, tapez ext install powershell, puis appuyez sur Entrée.
    4. La vue Extensions s’ouvre dans la barre latérale. Sélectionnez l’extension PowerShell à partir de Microsoft.
    5. Cliquez sur le bouton Installer sur l’extension PowerShell de Microsoft.
    6. Après l'installation, si le bouton Installer se transforme en Recharger, cliquez sur Recharger.
    7. Une fois que VS Code a rechargé, vous êtes prêt à modifier.

Par exemple, pour créer un fichier, cliquez sur Fichier > Nouveau. Pour l’enregistrer, cliquez sur Fichier > Enregistrer, puis fournissez un nom de fichier, tel que HelloWorld.ps1. Pour fermer le fichier, cliquez sur le X en regard du nom de fichier. Pour quitter VS Code, cliquez sur Fichier > Quitter.

Installation de l’extension PowerShell sur des systèmes restreints

Certains systèmes sont configurés pour exiger la validation de toutes les signatures de code. Vous pouvez recevoir l’erreur suivante :

Language server startup failed.

Ce problème peut se produire lorsque la stratégie d’exécution de PowerShell est définie par la stratégie de groupe Windows. Pour approuver manuellement les services d’éditeur PowerShell et l’extension PowerShell pour VS Code, ouvrez une invite PowerShell et exécutez la commande suivante :

Import-Module $HOME\.vscode\extensions\ms-vscode.powershell*\modules\PowerShellEditorServices\PowerShellEditorServices.psd1

Vous êtes invité à utiliser Voulez-vous exécuter des logiciels à partir de cet éditeur non approuvé ? Tapez A pour exécuter le fichier. Ensuite, ouvrez VS Code et vérifiez que l’extension PowerShell fonctionne correctement. Si vous rencontrez encore des problèmes pour démarrer, indiquez-le nous dans un problème GitHub.

Choix d’une version de PowerShell à utiliser avec l’extension

Avec l’installation côte à côte de PowerShell avec Windows PowerShell, il est désormais possible d’utiliser une version spécifique de PowerShell avec l’extension PowerShell. Cette fonctionnalité examine quelques chemins connus sur différents systèmes d’exploitation pour découvrir les installations de PowerShell.

Procédez comme suit pour choisir la version :

  1. Ouvrez la Palette de commandes sous Windows ou Linux en appuyant sur Ctrl+Maj+P. Sur macOS, utilisez Cmd+Maj+P.
  2. Recherchez Session.
  3. Cliquez sur PowerShell : afficher le menu Session.
  4. Choisissez la version de PowerShell que vous souhaitez utiliser dans la liste.

Si vous avez installé PowerShell à un emplacement non classique, il se peut qu’il ne s’affiche pas initialement dans le menu Session. Vous pouvez étendre le menu de session en ajoutant vos propres chemins personnalisés comme décrit ci-dessous.

Le menu de session PowerShell est également accessible à partir de l’icône {} dans le coin inférieur droit de la barre d’état. Le pointage ou la sélection de cette icône affiche un raccourci vers le menu de session et une petite icône d’épingle. Si vous sélectionnez l’icône d’épingle, le numéro de version est ajouté à la barre d’état. Le numéro de version est un raccourci vers le menu de session nécessitant moins de clics.

Remarque

L’épinglage du numéro de version réplique le comportement de l’extension dans les versions de VS Code antérieure à la version 1.65. La version 1.65 de VS Code a modifié les API que l’extension PowerShell utilise et normalisé la barre d’état pour les extensions de langage.

Paramètres de configuration pour Visual Studio Code

Tout d’abord, si vous n’êtes pas familiarisé avec le changement des paramètres dans VS Code, nous vous recommandons de lire la documentation sur les paramètres de Visual Studio Code.

Après avoir lu la documentation, vous pouvez ajouter des paramètres de configuration dans settings.json.

{
    "editor.renderWhitespace": "all",
    "editor.renderControlCharacters": true,
    "files.trimTrailingWhitespace": true,
    "files.encoding": "utf8bom",
    "files.autoGuessEncoding": true
}

Si vous ne souhaitez pas que ces paramètres affectent tous les types de fichiers, VS Code autorise également les configurations par langage. Créez un paramètre spécifique à la langue en plaçant les paramètres dans un champ [<language-name>]. Par exemple:

{
    "[powershell]": {
        "files.encoding": "utf8bom",
        "files.autoGuessEncoding": true
    }
}

Conseil

Pour plus d’informations sur l’encodage de fichiers dans VS Code, consultez Understanding file encoding. Découvrez également Comment répliquer l’expérience ISE dans VS Code pour obtenir d’autres conseils sur la configuration de VS Code pour la modification de PowerShell.

Ajout de vos propres chemins PowerShell au menu de session

Vous pouvez ajouter d'autres chemins d'accès exécutables de PowerShell au menu de session par le biais du paramètre Visual Studio Code: powershell.powerShellAdditionalExePaths.

Pour ce faire, utilisez l’interface graphique utilisateur :

  1. Dans la palette de commandes recherchez et sélectionnez Ouvrir les paramètres utilisateur. Ou utilisez le raccourci clavier sur Windows ou Linux Ctrl+,. Sur macOS, utilisez +Cmd ,.
  2. Dans l’éditeur Paramètres, recherchez les chemins de fichiers exécutables supplémentaires PowerShell.
  3. Cliquez sur Ajouter un élément.
  4. Pour la Clé (sous Élément), indiquez le nom de votre choix pour cette installation PowerShell supplémentaire.
  5. Pour la Valeur (sous Valeur), fournissez le chemin absolu du fichier exécutable lui-même.

Vous pouvez ajouter autant de chemins d’accès supplémentaires que vous le souhaitez. Les éléments ajoutés s’affichent dans le menu de session avec la clé donnée comme nom.

Vous pouvez également ajouter des paires clé-valeur à l’objet powershell.powerShellAdditionalExePaths dans votre settings.json:

{
    "powershell.powerShellAdditionalExePaths": {
        "Downloaded PowerShell": "C:/Users/username/Downloads/PowerShell/pwsh.exe",
        "Built PowerShell": "C:/Users/username/src/PowerShell/src/powershell-win-core/bin/Debug/net6.0/win7-x64/publish/pwsh.exe"
    },
}

Remarque

Avant la version 2022.5.0 de l’extension, ce paramètre était une liste d’objets avec les clés requises exePath et versionName. Une modification majeure a été introduite pour prendre en charge la configuration via l'interface graphique. Si vous aviez précédemment configuré ce paramètre, convertissez-le au nouveau format. La valeur donnée pour versionName est maintenant la cléet la valeur donnée pour exePath est maintenant la valeur . Vous pouvez le faire plus facilement en réinitialisant la valeur et en utilisant l’interface Paramètres.

Pour définir la version PowerShell par défaut, définissez la valeur powershell.powerShellDefaultVersion sur le texte affiché dans le menu de session (texte utilisé pour la clé) :

{
    "powershell.powerShellAdditionalExePaths": {
        "Downloaded PowerShell": "C:/Users/username/Downloads/PowerShell/pwsh.exe",
    },
    "powershell.powerShellDefaultVersion": "Downloaded PowerShell",
}

Une fois que vous avez configuré ce paramètre, redémarrez VS Code ou rechargez la fenêtre VS Code actuelle à partir de la palette de commandes , tapez Developer: Reload Window.

Si vous ouvrez le menu de session, vous voyez maintenant vos installations PowerShell supplémentaires.

Conseil

Si vous générez PowerShell à partir de la source, il s’agit d’un excellent moyen de tester votre build locale de PowerShell.

Débogage avec Visual Studio Code

Débogage sans espace de travail

Dans VS Code version 1.9 (ou ultérieure), vous pouvez déboguer des scripts PowerShell sans ouvrir le dossier qui contient le script PowerShell.

  1. Ouvrez le fichier de script PowerShell avec Fichier > Ouvrir le fichier...
  2. Définir un point d’arrêt : sélectionnez une ligne, puis appuyez sur F9
  3. Appuyez sur F5 pour démarrer le débogage

Vous devez voir le volet d’actions de débogage qui permet de s’arrêter dans le débogueur, d’effectuer un pas à pas détaillé, de reprendre et d’arrêter le débogage.

Débogage d’espace de travail

Le débogage de l’espace de travail fait référence au débogage dans le contexte d’un dossier que vous avez ouvert à partir du menu Fichier à l’aide de Ouvrir le dossier.... Le dossier que vous ouvrez est généralement votre dossier de projet PowerShell ou la racine de votre dépôt Git. Le débogage de l’espace de travail vous permet de définir plusieurs configurations de débogage autres que le débogage du fichier actuellement ouvert.

Suivez ces étapes pour créer un fichier de configuration de débogage :

  1. Ouvrez la vue Déboguer sur Windows ou Linux en appuyant sur Ctrl+Maj+D. Sur macOS, appuyez sur Cmd+Maj+D.

  2. Cliquez sur le lien pour créer un fichier launch.json.

  3. À partir de l’invite Sélectionner l’environnement, choisissez PowerShell.

  4. Choisissez le type de débogage que vous souhaitez utiliser :

    • Lancer le fichier actif - Lancer et déboguer le fichier dans la fenêtre d’éditeur actuellement active
    • lancer le script - Lancer et déboguer le fichier ou la commande spécifiés
    • Session interactive : déboguer les commandes exécutées à partir de la console intégrée
    • Attacher : attacher le débogueur à un processus hôte PowerShell en cours d’exécution

VS Code crée un répertoire et un fichier .vscode\launch.json à la racine du dossier de votre espace de travail pour stocker la configuration de débogage. Si vos fichiers se trouvent dans un référentiel Git, vous souhaitez généralement valider le fichier launch.json. Le contenu du fichier launch.json est le suivant :

{
  "version": "0.2.0",
  "configurations": [
      {
          "type": "PowerShell",
          "request": "launch",
          "name": "PowerShell Launch (current file)",
          "script": "${file}",
          "args": [],
          "cwd": "${file}"
      },
      {
          "type": "PowerShell",
          "request": "attach",
          "name": "PowerShell Attach to Host Process",
          "processId": "${command.PickPSHostProcess}",
          "runspaceId": 1
      },
      {
          "type": "PowerShell",
          "request": "launch",
          "name": "PowerShell Interactive Session",
          "cwd": "${workspaceRoot}"
      }
  ]
}

Ce fichier représente les scénarios de débogage courants. Lorsque vous ouvrez ce fichier dans l’éditeur, vous voyez un bouton Ajouter une configuration.... Vous pouvez cliquer sur ce bouton pour ajouter d’autres configurations de débogage PowerShell. Une configuration utile à ajouter est PowerShell : lancer le script. Avec cette configuration, vous pouvez spécifier un fichier contenant des arguments facultatifs utilisés chaque fois que vous appuyez sur F5 quel que soit le fichier actif dans l’éditeur.

Une fois la configuration de débogage établie, vous pouvez sélectionner la configuration que vous souhaitez utiliser pendant une session de débogage. Sélectionnez une configuration dans la liste déroulante de la configuration de débogage, dans la barre d’outils de la vue Déboguer.

Résolution des problèmes liés à l’extension PowerShell

Si vous rencontrez des problèmes à l’aide de VS Code pour le développement de scripts PowerShell, consultez le guide de résolution des problèmes sur GitHub.

Ressources utiles

Il existe quelques vidéos et billets de blog qui peuvent être utiles pour vous aider à utiliser l’extension PowerShell pour VS Code :

Vidéos

Articles de blog

Code source du projet d’extension PowerShell

Le code source de l’extension PowerShell est disponible sur GitHub .

Si vous souhaitez contribuer, les pull requests sont grandement appréciées. Pour commencer, suivez les instructions de la documentation du développeur sur GitHub.