Azure Data Studio 拡張機能を作成して機能を拡張する

  • [アーティクル]

Azure Data Studio の拡張機能により、Azure Data Studio の基本インストールにさらに機能を追加する簡単な方法が提供されます。

拡張機能は、Azure Data Studio チーム (Microsoft) と、サード パーティのコミュニティ (お客様) によって提供されます。

拡張機能を作成する

Azure Data Studio の拡張に関心がある場合は、独自の拡張機能を作成して拡張機能ギャラリーに公開することができます。

拡張機能を作成する

前提条件

拡張機能を開発するには、Node.js をインストールし、自分の $PATH で利用できるようにする必要があります。 Node.js には、拡張機能ジェネレーターのインストールに使用される npm (Node.js パッケージ マネージャー) が含まれています。

新しい拡張機能を作成するには、Azure Data Studio 拡張機能ジェネレーターを使用できます。 この Yeoman 拡張機能ジェネレーターは、拡張機能プロジェクトの使用を開始するうえで便利です。 ジェネレーターを開始するには、コマンド プロンプトで次のコマンドを入力します。

npm install -g yo generator-azuredatastudio
yo azuredatastudio

拡張機能テンプレートの使用を開始する方法に関する詳細なガイドについては、キーマップ拡張機能に関する記事を参照してください。この記事では、拡張機能の作成について説明しています。

機能拡張の参照

Azure Data Studio 機能拡張の詳細については、Azure Data Studio の拡張性に関するページを参照してください。 また、既存のサンプルで API を使用する方法の例もご覧いただけます。

拡張機能をデバッグする

Visual Studio Code 拡張機能の Azure Data Studio Debug を使用して、新しい拡張機能をデバッグできます。

拡張機能をデバッグするには:

  1. Visual Studio Code で拡張機能を開きます。
  2. Azure Data Studio Debug 拡張機能をインストールします。
  3. F5 を選択するか、 [デバッグ] アイコンを選択し、 [開始] を選択します。
  4. Azure Data Studio の新しいインスタンスが特別なモード (拡張機能開発ホスト) で起動します。 この新しいインスタンスによって拡張機能が認識されるようになります。

拡張機能パッケージを作成する

拡張機能を作成した後は、Azure Data Studio にインストールされる VSIX パッケージを作成する必要があります。 vscode-vsce (Visual Studio Code Extensions) を使用して、VSIX パッケージを作成できます。

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

VSIX パッケージを使用すると、.vsix ファイルを共有し、コマンド パレットからコマンド Extensions:Install From VSIX File を使用して拡張機能を Azure Data Studio にインストールすることで、拡張機能をローカルおよびプライベートに共有することができます。

拡張機能を公開する

Azure Data Studio に新しい拡張機能を公開するには、次の操作を行います。

  1. 拡張機能を拡張機能ギャラリーに追加します。
  2. 現在、サードパーティの拡張機能のホストはサポートされていません。 拡張機能をダウンロードする代わりに、Azure Data Studio にはダウンロード ページを参照するオプションがあります。 拡張機能のダウンロード ページを設定するには、アセット Microsoft.AzureDataStudio.DownloadPage の値を設定します。
  3. リリース/拡張機能ブランチに対して PR を作成します。
  4. 校閲リクエストをチームに送信します。

拡張機能が確認され、拡張機能ギャラリーに追加されます。

拡張機能の更新プログラムの公開

更新プログラムを公開するプロセスは、拡張機能の公開と同様です。 バージョンが package.json で更新されていることを確認します。

次のステップ

作業を開始するための詳細な手順については、次のいずれかの拡張機能作成チュートリアルを参照してください。