VS Code用の拡張機能「GitLens」を使うと、特定の行を誰が書いたのかの確認や、リビジョン間のナビゲーションを簡単に行えます。
この記事は会員限定です。会員登録(無料)すると全てご覧いただけます。
前回はGitHub Pull Requests and Issues拡張機能を使って、Visual Studio Code(以下、VS Code)の中からissueを作成してみました。今回はVS Codeでソース管理をしていく上でインストールしていると便利なもう一つの拡張機能「GitLens」を紹介します。
GitLensを使うと、誰がこのコードを書いたのか、このコミットは誰により行われたのか、コードはどのように変わっていったのかなどを、VS Codeの内部で簡単に参照できるようになります。
[拡張機能]ビューの検索ボックスに「gitlens」などと入力して、GitLens拡張機能を検索し、インストールすると次のようにアクティビティーバーに[GitLens]アイコンが表示されます。
このアイコンをクリックすると、GitLensのウエルカムビューがサイドバーに表示されるので、[Welcome(Quick Setup)]ボタンをクリックしましょう。これにより、クイックセットアップを行うためのタブが表示されます。
この画面ではカーソル行のコードを誰か書いたか(git blame)を、その行の右端に表示するかどうかや、ファイルやそこに含まれるコードに手を入れた人をファイル先頭やコードブロック先頭に表示するかなどを設定できます。
設定可能な項目 | 説明 |
---|---|
Current Line Blame | カーソル行のコードを誰が書いたかをその行の右端に表示するかどうか |
Git Code Lens | ファイルやそこに含まれるコードに手を入れた人をファイル先頭やコードブロック先頭に表示するかどうか |
Status Bar Blame | カーソル行のコードを誰が書いたかをステータスバーに表示するかどうか |
Views | GitLensが提供する機能を[ソース管理]ビューに表示するか、[GitLens]ビューに表示するか |
Dates & Times | 日付と時刻の形式 |
クイックセットアップタブで設定可能な項目 |
Views項目についてはここで簡単に説明しておきましょう。GitLensはデフォルトで、[ソース管理]タブにそれが提供する機能を表示するようになっています。
[GitLens Layout]を選択すると、それらの機能には[GitLens]ビューからアクセスするように変わります。
この後は、他の設定項目の幾つかについて簡単に見てみましょう。
この項目はデフォルトで有効で、その場合には、以下のようにカーソル行の右端にその行を誰が記述したかの情報がアノテーションとして表示されるようになります(以下の画像では、少し文字色が薄いので見づらいかもしれません)。
なお、その上にポップアップしている詳細情報は、マウスカーソルをアノテーションにホバーさせると表示されるものです。これにはコミットやissueに関連する情報や、どんな変更が行われたかなどが一目で分かるように表示され、そこからリンクをクリックして必要な情報にもアクセスできるので、コードをブラウズするだけでさまざまな情報がすぐに分かるようになっています。
Status Bar Blameもデフォルトで有効です。これが有効だと、カーソル行のコードを誰が書いたかがステータスバーに表示されます。
スタータスバーの該当部分をクリックすると、先ほどと同様にそのコミットに関連する情報やコマンドがコマンドパレットに表示されます。
Git Code Lens項目もデフォルトで有効です。この場合には、ファイル全体あるいは何らかのコードブロックに手を入れた人が、ファイル先頭あるいはコードブロック先頭に表示されるようになります。
この例では、ファイル先頭に「You, 5 hours ago|2 authors(user01 and others)」とあります。また、その下のクラス定義の先頭にも同様なGit Code Lensが表示されています。パイプ記号「|」で区切られた左側には直近に変更を加えた人が、右側にはコードに手を入れた人(および、それらの人々の中で最も重要だと思われる人)が表示されています。
また、左側をクリックすると、コマンドパレット部分に以下のように直近の変更とそれに関連する各種コマンドが表示されます。
ここで例えば、[Open Changes]をクリックすれば、次のように差分が簡単に確認できます。
直近の変更では、単にミススペルを修正したことが確認できました。
右側をクリックすると、ファイル全体を対象としてgit blameによるアノテーション付きで変更履歴をナビゲーションできるようになります。
このときタブの右側にある各種のボタンを使って、以前のリビジョンにさかのぼったり、次のリビジョンに進んだり、ナビゲート時点のリビジョンのファイルをオープンしたりできます(このときには別のタブがオープンされます)。
表示を元に戻すには上の画像でオレンジ色になっているボタンをクリックします。
Copyright© Digital Advantage Corp. All Rights Reserved.