Menggunakan Visual Studio Code untuk PowerShell Development

Artikel
05/09/2024

Visual Studio Code (VS Code) adalah editor skrip lintas platform oleh Microsoft. Bersama dengan ekstensi PowerShell, ekstensi ini memberikan pengalaman pengeditan skrip yang kaya dan interaktif, sehingga lebih mudah untuk menulis skrip PowerShell yang andal. Visual Studio Code dengan ekstensi PowerShell adalah editor yang direkomendasikan untuk menulis skrip PowerShell.

Ini mendukung versi PowerShell berikut:

PowerShell 7.2 dan yang lebih tinggi (Windows, macOS, dan Linux)
Windows PowerShell 5.1 (khusus Windows) dengan .NET Framework 4.8

Catatan

Visual Studio Code tidak sama dengan Visual Studio.

Memulai

Sebelum memulai, pastikan PowerShell ada di sistem Anda. Untuk beban kerja modern di Windows, macOS, dan Linux, lihat tautan berikut:

Untuk beban kerja Windows PowerShell tradisional, lihat Menginstal Windows PowerShell.

Penting

WINDOWS PowerShell ISE masih tersedia untuk Windows. Namun, ini tidak lagi dalam pengembangan fitur aktif. ISE hanya berfungsi dengan PowerShell 5.1 dan yang lebih lama. Sebagai komponen Windows, ia terus didukung secara resmi untuk keamanan dan perbaikan layanan berprioritas tinggi. kami tidak memiliki rencana untuk menghapus ISE dari Windows.

Menginstal Visual Studio Code dan Ekstensi PowerShell

Menginstal Visual Studio Code. Untuk informasi selengkapnya, lihat gambaran umum Menyiapkan Visual Studio Code.

Ada instruksi penginstalan untuk setiap platform:
Instal Ekstensi PowerShell.
1. Luncurkan aplikasi Visual Studio Code dengan mengetik code di konsol atau code-insiders jika Anda menginstal Insider Visual Studio Code.
2. Luncurkan Buka Cepat di Windows atau Linux dengan menekan Ctrl+P. Di macOS, tekan Cmd+P.
3. Di Buka Cepat, ketik ext install powershell dan tekan Enter.
4. Tampilan Ekstensi terbuka di Bilah Samping. Pilih ekstensi PowerShell dari Microsoft.
5. Klik tombol Instal pada ekstensi PowerShell dari Microsoft.
6. Setelah penginstalan, jika Anda melihat tombol Instal berubah menjadi Muat Ulang, Klik Muat Ulang.
7. Setelah Visual Studio Code dimuat ulang, Anda siap untuk mengedit.

Misalnya, untuk membuat file baru, klik File > Baru. Untuk menyimpannya, klik Simpan File > lalu berikan nama file, seperti HelloWorld.ps1. Untuk menutup file, klik di X samping nama file. Untuk keluar dari Visual Studio Code, Keluar dari File>.

Menginstal Ekstensi PowerShell pada Sistem Terbatas

Beberapa sistem disiapkan untuk memerlukan validasi semua tanda tangan kode. Anda mungkin menerima kesalahan berikut:

Language server startup failed.

Masalah ini dapat terjadi ketika kebijakan eksekusi PowerShell ditetapkan oleh Kebijakan Grup Windows. Untuk menyetujui PowerShell Editor Services dan ekstensi PowerShell untuk Visual Studio Code secara manual, buka perintah PowerShell dan jalankan perintah berikut:

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

Anda diminta dengan Ingin menjalankan perangkat lunak dari penerbit yang tidak tepercaya ini? Ketik A untuk menjalankan file. Kemudian, buka Visual Studio Code dan verifikasi bahwa ekstensi PowerShell berfungsi dengan baik. Jika Anda masih mengalami masalah saat memulai, beri tahu kami dalam masalah GitHub.

Memilih versi PowerShell untuk digunakan dengan ekstensi

Dengan PowerShell menginstal berdampingan dengan Windows PowerShell, sekarang dimungkinkan untuk menggunakan versi PowerShell tertentu dengan ekstensi PowerShell. Fitur ini melihat beberapa jalur terkenal pada sistem operasi yang berbeda untuk menemukan penginstalan PowerShell.

Gunakan langkah-langkah berikut untuk memilih versi:

Buka Palet Perintah di Windows atau Linux dengan Ctrl+Shift+P. Di macOS, gunakan Cmd+Shift+P.
Cari Sesi.
Klik PowerShell: Tampilkan Menu Sesi.
Pilih versi PowerShell yang ingin Anda gunakan dari daftar.

