拡張機能の構造

前のトピックでは、基本的な拡張機能を実行できました。これはどのように機能するのでしょうか。

Hello World 拡張機能は 3 つのことを行います。

onCommand アクティベーションイベント: onCommand:helloworld.helloWorld を登録します。これにより、ユーザーが Hello World コマンドを実行すると拡張機能がアクティブになります。
注: VS Code 1.74.0 以降では、package.json の commands セクションで宣言されたコマンドは、明示的な activationEvents に onCommand エントリを必要とせずに、呼び出されると自動的に拡張機能をアクティブにします。
contributes.commands コントリビューションポイント を使用して、コマンド Hello World をコマンドパレットで使用できるようにし、コマンド ID helloworld.helloWorld にバインドします。
commands.registerCommand VS Code API を使用して、関数を登録されたコマンド ID helloworld.helloWorld にバインドします。

これらの 3 つの概念を理解することは、VS Code で拡張機能を記述する上で非常に重要です。

アクティベーションイベント: 拡張機能がアクティブになるイベント。
コントリビューションポイント: VS Code を拡張するために package.json 拡張機能マニフェストで行う静的な宣言。
VS Code API: 拡張機能コードで呼び出すことができる JavaScript API のセット。

一般的に、拡張機能はコントリビューションポイントと VS Code API の組み合わせを使用して、VS Code の機能を拡張します。拡張機能の機能の概要トピックは、拡張機能に適したコントリビューションポイントと VS Code API を見つけるのに役立ちます。

Hello World サンプルのソースコードを詳しく見て、これらの概念がどのように適用されるかを見てみましょう。

拡張機能のファイル構造

.
├── .vscode
│   ├── launch.json     // Config for launching and debugging the extension
│   └── tasks.json      // Config for build task that compiles TypeScript
├── .gitignore          // Ignore build output and node_modules
├── README.md           // Readable description of your extension's functionality
├── src
│   └── extension.ts    // Extension source code
├── package.json        // Extension manifest
├── tsconfig.json       // TypeScript configuration

構成ファイルの詳細については、以下を参照してください。

launch.json は、VS Code デバッグを構成するために使用されます。
tasks.json は、VS Code タスクを定義するために使用されます。
tsconfig.json については、TypeScript ハンドブックを参照してください。

ただし、Hello World 拡張機能を理解するために不可欠な package.json と extension.ts に焦点を当てましょう。

拡張機能マニフェスト

各 VS Code 拡張機能は、拡張機能マニフェストとして package.json を持つ必要があります。package.json には、scripts や devDependencies などの Node.js フィールドと、publisher、activationEvents、contributes などの VS Code 固有のフィールドが混在しています。すべての VS Code 固有のフィールドの説明は、拡張機能マニフェストリファレンスにあります。最も重要なフィールドをいくつか示します。

name および publisher: VS Code は、拡張機能の一意の ID として <publisher>.<name> を使用します。たとえば、Hello World サンプルには ID vscode-samples.helloworld-sample があります。VS Code は、ID を使用して拡張機能を一意に識別します。
main: 拡張機能のエントリポイント。
activationEvents および contributes: アクティベーションイベントおよびコントリビューションポイント。
engines.vscode: これは、拡張機能が依存する VS Code API の最小バージョンを指定します。

{
  "name": "helloworld-sample",
  "displayName": "helloworld-sample",
  "description": "HelloWorld example for VS Code",
  "version": "0.0.1",
  "publisher": "vscode-samples",
  "repository": "https://github.com/microsoft/vscode-extension-samples/helloworld-sample",
  "engines": {
    "vscode": "^1.51.0"
  },
  "categories": ["Other"],
  "activationEvents": [],
  "main": "./out/extension.js",
  "contributes": {
    "commands": [
      {
        "command": "helloworld.helloWorld",
        "title": "Hello World"
      }
    ]
  },
  "scripts": {
    "vscode:prepublish": "npm run compile",
    "compile": "tsc -p ./",
    "watch": "tsc -watch -p ./"
  },
  "devDependencies": {
    "@types/node": "^8.10.25",
    "@types/vscode": "^1.51.0",
    "tslint": "^5.16.0",
    "typescript": "^3.4.5"
  }
}

注: 拡張機能が 1.74 より前の VS Code バージョンを対象とする場合、activationEvents に onCommand:helloworld.helloWorld を明示的にリストする必要があります。

拡張機能のエントリファイル

拡張機能のエントリファイルは、activate と deactivate の 2 つの関数をエクスポートします。activate は、登録されたアクティベーションイベントが発生すると実行されます。deactivate は、拡張機能が非アクティブになる前にクリーンアップする機会を提供します。多くの拡張機能では、明示的なクリーンアップは必要ない場合があり、deactivate メソッドは削除できます。ただし、拡張機能が VS Code のシャットダウン時、または拡張機能が無効またはアンインストールされたときに操作を実行する必要がある場合、これが実行する方法です。

VS Code 拡張機能 API は、@types/vscode 型定義で宣言されています。vscode 型定義のバージョンは、package.json の engines.vscode フィールドの値によって制御されます。vscode 型は、コード内で IntelliSense、定義へ移動、およびその他の TypeScript 言語機能を提供します。

// The module 'vscode' contains the VS Code extensibility API
// Import the module and reference it with the alias vscode in your code below
import * as vscode from 'vscode';

// this method is called when your extension is activated
// your extension is activated the very first time the command is executed
export function activate(context: vscode.ExtensionContext) {
  // Use the console to output diagnostic information (console.log) and errors (console.error)
  // This line of code will only be executed once when your extension is activated
  console.log('Congratulations, your extension "helloworld-sample" is now active!');

  // The command has been defined in the package.json file
  // Now provide the implementation of the command with registerCommand
  // The commandId parameter must match the command field in package.json
  let disposable = vscode.commands.registerCommand('helloworld.helloWorld', () => {
    // The code you place here will be executed every time your command is executed

    // Display a message box to the user
    vscode.window.showInformationMessage('Hello World!');
  });

  context.subscriptions.push(disposable);
}

// this method is called when your extension is deactivated
export function deactivate() {}

04/03/2025