VisualStudioCode

【VSCode】拡張機能開発 条件が合う時のみアクティビティーバーを表示する

更新日：2025/04/11

次のページでVSCodeの拡張機能を自作しました。

関連ページ
■【VSCode】アクティビティーバーで外部コマンドを実行する拡張機能を作成した

しかし外部コマンドが特定のフォルダ内のときのみ有効なものだったので、VSCodeが特定のフォルダを開いている時のみアクティビティーバーを表示することにしました。

 

whenを使う

"views"のメンバーに"when"を追加して、設定値を指定する。

      "views": {
        "wpDevExtSidebar": [
          {
            "id": "wpDevExtSidebarView",
            "name": "コマンド",
            "icon": "media/icon.svg",
            "when":"!wpDevExt.isHide"
          }
        ]
      },

設定値は ! で否定しておく。
これで、wpDevExt.isHideが存在しない、またはfalseのときwhenが有効になる。
その結果、ビューが非表示になる。
そして、アクティビティーバーに表示可能なビューが存在しないと、アクティビティーバーは非表示になる。

設定値を否定しているのは、whenが有効でないとactivate()が呼び出されないため。

アクティビティーバーを有効にするときは、activate()で設定値にwpDevExt.isHideにfalseをセットする。

const allowPath = "c:\\......";

export function activate(context: vscode.ExtensionContext) {

	const f = vscode.workspace.workspaceFolders;
	if( !f ) {
		return;
	}

	if( f[0].uri.fsPath.toUpperCase().indexOf(allowPath.toUpperCase()) !== 0 ){
		return;
	}

	vscode.commands.executeCommand('setContext', 'wpDevExt.isHide', false);

	// コマンド等の設定
}

 

コマンドボタンの非表示

ビュー内のコマンドを非表示したいときは、コマンドのwhenを使用する。

      "viewsWelcome": [
      {
        "view": "wpDevExtSidebarView",
        "contents": "[コマンド](command:wpDevExt.cmd1)",
        "when":"wpDevExt.cmd1IsVisible"
      },

こちらのwhenは、初期値が有効でも無効でもＯＫ。

更新日：2025/04/11

書いた人（管理人）：けーちゃん

関連記事

スポンサーリンク

記事の内容について

null

こんにちはけーちゃんです。
説明するのって難しいですね。

「なんか言ってることおかしくない？」
たぶん、こんなご意見あると思います。

裏付けを取りながら記事を作成していますが、僕の勘違いだったり、そもそも情報源の内容が間違えていたりで、正確でないことが多いと思います。
そんなときは、ご意見もらえたら嬉しいです。

掲載コードについては事前に動作確認をしていますが、貼り付け後に体裁を整えるなどをした結果動作しないものになっていることがあります。
生暖かい視線でスルーするか、ご指摘ください。

ご意見、ご指摘はこちら。
https://note.affi-sapo-sv.com/info.php

 

このサイトは、リンクフリーです。大歓迎です。