Použití editoru Visual Studio Code pro vývoj v PowerShellu

  • Článek

Visual Studio Code (VS Code) je editor skriptů pro různé platformy od Microsoftu. Společně s rozšířením PowerShellu nabízí bohaté prostředí pro úpravy interaktivních skriptů, což usnadňuje psaní spolehlivých skriptů PowerShellu. Visual Studio Code s rozšířením PowerShellu je doporučený editor pro psaní skriptů PowerShellu.

Podporuje následující verze PowerShellu:

  • PowerShell 7.2 a novější (Windows, macOS a Linux)
  • Windows PowerShell 5.1 (jenom windows) s rozhraním .NET Framework 4.8

Poznámka:

Visual Studio Code není totéž jako Visual Studio.

Začínáme

Než začnete, ujistěte se, že v systému existuje PowerShell. Moderní úlohy ve Windows, macOS a Linuxu najdete na následujících odkazech:

Informace o tradičních úlohách Windows PowerShellu najdete v tématu Instalace Prostředí Windows PowerShell.

Důležité

Prostředí ISE windows PowerShellu je stále k dispozici pro Windows. Už ale není ve vývoji aktivních funkcí. IsE funguje jenom s PowerShellem 5.1 a starším. Jako součást Systému Windows se nadále oficiálně podporuje pro opravy údržby s vysokou prioritou a zabezpečení. Nemáme v úmyslu odebrat isE z Windows.

Instalace nástroje VS Code a rozšíření PowerShellu

  1. Nainstalujte editor Visual Studio Code. Další informace najdete v přehledu Nastavení editoru Visual Studio Code.

    Pro každou platformu jsou k dispozici pokyny k instalaci:

  2. Nainstalujte rozšíření PowerShellu.

    1. Spusťte aplikaci VS Code zadáním code do konzoly nebo code-insiders instalací programu Visual Studio Code Insider.
    2. Stisknutím kláves Ctrl+P spusťte rychlé otevření ve Windows nebo Linuxu. V macOS stiskněte Cmd+P.
    3. V rychlém otevření zadejte ext install powershell a stiskněte Enter.
    4. Zobrazení Rozšíření se otevře na bočním panelu. Vyberte rozšíření PowerShellu od Microsoftu.
    5. Klikněte na tlačítko Instalovat v rozšíření PowerShellu od Microsoftu.
    6. Pokud se po instalaci zobrazí tlačítko Nainstalovat znovu načíst, klikněte na Znovu načíst.
    7. Jakmile se VS Code znovu načte, jste připraveni k úpravám.

Chcete-li například vytvořit nový soubor, klepněte na tlačítko Nový> soubor. Chcete-li soubor uložit, klepněte na tlačítko Uložit soubor > a zadejte název souboru, například HelloWorld.ps1. Pokud chcete soubor zavřít, klikněte na X vedle názvu souboru. Pokud chcete VS Code ukončit, ukončete soubor>.

Instalace rozšíření PowerShellu v omezených systémech

Některé systémy jsou nastavené tak, aby vyžadovaly ověření všech podpisů kódu. Může se zobrazit následující chyba:

Language server startup failed.

K tomuto problému může dojít, když zásady spouštění PowerShellu nastaví zásady skupiny systému Windows. Pokud chcete služby Editor Services PowerShellu a rozšíření PowerShellu pro VS Code schválit ručně, otevřete příkazový řádek PowerShellu a spusťte následující příkaz:

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

Zobrazí se výzva k spuštění softwaru od tohoto nedůvěryhodného vydavatele? Zadejte A , aby se soubor spustil. Pak otevřete VS Code a ověřte, že rozšíření PowerShellu funguje správně. Pokud stále máte problémy se zahájením práce, dejte nám vědět v problému s GitHubem.

Volba verze PowerShellu pro použití s rozšířením

S instalací PowerShellu vedle Windows PowerShellu je teď možné použít konkrétní verzi PowerShellu s rozšířením PowerShellu. Tato funkce se zabývá několika známými cestami v různých operačních systémech a zjišťuje instalace PowerShellu.

