Memperluas fungsionalitas dengan membuat ekstensi Azure Data Studio

  • Artikel

Ekstensi di Azure Data Studio menyediakan cara mudah untuk menambahkan lebih banyak fungsionalitas ke penginstalan Azure Data Studio dasar.

Ekstensi disediakan oleh tim Azure Data Studio (Microsoft), serta komunitas pihak ketiga (Anda!).

Menulis ekstensi

Jika tertarik untuk memperluas Azure Data Studio, Anda dapat membuat ekstensi Anda sendiri dan menerbitkannya ke galeri ekstensi.

Menulis ekstensi

Prasyarat

Untuk mengembangkan ekstensi, Anda memerlukan Node.js terinstal dan tersedia di .$PATH Node.js mencakup npm, Node.js Package Manager, yang digunakan untuk menginstal generator ekstensi.

Untuk membuat ekstensi baru, Anda dapat menggunakan generator ekstensi Azure Data Studio. Generator ekstensi Yeoman adalah titik awal yang bermanfaat untuk proyek ekstensi. Untuk memulai generator, masukkan perintah berikut dalam prompt perintah:

npm install -g yo generator-azuredatastudio
yo azuredatastudio

Untuk panduan mendalam tentang cara memulai templat ekstensi Anda, lihat ekstensi keymap, yang memandu Anda melalui pembuatan ekstensi.

Referensi ekstensibilitas

Untuk mempelajari tentang ekstensibilitas Azure Data Studio, lihat Gambaran umum ekstensibilitas. Anda juga dapat melihat contoh cara menggunakan API dalam sampel yang ada.

Men-debug ekstensi

Anda dapat men-debug ekstensi baru dengan menggunakan ekstensi Visual Studio Code Azure Data Studio Debug.

Untuk men-debug ekstensi Anda:

  1. Buka ekstensi Anda dengan Visual Studio Code.
  2. Instal ekstensi Azure Data Studio Debug.
  3. Pilih F5, atau pilih ikon Debug lalu pilih Mulai.
  4. Instans baru Azure Data Studio dimulai dalam mode khusus (Host Pengembangan Ekstensi). Instans baru ini sekarang menyadari ekstensi Anda.

Membuat paket ekstensi

Setelah menulis ekstensi, Anda perlu membuat paket VSIX yang diinstal di Azure Data Studio. Anda dapat menggunakan vscode-vsce (Ekstensi Visual Studio Code) untuk membuat paket VSIX.

npm install -g @vscode/vsce
cd myExtensionName
vsce package
# The myExtensionName.vsix file has now been generated

Dengan paket VSIX, Anda dapat berbagi ekstensi secara lokal dan privat dengan berbagi file .vsix dan menggunakan perintah Ekstensi: Instal Dari File VSIX dari palet perintah untuk menginstal ekstensi di Azure Data Studio.

Menerbitkan ekstensi

Untuk menerbitkan ekstensi baru Anda ke Azure Data Studio:

  1. Tambahkan ekstensi Anda ke galeri ekstensi.
  2. Saat ini kami tidak memiliki dukungan untuk menghosting ekstensi pihak ketiga. Alih-alih mengunduh ekstensi, Azure Data Studio memiliki opsi untuk menelusuri ke halaman unduhan. Untuk mengatur halaman unduhan untuk ekstensi Anda, atur nilai aset Microsoft.AzureDataStudio.DownloadPage.
  3. Buat PR terhadap cabang rilis/ekstensi.
  4. Kirim permintaan peninjauan ke tim.

Ekstensi Anda akan ditinjau dan ditambahkan ke galeri ekstensi.

Menerbitkan pembaruan ekstensi

Proses untuk menerbitkan pembaruan mirip dengan menerbitkan ekstensi. Pastikan versi diperbarui di package.json.

Langkah berikutnya

Lihat salah satu tutorial penulisan ekstensi berikut untuk instruksi langkah demi langkah tentang cara memulai: