🚀 VS Code でで入手しましょう!

Tree View API

Tree View API を使用すると、拡張機能は Visual Studio Code のサイドバーにコンテンツを表示できます。このコンテンツはツリーとして構造化されており、VS Code の組み込みビューのスタイルに準拠しています。

たとえば、組み込みの References Search View 拡張機能は、参照検索結果を個別のビューとして表示します。

References Search View

すべての参照を検索の結果は、参照: 結果 Tree View に表示され、これは参照ビューコンテナにあります。

このガイドでは、Tree View とビューコンテナを Visual Studio Code に提供する拡張機能を記述する方法を説明します。

Tree View API の基本

Tree View API を説明するために、Node Dependencies というサンプル拡張機能を構築します。この拡張機能は、ツリービューを使用して、現在のフォルダー内のすべての Node.js 依存関係を表示します。ツリービューを追加する手順は、package.json でツリービューを提供し、TreeDataProvider を作成し、TreeDataProvider を登録することです。このサンプル拡張機能の完全なソースコードは、vscode-extension-samples GitHub リポジトリの tree-view-sample にあります。

package.json の機能拡張

まず、package.json の contributes.views 機能拡張ポイントを使用して、ビューを提供することを VS Code に知らせる必要があります。

拡張機能の最初のバージョンの package.json を次に示します。

{
  "name": "custom-view-samples",
  "displayName": "Custom view Samples",
  "description": "Samples for VS Code's view API",
  "version": "0.0.1",
  "publisher": "alexr00",
  "engines": {
    "vscode": "^1.74.0"
  },
  "activationEvents": [],
  "main": "./out/extension.js",
  "contributes": {
    "views": {
      "explorer": [
        {
          "id": "nodeDependencies",
          "name": "Node Dependencies"
        }
      ]
    }
  },
  "scripts": {
    "vscode:prepublish": "npm run compile",
    "compile": "tsc -p ./",
    "watch": "tsc -watch -p ./"
  },
  "devDependencies": {
    "@types/node": "^10.12.21",
    "@types/vscode": "^1.42.0",
    "typescript": "^3.5.1",
    "tslint": "^5.12.1"
  }
}

注: 拡張機能が 1.74 より前の VS Code バージョンをターゲットにしている場合は、activationEvents に onView:nodeDependencies を明示的にリストする必要があります。

ビューの識別子と名前を指定する必要があります。また、次の場所に機能拡張できます。

  • explorer: サイドバーのエクスプローラービュー
  • debug: サイドバーの実行とデバッグビュー
  • scm: サイドバーのソース管理ビュー
  • test: サイドバーのテストエクスプローラービュー
  • カスタムビューコンテナ

Tree Data Provider

2 番目の手順は、登録したビューにデータを供給して、VS Code がビューにデータを表示できるようにすることです。そのためには、まず TreeDataProvider を実装する必要があります。TreeDataProvider はノードの依存関係データを提供しますが、他の種類のデータを提供するデータプロバイダーを持つこともできます。

実装する必要があるこの API には、2 つの必要なメソッドがあります。

  • getChildren(element?: T): ProviderResult<T[]> - 指定された element またはルート (要素が渡されない場合) の子を返すようにこれを実装します。
  • getTreeItem(element: T): TreeItem | Thenable<TreeItem> - ビューに表示される要素の UI 表現 (TreeItem) を返すようにこれを実装します。

ユーザーが Tree View を開くと、getChildren メソッドが element なしで呼び出されます。そこから、TreeDataProvider はトップレベルのツリー項目を返す必要があります。この例では、トップレベルのツリー項目の collapsibleState は TreeItemCollapsibleState.Collapsed であり、トップレベルのツリー項目は折りたたまれた状態で表示されます。collapsibleState を TreeItemCollapsibleState.Expanded に設定すると、ツリー項目が展開された状態で表示されます。collapsibleState をデフォルトの TreeItemCollapsibleState.None のままにすると、ツリー項目に子がないことを示します。getChildren は、collapsibleState が TreeItemCollapsibleState.None のツリー項目に対しては呼び出されません。

ノードの依存関係データを提供する TreeDataProvider 実装の例を次に示します。

import * as vscode from 'vscode';
import * as fs from 'fs';
import * as path from 'path';

export class NodeDependenciesProvider implements vscode.TreeDataProvider<Dependency> {
  constructor(private workspaceRoot: string) {}

  getTreeItem(element: Dependency): vscode.TreeItem {
    return element;
  }

  getChildren(element?: Dependency): Thenable<Dependency[]> {
    if (!this.workspaceRoot) {
      vscode.window.showInformationMessage('No dependency in empty workspace');
      return Promise.resolve([]);
    }

    if (element) {
      return Promise.resolve(
        this.getDepsInPackageJson(
          path.join(this.workspaceRoot, 'node_modules', element.label, 'package.json')
        )
      );
    } else {
      const packageJsonPath = path.join(this.workspaceRoot, 'package.json');
      if (this.pathExists(packageJsonPath)) {
        return Promise.resolve(this.getDepsInPackageJson(packageJsonPath));
      } else {
        vscode.window.showInformationMessage('Workspace has no package.json');
        return Promise.resolve([]);
      }
    }
  }

  /**
   * Given the path to package.json, read all its dependencies and devDependencies.
   */
  private getDepsInPackageJson(packageJsonPath: string): Dependency[] {
    if (this.pathExists(packageJsonPath)) {
      const toDep = (moduleName: string, version: string): Dependency => {
        if (this.pathExists(path.join(this.workspaceRoot, 'node_modules', moduleName))) {
          return new Dependency(
            moduleName,
            version,
            vscode.TreeItemCollapsibleState.Collapsed
          );
        } else {
          return new Dependency(moduleName, version, vscode.TreeItemCollapsibleState.None);
        }
      };

      const packageJson = JSON.parse(fs.readFileSync(packageJsonPath, 'utf-8'));

      const deps = packageJson.dependencies
        ? Object.keys(packageJson.dependencies).map(dep =>
            toDep(dep, packageJson.dependencies[dep])
          )
        : [];
      const devDeps = packageJson.devDependencies
        ? Object.keys(packageJson.devDependencies).map(dep =>
            toDep(dep, packageJson.devDependencies[dep])
          )
        : [];
      return deps.concat(devDeps);
    } else {
      return [];
    }
  }

  private pathExists(p: string): boolean {
    try {
      fs.accessSync(p);
    } catch (err) {
      return false;
    }
    return true;
  }
}

class Dependency extends vscode.TreeItem {
  constructor(
    public readonly label: string,
    private version: string,
    public readonly collapsibleState: vscode.TreeItemCollapsibleState
  ) {
    super(label, collapsibleState);
    this.tooltip = `${this.label}-${this.version}`;
    this.description = this.version;
  }

  iconPath = {
    light: path.join(__filename, '..', '..', 'resources', 'light', 'dependency.svg'),
    dark: path.join(__filename, '..', '..', 'resources', 'dark', 'dependency.svg')
  };
}

TreeDataProvider の登録

3 番目のステップは、上記のデータプロバイダーをビューに登録することです。

これは、次の 2 つの方法で実行できます。

  • vscode.window.registerTreeDataProvider - 登録されたビュー ID と上記のデータプロバイダーを提供することにより、ツリーデータプロバイダーを登録します。

    const rootPath =
  vscode.workspace.workspaceFolders && vscode.workspace.workspaceFolders.length > 0
    ? vscode.workspace.workspaceFolders[0].uri.fsPath
    : undefined;
vscode.window.registerTreeDataProvider(
  'nodeDependencies',
  new NodeDependenciesProvider(rootPath)
);

  • vscode.window.createTreeView - 登録されたビュー ID と上記のデータプロバイダーを提供することにより、Tree View を作成します。これにより、TreeView にアクセスできるようになり、他のビュー操作を実行するために使用できます。TreeView API が必要な場合は、createTreeView を使用します。

    vscode.window.createTreeView('nodeDependencies', {
  treeDataProvider: new NodeDependenciesProvider(rootPath)
});

拡張機能の動作例を次に示します。

View

Tree View コンテンツの更新

ノードの依存関係ビューはシンプルで、データが表示されると更新されません。ただし、ビューに更新ボタンがあり、package.json の現在の内容でノードの依存関係ビューを更新できると便利です。これを行うには、onDidChangeTreeData イベントを使用できます。

  • onDidChangeTreeData?: Event<T | undefined | null | void> - ツリーデータが変更可能で、ツリービューを更新する場合は、これを実装します。

NodeDependenciesProvider に以下を追加します。

  private _onDidChangeTreeData: vscode.EventEmitter<Dependency | undefined | null | void> = new vscode.EventEmitter<Dependency | undefined | null | void>();
  readonly onDidChangeTreeData: vscode.Event<Dependency | undefined | null | void> = this._onDidChangeTreeData.event;

  refresh(): void {
    this._onDidChangeTreeData.fire();
  }