Jika Anda menginstal PowerShell ke lokasi yang tidak biasa, powerShell mungkin awalnya tidak muncul di Menu Sesi. Anda dapat memperluas menu sesi dengan menambahkan jalur kustom Anda sendiri seperti yang dijelaskan di bawah ini.

Menu sesi PowerShell juga dapat diakses dari {} ikon di sudut kanan bawah bilah status. Mengarahkan kumparan atau memilih ikon ini menampilkan pintasan ke menu sesi dan ikon pin kecil. Jika Anda memilih ikon sematkan, nomor versi ditambahkan ke bilah status. Nomor versi adalah pintasan ke menu sesi yang membutuhkan lebih sedikit klik.

Catatan

Menyematkan nomor versi mereplikasi perilaku ekstensi dalam versi Visual Studio Code sebelum 1.65. Rilis 1.65 vs Code mengubah API yang digunakan ekstensi PowerShell dan menstandarkan bilah status untuk ekstensi bahasa.

Pengaturan konfigurasi untuk Visual Studio Code

Pertama, jika Anda tidak terbiasa dengan cara mengubah pengaturan di Visual Studio Code, sebaiknya baca dokumentasi pengaturan Visual Studio Code.

Setelah membaca dokumentasi, Anda dapat menambahkan pengaturan konfigurasi di settings.json.

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

Jika Anda tidak ingin pengaturan ini memengaruhi semua jenis file, VISUAL Code juga mengizinkan konfigurasi per bahasa. Buat pengaturan khusus bahasa dengan menempatkan pengaturan di [<language-name>] bidang. Contohnya:

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

Tip

Untuk informasi selengkapnya tentang pengodean file di Visual Studio Code, lihat Memahami pengodean file. Selain itu, lihat Cara mereplikasi pengalaman ISE di VISUAL Code untuk tips lain tentang cara mengonfigurasi Visual Studio Code untuk pengeditan PowerShell.

Anda dapat menambahkan jalur powerShell lain yang dapat dieksekusi ke menu sesi melalui pengaturan Visual Studio Code: powershell.powerShellAdditionalExePaths.

Anda dapat melakukan ini menggunakan GUI:

Dari pencarian Palet Perintah dan pilih Buka Pengaturan Pengguna. Atau gunakan pintasan keyboard di Windows atau Linux Ctrl+,. Di macOS, gunakan Cmd+,.
Di editor Pengaturan, cari Jalur Exe Tambahan PowerShell.
Klik Tambahkan Item.
Untuk Kunci (di bawah Item), berikan pilihan nama Anda untuk penginstalan PowerShell tambahan ini.
Untuk Nilai (di bawah Nilai), berikan jalur absolut ke executable itu sendiri.

Anda dapat menambahkan jalur tambahan sebanyak yang Anda inginkan. Item yang ditambahkan muncul di menu sesi dengan kunci yang diberikan sebagai nama.

Atau Anda dapat menambahkan pasangan kunci-nilai ke objek powershell.powerShellAdditionalExePaths di :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"
    },
}

Catatan

Sebelum ekstensi versi 2022.5.0, pengaturan ini adalah daftar objek dengan kunci exePath yang diperlukan dan versionName. Perubahan yang melanggar diperkenalkan untuk mendukung konfigurasi melalui GUI. Jika sebelumnya Anda telah mengonfigurasi pengaturan ini, silakan konversikan format baru. Nilai yang diberikan untuk versionName sekarang adalah Kunci, dan nilai yang diberikan untuk exePath sekarang adalah Nilai. Anda dapat melakukan ini dengan lebih mudah dengan mengatur ulang nilai dan menggunakan antarmuka Pengaturan.

Untuk mengatur versi PowerShell default, atur nilai powershell.powerShellDefaultVersion ke teks yang ditampilkan di menu sesi (teks yang digunakan untuk kunci):

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

Setelah Anda mengonfigurasi pengaturan ini, mulai ulang Visual Studio Code atau untuk memuat ulang jendela Visual Studio Code saat ini dari Palet Perintah, ketik Developer: Reload Window.

Jika Anda membuka menu sesi, Anda sekarang melihat penginstalan PowerShell tambahan Anda.

Tip

Jika Anda membangun PowerShell dari sumber, ini adalah cara yang bagus untuk menguji build PowerShell lokal Anda.

Penelusuran kesalahan dengan Visual Studio Code

