プラグインの作成#

1
yo code

ジェネレータは以下の質問をします：

1
- **拡張機能のタイプを選択**：例えば“New Extension (TypeScript)”または“New Extension (JavaScript)”。
2
- **拡張機能の名称と説明**：表示に従って、作成したい拡張機能の名称と説明を入力します。
3
- **Git の初期化**：Git リポジトリを初期化するかどうか。
4
- **パッケージマネージャー**：npm または yarn の使用を選択します。

生成が完了すると、初期設定済みのプロジェクト構造が得られます。

構造の理解#

生成したプロジェクトを開くと、重要なファイルとディレクトリがいくつか表示されます：

• package.json

  このファイルには拡張機能の基本情報、依存関係、そして VSCode のアクティベーションイベントとコマンド登録が定義されています。

  例えば：

  1
  {
  2
    "name": "my-sample-extension",
  3
    "displayName": "My Sample Extension",
  4
    "description": "A simple VSCode extension.",
  5
    "version": "0.0.1",
  6
    "engines": {
  7
      "vscode": "^1.60.0"
  8
    },
  9
    "activationEvents": [
  10
      "onCommand:extension.helloWorld"
  11
    ],
  12
    "main": "./out/extension.js",
  13
    "contributes": {
  14
      "commands": [
  15
        {
  16
          "command": "extension.helloWorld",
  17
          "title": "Hello World"
  18
        }
  19
      ]
  20
    },
  21
    "scripts": {
  22
      "vscode:prepublish": "npm run compile",
  23
      "compile": "tsc -p ./"
  24
    },
  25
    "devDependencies": {
  26
      "typescript": "^4.0.0",
  27
      "vscode": "^1.1.37",
  28
      "@types/node": "^12.0.0"
  29
    }
  30
  }

• src/extension.ts（または extension.js）

  これは拡張機能のエントリポイントです。拡張機能がアクティブ化されると、ここのコードが実行されます。

  例えば、簡単な例：

  1
  import * as vscode from 'vscode';
  2
  
  3
  export function activate(context: vscode.ExtensionContext) {
  4
      console.log('Congratulations, your extension "my-sample-extension" is now active!');
  5
  
  6
      let disposable = vscode.commands.registerCommand('extension.helloWorld', () => {
  7
          vscode.window.showInformationMessage('Hello World from your VSCode extension!');
  8
      });
  9
  
  10
      context.subscriptions.push(disposable);
  11
  }
  12
  
  13
  export function deactivate() {}

実行とデバッグ#

• プロジェクトを開くと、VSCode のデバッグパネルに、Launch Extension の設定が表示されます。
• F5 を押すと、VSCode は新しい拡張機能開発ホスト（Extension Development Host）を起動します。
• 新しいウィンドウで、コマンドパレット（Ctrl+Shift+P または Cmd+Shift+P）を使って、登録済みのコマンドを入力します。例えば “Hello World” と入力して拡張機能が正しく動作するかをテストします。

プラグインの公開#

開発が完了し、テストが済んだら、他の人に使ってもらうために VSCode Marketplace に公開することを検討できます：

• 拡張機能のパッケージ化と公開を支援する vsce ツールをインストールします：

  1
  npm install -g vsce

• プロジェクトのルートディレクトリでパッケージ化コマンドを実行します：

  1
  vsce package

• 公式ドキュメント の指示に従い、公開手順を完了します。

プラグインの起動#

VSCode の拡張機能は package.json の activationEvents 配列を通じて、いつ有効化するかを定義します。以下は主なアクティベーションイベントのタイプです：