これで更新メソッドができました。しかし、誰もそれを呼び出していません。更新を呼び出すコマンドを追加できます。

package.json の contributes セクションに、次を追加します。

    "commands": [
            {
                "command": "nodeDependencies.refreshEntry",
                "title": "Refresh",
                "icon": {
                    "light": "resources/light/refresh.svg",
                    "dark": "resources/dark/refresh.svg"
                }
            },
    ]

拡張機能のアクティベーションでコマンドを登録します。

import * as vscode from 'vscode';
import { NodeDependenciesProvider } from './nodeDependencies';

export function activate(context: vscode.ExtensionContext) {
  const rootPath =
    vscode.workspace.workspaceFolders && vscode.workspace.workspaceFolders.length > 0
      ? vscode.workspace.workspaceFolders[0].uri.fsPath
      : undefined;
  const nodeDependenciesProvider = new NodeDependenciesProvider(rootPath);
  vscode.window.registerTreeDataProvider('nodeDependencies', nodeDependenciesProvider);
  vscode.commands.registerCommand('nodeDependencies.refreshEntry', () =>
    nodeDependenciesProvider.refresh()
  );
}

これで、ノードの依存関係ビューを更新するコマンドができました。しかし、ビューのボタンの方がさらに優れています。コマンドに icon を既に追加したので、ビューに追加すると、そのアイコンが表示されます。

package.json の contributes セクションに、次を追加します。

"menus": {
    "view/title": [
        {
            "command": "nodeDependencies.refreshEntry",
            "when": "view == nodeDependencies",
            "group": "navigation"
        },
    ]
}

アクティベーション

拡張機能は、ユーザーが拡張機能が提供する機能を必要とする場合にのみアクティブ化されることが重要です。この場合、ユーザーがビューの使用を開始した場合にのみ拡張機能をアクティブ化することを検討する必要があります。VS Code は、拡張機能がビューの機能拡張を宣言すると、これを自動的に実行します。VS Code は、ユーザーがビューを開くと、activationEvent onView:${viewId} (上記の例では onView:nodeDependencies) を発行します。

注: VS Code バージョン 1.74.0 より前のバージョンでは、VS Code がこのビューで拡張機能をアクティブ化するために、package.json でこのアクティベーションイベントを明示的に登録する必要があります。

"activationEvents": [
       "onView:nodeDependencies",
],

ビューコンテナ

ビューコンテナには、組み込みのビューコンテナとともに、アクティビティバーまたはパネルに表示されるビューのリストが含まれています。組み込みのビューコンテナの例は、ソース管理とエクスプローラーです。

View Container

ビューコンテナを提供するには、まず package.json の contributes.viewsContainers 機能拡張ポイントを使用して登録する必要があります。

次の必須フィールドを指定する必要があります。

  • id - 作成している新しいビューコンテナの ID。
  • title - ビューコンテナの上部に表示される名前。
  • icon - アクティビティバーに表示されるビューコンテナの画像。
"contributes": {
  "viewsContainers": {
    "activitybar": [
      {
        "id": "package-explorer",
        "title": "Package Explorer",
        "icon": "media/dep.svg"
      }
    ]
  }
}

または、panel ノードの下に配置することにより、このビューをパネルに提供することもできます。

"contributes": {
  "viewsContainers": {
    "panel": [
      {
        "id": "package-explorer",
        "title": "Package Explorer",
        "icon": "media/dep.svg"
      }
    ]
  }
}

ビューコンテナへのビューの追加

ビューコンテナを作成したら、package.json の contributes.views 機能拡張ポイントを使用できます。

"contributes": {
  "views": {
    "package-explorer": [
      {
        "id": "nodeDependencies",
        "name": "Node Dependencies",
        "icon": "media/dep.svg",
        "contextualTitle": "Package Explorer"
      }
    ]
  }
}

ビューには、オプションの visibility プロパティを含めることもできます。これは、visible、collapsed、または hidden に設定できます。このプロパティは、ワークスペースがこのビューで最初に開かれたときにのみ VS Code によって尊重されます。その後、可視性はユーザーが選択した設定になります。ビューコンテナに多数のビューがある場合、またはビューが拡張機能のすべてのユーザーにとって役立つとは限らない場合は、ビューを collapsed または hidden に設定することを検討してください。hidden ビューは、ビューコンテナの [ビュー] メニューに表示されます。