Penelusuran kesalahan tanpa ruang kerja

Di VS Code versi 1.9 (atau lebih tinggi), Anda dapat men-debug skrip PowerShell tanpa membuka folder yang berisi skrip PowerShell.

Buka file skrip PowerShell dengan File Buka File > ...
Mengatur titik henti - pilih garis lalu tekan F9
Tekan F5 untuk memulai penelusuran kesalahan

Anda akan melihat panel Tindakan debug muncul yang memungkinkan Anda masuk ke debugger, langkah, lanjutkan, dan hentikan penelusuran kesalahan.

Penelusuran kesalahan ruang kerja

Penelusuran kesalahan ruang kerja mengacu pada penelusuran kesalahan dalam konteks folder yang telah Anda buka dari menu File menggunakan Buka Folder.... Folder yang Anda buka biasanya adalah folder proyek PowerShell Anda atau akar repositori Git Anda. Penelusuran kesalahan ruang kerja memungkinkan Anda menentukan beberapa konfigurasi debug selain hanya men-debug file yang saat ini terbuka.

Ikuti langkah-langkah ini untuk membuat file konfigurasi debug:

Buka tampilan Debug di Windows atau Linux dengan menekan Ctrl+Shift+D. Di macOS, tekan Cmd+Shift+D.
Klik tautan buat file launch.json.
Dari perintah Pilih Lingkungan, pilih PowerShell.
Pilih jenis penelusuran kesalahan yang ingin Anda gunakan:
- Luncurkan File Saat Ini - Luncurkan dan debug file di jendela editor yang saat ini aktif
- Luncurkan Skrip - Luncurkan dan debug file atau perintah yang ditentukan
- Sesi Interaktif - Perintah debug yang dijalankan dari Konsol Terintegrasi
- Lampirkan - Lampirkan debugger ke Proses Host PowerShell yang sedang berjalan

Visual Studio Code membuat direktori dan file .vscode\launch.json di akar folder ruang kerja Anda untuk menyimpan konfigurasi debug. Jika file Anda berada di repositori Git, Anda biasanya ingin menerapkan file.launch.json Isi file adalah 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}"
      }
  ]
}

File ini mewakili skenario debug umum. Ketika Anda membuka file ini di editor, Anda akan melihat tombol Tambahkan Konfigurasi... . Anda dapat mengklik tombol ini untuk menambahkan lebih banyak konfigurasi debug PowerShell. Salah satu konfigurasi yang berguna untuk ditambahkan adalah PowerShell: Luncurkan Skrip. Dengan konfigurasi ini, Anda dapat menentukan file yang berisi argumen opsional yang digunakan setiap kali Anda menekan F5 apa pun file mana yang aktif di editor.

Setelah konfigurasi debug dibuat, Anda dapat memilih konfigurasi yang ingin Anda gunakan selama sesi debug. Pilih konfigurasi dari menu drop-down konfigurasi debug di toolbar tampilan Debug .

Pemecahan masalah ekstensi PowerShell

Jika Anda mengalami masalah menggunakan Visual Studio Code untuk pengembangan skrip PowerShell, lihat panduan pemecahan masalah di GitHub.

Sumber daya yang berguna

Ada beberapa video dan posting blog yang mungkin berguna untuk membantu Anda mulai menggunakan ekstensi PowerShell untuk VS Code:

Video

Posting blog

Kode sumber proyek ekstensi PowerShell

Kode sumber ekstensi PowerShell dapat ditemukan di GitHub.

Jika Anda tertarik untuk berkontribusi, Permintaan Pull sangat dihargai. Ikuti bersama dengan dokumentasi pengembang di GitHub untuk memulai.

Bagikan melalui

Menggunakan Visual Studio Code untuk PowerShell Development

Memulai

Menginstal Visual Studio Code dan Ekstensi PowerShell

Menginstal Ekstensi PowerShell pada Sistem Terbatas

Memilih versi PowerShell untuk digunakan dengan ekstensi

Pengaturan konfigurasi untuk Visual Studio Code

Menambahkan jalur PowerShell Anda sendiri ke menu sesi

Penelusuran kesalahan dengan Visual Studio Code

Penelusuran kesalahan tanpa ruang kerja

Penelusuran kesalahan ruang kerja

Pemecahan masalah ekstensi PowerShell

Sumber daya yang berguna

Video

Posting blog

Kode sumber proyek ekstensi PowerShell

Saran dan Komentar

Sumber Daya Tambahan: