Sdílet prostřednictvím

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 PowerShelluposkytuje bohaté a interaktivní prostředí pro úpravy 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í Windows PowerShell ISE 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 Windows zůstává oficiálně podporován pro zabezpečení a opravy údržby s vysokou prioritou. Nemáme v úmyslu odebrat isE z Windows.

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

  1. Nainstalujte Visual Studio Code. Další informace najdete v přehledu Nastavení nástroje 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 v konzoli nebo code-insiders, pokud jste nainstalovali Visual Studio Code Insiders.
    2. Spusťte Rychlé otevření ve Windows nebo Linuxu stisknutím kláves Ctrl+P. 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. V rozšíření PowerShellu od Microsoftu klikněte na tlačítko Nainstalovat.
    6. Pokud po instalaci uvidíte, že se tlačítko Nainstalovat změní na 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 Soubor > Nový. Chcete-li soubor uložit, klepněte na tlačítko Soubor > Uložit a zadejte název souboru, například HelloWorld.ps1. Pokud chcete soubor zavřít, klikněte na X vedle názvu souboru. Pokud chcete ukončit VS Code, File > Exit.

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ž je zásada spouštění PowerShellu nastavena skupinovými zásadami 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

Jste vyzváni: Chcete spustit software od tohoto nedůvěryhodného vydavatele? Zadejte A, pokud chcete soubor spustit. 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 prostřednictvím problému na GitHubu .

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í kláves Ctrl+Shift+P. V macOS použijte Cmd+Shift+P.
  2. Vyhledejte relaci.
  3. Klikněte na PowerShell: Zobrazte 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. Menu relace můžete rozšířit přidáním vlastních cest dle popisu níže.

V pravém dolním rohu stavového řádku se můžete k nabídce relace PowerShellu dostat také z ikony {}. Nadjetím myší na tuto ikonu nebo jejím výběrem se zobrazí zástupce nabídky sezení a malá ikona připnutí. Pokud vyberete ikonu s připínáčkem, číslo verze se přidá na stavový řádek. Číslo verze slouží jako zkratka k nabídce relace, která vyžaduje 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

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

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

{
    "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 můžete vytvořit tak, že nastavení vložíte do pole [<language-name>]. Například:

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

Spropitné

Další informace o kódování souborů v nástroji VS Code naleznete v tématu Principy kódování souborů. Podívejte se také na Jak replikovat prostředí integrovaného skriptovacího prostředí (ISE) v nástroji VS Code pro další tipy, jak konfigurovat editor VS Code pro úpravy PowerShellu.

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

Do menu relace můžete přidat další cesty k spustitelným souborům PowerShellu prostřednictvím nastavení Visual Studio Code: powershell.powerShellAdditionalExePaths.

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

  1. Z palety příkazů vyhledejte a zvolte Otevřít uživatelská nastavení. Nebo použijte klávesovou zkratku ve Windows nebo Linuxu Ctrl+,. V systému macOS použijte Cmd+,.
  2. V editoru Nastavení vyhledejte Dodatečné cesty EXE pro PowerShell.
  3. Klikněte na Přidat položku.
  4. Pro klíče (v části Položka) zadejte název této další instalace PowerShellu.
  5. Pro hodnotu (pod hodnotou ) 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.

Případně můžete do svého objektu settings.jsonpřidat páry klíč-hodnota powershell.powerShellAdditionalExePaths.

{
    "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í seznamem objektů s požadovanými klíči exePath a versionName. Byla zavedena zásadní změna 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á pro versionName je nyní klíča hodnota zadaná pro exePath je nyní Hodnota. To můžete udělat snadněji resetováním hodnoty a pomocí 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 editoru VS Code z palety příkazů , zadejte Developer: Reload Window.

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

Spropitné

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 Soubor > Otevřít soubor...
  2. Nastavte bod přerušení – vyberte řádek a stiskněte F9
  3. Stisknutím klávesy F5 spusťte ladění.

Mělo by se zobrazit podokno Akce ladění, které vám umožní přerušit ladicí program, krokovat, pokračovat v ladění a zastavit jej.

Ladění pracovního prostoru

Ladění pracovního prostoru se týká ladění v kontextu složky, kterou jste otevřeli z nabídky Soubor pomocí možnosti Otevřít složku.... Složka, kterou otevřete, je obvykle složka projektu PowerShell nebo prvotní složka ú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 kláves Ctrl+Shift+Dotevřete zobrazení ladění ladění ve Windows nebo Linuxu. V macOS stiskněte Cmd+Shift+D.

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

  3. V rozhraní Vyberte prostředí zvolte PowerShell.

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

    • Spustit aktuální soubor – spusťte a ladit soubor v aktuálně aktivním okně editoru.
    • spuštění skriptu – spuštění a ladění zadaného souboru nebo příkazu
    • Interaktivní relace – Příkazy ladění spuštěné z integrované konzole
    • Připojit – Připojte ladicí program ke spuštěnému hostitelskému procesu PowerShell.

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 potvrdit launch.json soubor. Obsah souboru launch.json:

{
  "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í při každém stisknutí F5 bez ohledu na to, který soubor je v editoru aktivní.

Po vytvoření konfigurace ladění můžete zvolit konfiguraci, kterou chcete použít během ladicí relace. Vyberte konfiguraci z rozevíracího seznamu konfigurace ladění na panelu nástrojů zobrazení Ladění okna.

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

Pokud máte problémy s používáním nástroje VS Code pro vývoj skriptů PowerShellu, prohlédni si průvodce odstraňováním potíží na GitHubu.

Užitečné zdroje informací

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

Blogové příspěvky

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.