Views Menu

ビューアクション

アクションは、個々のツリー項目のインラインアイコン、ツリー項目のコンテキストメニュー、およびビュータイトルのビューの上部に表示されます。アクションは、package.json に機能拡張を追加することにより、これらの場所に表示されるように設定したコマンドです。

これら 3 つの場所を提供するには、package.json で次のメニュー機能拡張ポイントを使用できます。

  • view/title - ビュータイトルにアクションを表示する場所。プライマリまたはインラインアクションは "group": "navigation" を使用し、残りは ... メニューにあるセカンダリアクションです。
  • view/item/context - ツリー項目にアクションを表示する場所。インラインアクションは "group": "inline" を使用し、残りは ... メニューにあるセカンダリアクションです。

これらのアクションの可視性は、when 句を使用して制御できます。

View Actions

例

"contributes": {
  "commands": [
    {
      "command": "nodeDependencies.refreshEntry",
      "title": "Refresh",
      "icon": {
        "light": "resources/light/refresh.svg",
        "dark": "resources/dark/refresh.svg"
      }
    },
    {
      "command": "nodeDependencies.addEntry",
      "title": "Add"
    },
    {
      "command": "nodeDependencies.editEntry",
      "title": "Edit",
      "icon": {
        "light": "resources/light/edit.svg",
        "dark": "resources/dark/edit.svg"
      }
    },
    {
      "command": "nodeDependencies.deleteEntry",
      "title": "Delete"
    }
  ],
  "menus": {
    "view/title": [
      {
        "command": "nodeDependencies.refreshEntry",
        "when": "view == nodeDependencies",
        "group": "navigation"
      },
      {
        "command": "nodeDependencies.addEntry",
        "when": "view == nodeDependencies"
      }
    ],
    "view/item/context": [
      {
        "command": "nodeDependencies.editEntry",
        "when": "view == nodeDependencies && viewItem == dependency",
        "group": "inline"
      },
      {
        "command": "nodeDependencies.deleteEntry",
        "when": "view == nodeDependencies && viewItem == dependency"
      }
    ]
  }
}

デフォルトでは、アクションはアルファベット順に並べ替えられます。異なる順序を指定するには、グループの後に目的の順序が続く @ を追加します。たとえば、navigation@3 を指定すると、アクションが navigation グループの 3 番目に表示されます。

... メニュー内の項目をさらに分離するには、異なるグループを作成します。これらのグループ名は任意であり、グループ名でアルファベット順に並べ替えられます。

注: 特定のツリー項目のアクションを表示する場合は、TreeItem.contextValue を使用してツリー項目のコンテキストを定義し、when 式のキー viewItem にコンテキスト値を指定することで実行できます。

例

"contributes": {
  "menus": {
    "view/item/context": [
      {
        "command": "nodeDependencies.deleteEntry",
        "when": "view == nodeDependencies && viewItem == dependency"
      }
    ]
  }
}

ウェルカムコンテンツ

ビューが空の場合、または別の拡張機能の空のビューにウェルカムコンテンツを追加する場合は、viewsWelcome コンテンツを提供できます。空のビューとは、TreeView.message がなく、空のツリーであるビューです。

"contributes": {
  "viewsWelcome": [
    {
      "view": "nodeDependencies",
      "contents": "No node dependencies found [learn more](https://www.npmjs.com/).\n[Add Dependency](command:nodeDependencies.addEntry)"
    }
  ]
}

Welcome Content

ウェルカムコンテンツではリンクがサポートされています。慣例により、行に単独で表示されるリンクはボタンです。各ウェルカムコンテンツには、when 句を含めることもできます。詳細な例については、組み込みの Git 拡張機能を参照してください。

TreeDataProvider

拡張機能の作成者は、ビューにデータを入力するために、TreeDataProvider をプログラムで登録する必要があります。

vscode.window.registerTreeDataProvider('nodeDependencies', new DepNodeProvider());

実装については、tree-view-sample の nodeDependencies.ts を参照してください。

TreeView

プログラムでビューに対して UI 操作を実行する場合は、window.registerTreeDataProvider の代わりに window.createTreeView を使用できます。これにより、ビューにアクセスできるようになり、ビュー操作の実行に使用できます。

vscode.window.createTreeView('ftpExplorer', {
  treeDataProvider: new FtpTreeDataProvider()
});

実装については、tree-view-sample の ftpExplorer.ts を参照してください。

04/03/2025