K výběru verze použijte následující postup:

  1. Otevřete paletu příkazů ve Windows nebo Linuxu pomocí kombinace kláves Ctrl+Shift+P. V macOS použijte Cmd+Shift+P.
  2. Vyhledejte relaci.
  3. Klikněte na PowerShell: Zobrazit nabídku relace.
  4. Ze seznamu zvolte verzi PowerShellu, kterou chcete použít.

Pokud jste powershell nainstalovali do nestandardního umístění, nemusí se zpočátku zobrazovat v nabídce Relace. Nabídku relace můžete rozšířit přidáním vlastních cest , jak je popsáno níže.

K nabídce relace PowerShellu se dostanete také z {} ikony v pravém dolním rohu stavového řádku. Najetím myší na tuto ikonu nebo výběrem této ikony se zobrazí zástupce nabídky relace a malá ikona připnutí. Pokud vyberete ikonu připnutí, číslo verze se přidá na stavový řádek. Číslo verze je zástupce nabídky relace vyžadující méně kliknutí.

Poznámka:

Připnutí čísla verze replikuje chování rozšíření ve verzích VS Code před 1.65. Verze VS Code 1.65 změnila rozhraní API, která rozšíření PowerShellu používá a standardizoval stavový řádek pro rozšíření jazyka.

Nastavení konfigurace pro Visual Studio Code

Pokud nevíte, jak změnit nastavení v editoru VS Code, doporučujeme přečíst si dokumentaci k nastavení editoru Visual Studio Code.

Po přečtení dokumentace můžete přidat nastavení konfigurace do settings.jsonsouboru .

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

Pokud nechcete, aby tato nastavení ovlivnila všechny typy souborů, VS Code také umožňuje konfigurace jednotlivých jazyků. Nastavení specifické pro jazyk vytvoříte tak, že nastavení vložíte [<language-name>] do pole. Příklad:

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

Tip

Další informace o kódování souborů ve VS Code naleznete v tématu Principy kódování souborů. Podívejte se také na postup replikace prostředí ISE ve VS Code , kde najdete další tipy, jak nakonfigurovat VS Code pro úpravy PowerShellu.

Přidání vlastních cest PowerShellu do nabídky relace

Do nabídky relace můžete přidat další spustitelné cesty PowerShellu pomocí nastavení editoru Visual Studio Code: powershell.powerShellAdditionalExePaths.

Můžete to udělat pomocí grafického uživatelského rozhraní:

  1. Na paletě příkazů vyhledejte a vyberte Otevřít Nastavení uživatele. Nebo použijte klávesovou zkratku ve Windows nebo Linuxu Ctrl+. V macOS použijte Cmd,+
  2. V editoru Nastavení vyhledejte další cesty exe powershellu.
  3. Klikněte na Přidat položku.
  4. Pro klíč (v položce) zadejte název pro tuto další instalaci PowerShellu.
  5. Pro hodnotu (v části Hodnota) zadejte absolutní cestu k samotnému spustitelnému souboru.

Můžete přidat libovolný počet dalších cest. Přidané položky se zobrazí v nabídce relace s daným klíčem jako názvem.

Alternativně můžete do objektu v objektu powershell.powerShellAdditionalExePaths přidat páry klíč-hodnota: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"
    },
}

Poznámka:

Před verzí 2022.5.0 rozšíření bylo toto nastavení seznam objektů s požadovanými klíči exePath a versionName. Byla zavedena změna způsobující chybu pro podporu konfigurace prostřednictvím grafického uživatelského rozhraní. Pokud jste toto nastavení nakonfigurovali dříve, převeďte ho do nového formátu. Hodnota zadaná versionName pro je nyní Klíč a hodnota zadaná exePath pro je nyní Hodnota. To můžete udělat snadněji tím, že resetujete hodnotu a použijete rozhraní Nastavení.

Pokud chcete nastavit výchozí verzi PowerShellu, nastavte hodnotu powershell.powerShellDefaultVersion na text zobrazený v nabídce relace (text použitý pro klíč):

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

