VSIX プロジェクトを操作する

VSIX プロジェクトは、Visual Studio 拡張機能を配布するためにパッケージ化する標準的な方法です。 VisualStudio.Extensibility 拡張機能を構築する場合でも、VSSDK ベースの拡張機能を構築する場合でも、出力は、拡張機能マネージャーまたは Visual Studio Marketplace を使用してユーザーがインストールする .vsix ファイルになります。

Important

この記事では、以前の VSIX プロジェクト テンプレートと、既存のパッケージ 化プロジェクトの維持について説明します。 Visual Studio 18.11 以降の新しいプロジェクトでは、VSIX のパッケージ化を処理するモダン VSIX Project テンプレートを使用してください。 これらは連続したステップではなく、代替のプロジェクト ワークフローです。 拡張機能がターゲットとするVisual Studioバージョンだけでなく、開発環境と既存のプロジェクトに基づいて選択してください。

VSIX プロジェクトを作成する

VSIX プロジェクト テンプレートは、新しいプロジェクトの作成 ダイアログで利用できます。 見つけるには、「VSIX」を検索します。

  • VisualStudio.Extensibility Extension — 新しい機能拡張モデルを使用するアウトプロセス拡張機能の場合。
  • VSIX Project — VSSDK ベースの拡張機能の場合、または複数の拡張機能出力をラップする場合。
  • VSSDK との互換性のある VisualStudio.Extensibility 拡張機能 — 両方のモデルを使用するハイブリッド拡張機能の場合。
  • 空の VSIX Project — 既存のコンポーネントをパッケージ化するための空の VSIX コンテナー。

Tip

新しい拡張機能の場合は、Visual Studio 18.11 以降と 最新の VSIX プロジェクト テンプレート を推奨します。 そのモデルでサポートされている機能には VisualStudio.Extensibility (Out-Of-Process) を選択します。インプロセス API が必要な場合にのみ、VSSDK またはハイブリッド オプションを選択します。 以前の Visual Studio バージョンでは、VisualStudio.Extensibility Extension テンプレート、または VSSDK API が必要な場合は VSSDK 互換テンプレートを使用します。

VSIX プロジェクトのパッケージ拡張機能

Note

source.extension.vsixmanifest ファイルと以下の手順は、VSSDK とハイブリッド拡張機能にのみ適用されます。 VisualStudio.Extensibility (アウトプロセス) 拡張機能は、コード内の ExtensionConfiguration.Metadata からメタデータを生成します。マニフェスト ファイルは必要ありません。

既存の拡張機能またはコンポーネントは、VSIX プロジェクトでラップすることでパッケージ化できます。

  1. 上記のいずれかのテンプレートを使用して、VSIX プロジェクトを作成してください。
  2. source.extension.vsixmanifest ファイルはマニフェスト デザイナーで開かれます。
  3. [アセット]タブで、[新規]を選択してコンポーネントを追加します。
  4. [ 種類 ] リストで、追加する資産の種類 ( Microsoft.VisualStudio.MefComponent、 Microsoft.VisualStudio.VsPackageなど) を選択します。
  5. ソース を 現在のソリューション内のプロジェクト に設定し、プロジェクトを選択します。

VSIX 形式では、VSPackage、MEF コンポーネント、アセンブリ、プロジェクト テンプレート、項目テンプレート、ツールボックス コントロール、およびカスタム拡張機能の種類のパッケージ化がサポートされています。

VSIX パッケージに依存関係を追加する

依存関係として他の拡張機能を要求するように VSIX を構成できます。 ユーザーが拡張機能をインストールすると、インストーラーは必要なすべての依存関係が存在することを確認します。

依存関係を追加するには:

  1. source.extension.vsixmanifest ビューで を開きます。
  2. [ 依存関係 ] タブに移動し、[ 新規] を選択します。
  3. [ インストール済みの拡張機能 ] を選択して、既にインストールされている拡張機能から依存関係を選択するか、ファイル システム上のファイル を選択して別の VSIX を直接参照します。

特定のVisual Studioバージョンが必要

最小Visual Studioビルド番号をターゲットにするには、InstallationTargetバージョン範囲を設定します。

<Installation>
  <InstallationTarget Id="Microsoft.VisualStudio.Community" Version="[17.0,)" />
</Installation>

Note

Visual Studio 2026 以降では、バージョン範囲の下限のみが評価されます。 上限は互換性のために無視されます。 拡張機能の互換性を参照してください。

拡張機能パックを作成する

拡張機能パックは、一緒にインストールできる一連の拡張機能です。 拡張機能パックを使用すると、お気に入りの拡張機能を同僚と共有したり、シナリオに合わせて一連の拡張機能をバンドルしたりできます。

拡張機能パックを作成するには:

  1. 新しい VSIX Projectを作成します。
  2. ソリューション エクスプローラーでプロジェクトを右クリックし、[追加>新しい項目] を選択します。
  3. Extension Pack テンプレートを選択します。 これにより、 .vsext ファイルが追加されます。
  4. .vsext ファイルを編集して、含める拡張子を一覧表示します。
{
  "id": "MyExtensionPack",
  "name": "My Extension Pack",
  "description": "A curated set of extensions for my team",
  "version": "1.0.0.0",
  "extensions": [
    {
      "vsixId": "41858b2d-ff0b-4a43-80b0-f1b2d6084935",
      "name": "AlignAssignments"
    },
    {
      "vsixId": "42374550-426a-400e-96f9-237682e8dea6",
      "name": "CopyAsHtml"
    }
  ]
}
  1. Visual Studio Marketplace ↗ で vsixId を見つける — 拡張機能ページを開き、[ID のコピー] を選択します。
  2. プロジェクトをビルドして発行します。 「Marketplace に公開」を参照してください。

Note

拡張機能パックでは、Visual Studio Marketplace またはプライベート ギャラリーで利用可能な拡張機能のみをインストールできます。

拡張機能アーキテクチャの概要

Visual Studio で拡張機能を読み込む方法を理解することは、パッケージ化とデプロイの意思決定を改善するのに役立ちます。

VisualStudio.Extensibility (アウトプロセス)

アウトプロセス拡張機能は、Visual Studioとは別のプロセスで実行され、JSON-RPC チャネル経由で通信します。

┌─────────────────────┐       JSON-RPC        ┌──────────────────────┐
│   Visual Studio     │◄─────────────────────►│  Extension Process   │
│   (DevEnv.exe)      │                        │  (.NET 8+)           │
│                     │                        │                      │
│  ┌───────────────┐  │                        │  ┌────────────────┐  │
│  │ Extension Host│  │                        │  │ Your Extension │  │
│  │ (manages      │  │                        │  │ Code           │  │
│  │  lifecycle)   │  │                        │  └────────────────┘  │
│  └───────────────┘  │                        └──────────────────────┘
└─────────────────────┘

主な特性:

  • 拡張機能はモダンな .NET (8 以降) で動作します
  • 拡張機能プロセスがクラッシュしても、Visual Studio がクラッシュする可能性は低くなります
  • VS を再起動せずに インストール/アンインストールする
  • ユーザーごとのインストール (管理者は不要)

VSSDK/ハイブリッド (インプロセス)

インプロセス拡張機能は、Visual Studio プロセスに直接読み込まれます。

┌──────────────────────────────────────────┐
│   Visual Studio (DevEnv.exe)             │
│                                          │
│  ┌────────────────┐  ┌────────────────┐  │
│  │ VS Core        │  │ Your Extension │  │
│  │ Services       │◄─┤ (.NET Framework│  │
│  │                │  │  or hybrid)    │  │
│  └────────────────┘  └────────────────┘  │
└──────────────────────────────────────────┘

主な特性:

  • すべての VS API とサービスへのフル アクセス
  • .NET Framework に限定(ハイブリッドの場合を除き)
  • 拡張機能のバグが VS の安定性に影響する可能性がある
  • インストール/更新時に VS 再起動 が必要

.vsix パッケージの内容

.vsix ファイルは、標準構造の ZIP アーカイブです。 内容は拡張モデルによって異なります。

コンポーネント VisualStudio.Extensibility VSSDK
拡張機能のメタデータ ExtensionConfiguration コード内 source.extension.vsixmanifest
拡張バイナリ お使いの .NET 8+ DLLs お使いの .NET Framework DLL
ローカリゼーション ファイル .vsextension/string-resources.json .vsixlangpack ファイル
コンテンツの種類 [Content_Types].xml [Content_Types].xml
パッケージ マニフェスト 自動生成 extension.vsixmanifest 手動作成 source.extension.vsixmanifest