春の入門連載2024、5本目の記事です。

はじめに

こんにちは。CSIG（Cyber Security Innovation Group）の棚井です。

春の入門連載2024ということで、VSCodeの拡張機能である「GitLens — Supercharge Git in VS Code」を取り上げます。

エディタ選び

みなさんは、普段の開発エディタには何を利用されていますか？

ソフトウェアエンジニアであれば、エディタとの付き合いは絶対に外せないポイントです。私の場合は、「生成系AIとの連携があるか？」と「開発支援ツールが整備されているか」を判断軸としています。

「GitHub Copilot」との連携があり、私がこれまで利用してきたエディタは

の2つです。

JetBrainsの製品はインストール時点で豊富な開発支援機能が揃っており、GoLandには長年課金をしておりました。ただし、GitHub Copilotが登場してからは徐々にVSCodeへと傾き始めて、拡張機能の「GitLens」を見つけてからは、VSCode一本の開発環境へと移行しました。

本ブログでは、この「開発支援ツール」である「GitLens」について紹介します。

GitLensとは

GitLensは、VSCode内での「Gitを用いた開発」を便利にする拡張機能です。

以下、README 記載の文章を引用し、合わせて翻訳文を記載しました。

GitLens supercharges your Git experience in VS Code. Maintaining focus is critical, extra time spent context switching or missing context disrupts your flow. GitLens is the ultimate tool for making Git work for you, designed to improve focus, productivity, and collaboration with a powerful set of tools to help you and your team better understand, write, and review code.

GitLensは、VSCodeでのGit作業をより快適なものにします。集中力を維持することは非常に重要です。コンテキストの切り替えに余分な時間を費やしたり、コンテキストを見失ったりすると、作業の流れが乱れてしまいます。GitLensは、集中力、生産性、コラボレーションを向上させるために設計された究極のツールで、あなたやあなたのチームがコードをよりよく理解し、書き、レビューするための強力なツールセットです。

GitLensが提供する機能は、一言で表現すると「ソースコードの編集履歴をエディタ内で確認する」ためのものです。

システム開発はまっさらな状態から新しい機能を作ることよりも、既存のコードベースを参照しながら改修、アップデートをする機会の方が非常に多くなります。既に存在するソースコードを読み解く「コードリーディング」を効率的に進めるためには、エディタに表示されている最新の実装コードはもちろんのこと、加えて、そのコードに至るまでのプロセスや実装経緯を含めた周辺情報の収集も必要となります。

改修対象のコードはいつ実装されたものなのか
どのような意図で作成されたのか
どのような更新経緯を辿っているのか

について、「最新版」として目の前にあるコードだけでなく、その経緯を把握しながらアップデートを重ねることが、現場のエンジニアには求められています。

この「編集履歴」はGitに保存されているので、GitコマンドやGitHub、GitLabの画面で確認可能です。その「編集履歴の確認作業」を、コードリーディングしながら「エディタ内で完結」できたら、エディタとブラウザの切り替えが不要となり、開発作業に集中できませんか？をツールとして実現したのが、今回紹介するGitLensです。