GitLens(VS Code Extension)にコミットしてみる
yuichkunVS Codeの拡張ってどうやって開発するんや？？
1から開発したければこの辺 を読むとよさそう。
幸い、GitLensに関しては CONTRIBUTING.md がそれなりに親切だったので、
言われた通りに、
- nodeとyarnを用意する(入ってた)
- GitLensのリポジトリをクローンする
-
yarn installする -
F5を押すと、デバッガーが起動し、新しいVS Codeのウィンドウが開いた
ウィンドウ名に [Extension Development Host] と入っているので、これが今自分が開発中のVS Codeでdebuggerがアタッチされているものだとわかる。
yuichkunどこから手をつけるか
思ったよりコード量は多かった。(約7万行)
Reactのモノレポが全体で約30万行なので、結構大きい方だと思う。
いずれにしても、VS Codeの拡張機能の仕組みすらあまり分かってないので、
まともに全部読んでいくのは、難しそう。
作戦
何事も、UIに近い方から呼び出しを辿っていけばいつかは全部読めるはず。（CoCのフレームワークだとそうもいかないことも多いけれども…）
今回の場合、元issueで示されていたヒントとして、 Revert Commit... という機能が実装ゴールの挙動に近いので、
- まずはその辺を変更してみて、手元で反映されることを確認する。
- 呼び出しを遡って挙動を理解する。
- このプロジェクトはテストがなさそうなので、最善の努力で手元の動作確認をする。
- PRを出してauthorに見落としがないか見てもらう。
幸い、現在openのPR少ないし、開発アクティブだし、元issueで「困ってたらヒント出すよ」と言ってくれているので、なんとかなると信じて頑張る！
yuichkun猿真似から全ては始まる
Revert Commit... の文言をまずは変えてみる。
このぐらいはたぶんハードコーディングされた文字列だろう、と検索をかけてみると、
CHANGELOG を除くと、2件ヒットした。
-
package.json -
quickCommand.step.ts
ははあ〜、なるほど。このどちらか（あるいは両方）を変えればいいんだな。
変えてみる
こんな感じで package.json の方を書き換えてみた。
watchが走っているので、すぐに再ビルドは通った。（ほんの数秒で終わってありがたい。）
開発中ウィンドウでコマンドパレット（macなら cmd + shift + P で出る）から Reload Window すると、
無事に初めての変更が反映された。
もう一つの方のファイルはどこに変更が反映されたのかちょっとよく分からなかった。
これは違う画面なのかもしれない。今回は無視することにする。
yuichkunVS Code Extensionの仕組みをちょっと調べた
流石に丸腰はきつそうだったので、
Extension Anatomy を読んで、大筋の仕組みを理解してきた。
-
package.jsonに記されているactivationEventsで起動の条件が指定できる -
package.jsonに記されているcontributes.commandsでコマンドを登録できる -
registerCommandsという VS Code の APIで登録したコマンドに任意の関数をバインドできる
ということで、エントリーポイントは extension.tsで間違いないので、
最悪ここから下に辿っていけばいつかは全部読めることがわかった。
yuichkun処理をしている部分を見つける
Extensionの仕組みとして、package.json の contributes.commands に記されているコマンド名(extension名.コマンド名)が一意なIDとして registerCommands にそのまま渡されることがわかった。
ということは、gitlens.views.revert でgrepすれば...?
見事に1件だけヒットした。
ここから先の処理は、具体的なgitのコマンド処理をする部分なので、そんなに追うのは難しくない。
本日は眠いので、ここまで。（作業時間合計: 1時間）
yuichkunその後、合計5時間ほど格闘した結果:
元のコードが途中から非常に複雑になり理解が追いつかなくなったので、ボトムアップで実装するのを諦めて、一番処理の近そうなgit revert周りからコピペして直していく方向で進めた。
約300行程度？の修正でなんとか少し動くようになった。
しかし、流石にコードベースが広く、分からない機能も多いため、authorにヘルプを求めた。