Po nakonfigurování tohoto nastavení restartujte VS Code nebo znovu načtěte aktuální okno VS Code z palety příkazů, zadejte Developer: Reload Window.

Pokud otevřete nabídku relace, uvidíte teď další instalace PowerShellu.

Tip

Pokud vytváříte PowerShell ze zdroje, je to skvělý způsob, jak otestovat místní sestavení PowerShellu.

Ladění pomocí editoru Visual Studio Code

Ladění bez pracovního prostoru

Ve VS Code verze 1.9 (nebo vyšší) můžete ladit skripty PowerShellu bez otevření složky, která obsahuje skript PowerShellu.

  1. Otevřete soubor skriptu PowerShellu pomocí > souboru Otevřít soubor...
  2. Nastavení zarážky – vyberte čáru a stiskněte klávesu F9.
  3. Stisknutím klávesy F5 spusťte ladění.

Mělo by se zobrazit podokno Akce ladění, které umožňuje rozdělit ladicí program, krok, pokračovat a zastavit ladění.

Ladění pracovního prostoru

Ladění pracovního prostoru odkazuje na ladění v kontextu složky, kterou jste otevřeli z nabídky Soubor pomocí příkazu Otevřít složku.... Složka, kterou otevřete, je obvykle složka projektu PowerShellu nebo kořen úložiště Git. Ladění pracovního prostoru umožňuje definovat více konfigurací ladění, než jen ladění aktuálně otevřeného souboru.

Chcete-li vytvořit konfigurační soubor ladění, postupujte takto:

  1. Stisknutím kombinace kláves Ctrl+Shift+D otevřete zobrazení Ladění ve Windows nebo Linuxu. V systému macOS stiskněte klávesy Cmd+Shift+D.

  2. Klikněte na odkaz vytvořit soubor launch.json .

  3. Na příkazovém řádku Vybrat prostředí zvolte PowerShell.

  4. Zvolte typ ladění, který chcete použít:

    • Spustit aktuální soubor – Spuštění a ladění souboru v aktuálně aktivním okně editoru
    • Spustit skript – Spuštění a ladění zadaného souboru nebo příkazu
    • Interaktivní relace – příkazy ladění spouštěné z integrované konzoly
    • Připojení – připojení ladicího programu ke spuštěném hostitelskému procesu PowerShellu

VS Code vytvoří adresář a soubor .vscode\launch.json v kořenové složce pracovního prostoru pro uložení konfigurace ladění. Pokud jsou vaše soubory v úložišti Git, obvykle chcete soubor potvrdit launch.json . launch.json Obsah souboru:

{
  "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}"
      }
  ]
}

Tento soubor představuje běžné scénáře ladění. Když tento soubor otevřete v editoru, zobrazí se tlačítko Přidat konfiguraci... Kliknutím na toto tlačítko můžete přidat další konfigurace ladění PowerShellu. Jednou z užitečných konfigurací pro přidání je PowerShell: Spustit skript. Pomocí této konfigurace můžete zadat soubor obsahující volitelné argumenty, které se použijí vždy, když stisknete klávesu F5 bez ohledu na to, který soubor je v editoru aktivní.

Po vytvoření konfigurace ladění můžete vybrat konfiguraci, kterou chcete použít během ladicí relace. V rozevíracím seznamu konfigurace ladění na panelu nástrojů zobrazení ladění vyberte konfiguraci.

Řešení potíží s rozšířením PowerShellu

Pokud při vývoji skriptů PowerShellu dochází k problémům s používáním editoru VS Code, prohlédni si průvodce odstraňováním potíží na GitHubu.

Užitečné prostředky

Existuje několik videí a blogových příspěvků, které vám můžou pomoct začít používat rozšíření PowerShellu pro VS Code:

Videa

Příspěvky blogu

Zdrojový kód projektu rozšíření PowerShellu

Zdrojový kód rozšíření PowerShellu najdete na GitHubu.

Pokud máte zájem o přispívání, žádosti o přijetí změn jsou velmi vděčné. Pokud chcete začít, postupujte podle dokumentace pro vývojáře na GitHubu.