memorandum
タグ
言語

VSCode Extension

2020/12/21
2021/02/25
VSCode

少し前に Status Bar Title という VSCode Extension を作った。全然大したことないのだが、2020年ももう終わりに近づくのに今年は全然書いていなかったので記録しておく。

作った理由

vim などのように terminal ベースのエディタを使っていると、作業領域が広く取れるのが良いなと思っていて、VSCode でも少しでも近づけられればと思ったところ Customize UI という extension を見つけた。

これを使うと、Activity Bar (エクスプローラ、検索、等のメニューのアイコンが並んだバー) の位置を変えたり、タイトルバーを隠すことができる。

これは良いと思ったが、タイトルが出ていないと、複数のウィンドウを開いているときに今どのウィンドウが開いているのかわかりにくいという問題がある。

エクスプローラの上部に表示されているが、視認しにくいのと、エクスプローラ以外を表示していると見えない。

だったらタイトルバーを表示すれば良いのでは…と思うかもしれないが、タイトルバー非表示のほうが何かカッコいいなと思ってしまったのだよな…

そこで、ステータスバーにタイトル(プロジェクト名)を表示できれば良いと思ったのだが、標準機能にはないらしく、ちょうどよい extension も見つからなかったので、作ってみることにした。

結果

結果が以下。Gitのブランチ名(master)の左側に表示されている memorandum の部分がプロジェクト名。本当に表示だけで、クリックしても何も起きない。

ウィンドウ全体で見るとこんな感じ。目立たないが、同じ位置にあるとわかっていればそれなりに見分けられる。

extension のデバッグのウィンドウ(Extension Development Host)の場合はアイコンがbugのアイコンに変わる (これはextensionの開発者向けの相当に地味な機能…)。

こんな地味なもの使う人は自分くらい…とも思ったが、わずかながらダウンロードしてくれている人がいる。(最初の5~8件くらいは自分)

リポジトリは こちら。

内容

本当に単純で、Hello Worldレベルな感じ。

起動とともに有効にしてほしいextensionなので、アクティベーションのイベントはすべて(*)。

"activationEvents": [
  "*"
],

activate の function で statusBarItem を作って登録する。

位置の制御のために優先度を示す整数値を与えるが、他のextensionがあっても基本的に一番左に表示したいという意味で大きい値を設定している。

myStatusBarItem = vscode.window.createStatusBarItem(vscode.StatusBarAlignment.Left, 10000);
context.subscriptions.push(myStatusBarItem);

あとは表示するitemを組み立てるだけ。

前述の通り Extension Development Hostかどうかという判定は https://github.com/microsoft/vscode/issues/10272 のworkaroundに頼っているが、それ以外は単純にworkspace名とアイコンを文字列で設定しているだけ。アイコンについては Product Icon Reference で説明されているが、 $(project) という文字列表現だけで簡単に設定できる。

const isDevelopment = vscode.env.sessionId === 'someValue.sessionId';
const icon = isDevelopment ? '$(debug)' : '$(project)';
const name = vscode.workspace.name;
if (name) {
    myStatusBarItem.text = `${icon} ${name}`;
    myStatusBarItem.show();
}

リリース

細かな手順は様々なブログ等で説明されているので割愛するが、1点だけ。

ちょうどこの頃、GitHubではGitリポジトリのデフォルトブランチをmasterブランチではなくmainブランチとするようになった頃だったのだが、これに沿って main ブランチとしたところ、VSCode Extension の marketplace でうまく画像が出ないという事象に遭遇した。工夫をすれば回避できなくもなさそうだったが、その後も問題に遭遇しそうな気がしたので、まだ main にするのは早いかなと判断して master に戻した。

© 2010 ksoichiro