aimdevel’s blog

勉強したことを書きます

vscodeのYocto変数hover機能作った

yoctoのレシピ作成に使用する変数のhover機能を、vscode拡張機能として作成した。
作ったものは以下。

GitHub - aimdevel/yocto-variable-hover: vscode extension that enables hover of yocto variables

背景・目的

yoctoのレシピを作成したり、設定を変更する際に、yoctoプロジェクトで定義されている変数を触る機会は多いと思う。
それら変数の説明は以下のページにまとまっている。
12 Variables Glossary — The Yocto Project ® 4.2.999 documentation

変数の使い方を知りたい場合はこのページ内で検索することになるが、いちいちページを開く、検索するという手間がかかって不便だ。
そこで、vscode上で変数の説明を見れるようにhover拡張機能を実装した。

使い方

ソースコードからビルドするか、以下のようにパッケージをインストールすると使用できる。
1. 以下のページから「yocto-variable-hover-0.0.2.vsix」をダウンロードする

Release prototype 2 · aimdevel/yocto-variable-hover · GitHub

  1. vscodeのサイドバーで「extensions」のタブに移動する。

  2. 「Views and More Actions...」(・・・のようなアイコン)から「Install from VSIX...」を選択し、先ほどダウンロードしたファイルを選択しインストールする。

  3. vscodeでyocto関連のファイルを開き、マウスカーソルを変数に乗せると、以下のように説明が表示される。

まとめ

yocto変数の説明を表示する機能を作成した。
これでエディタで説明を見れるようになったので、不便ではない、はず。
表示が小さくて見づらいところはあるが、それはほかの言語のhoverでも同じなので気にしないことにする。
次は、この拡張機能の内部構造の説明でもしようかと思う。