VS Codeをソースコードからビルドして独自機能を実装してみた!
はじめに
こんにちは!
今回は、東京大学工学部の実験「大規模ソフトウェアを手探る」で、Visual Studio Code(VS Code)のソースコードを調査し、独自の機能を追加してみました!
VS Codeは普段から多くの人が使っているコードエディタですが、その中身がどうなっているのか、実際にソースコードを読んだことがある人は少ないのではないでしょうか。
今回の実験では、そんなVS Codeのソースコードを実際にビルドし、既存の処理を調べながら新しい機能の実装に挑戦しました。
本記事では、VS Codeの概要やソースコードの構造、開発環境の構築方法、そして今回実装した機能について紹介します。
各機能の詳しい実装過程については、個別の記事で紹介しているので、ぜひそちらもご覧ください!
目指した機能
今回の実験では、普段VS Codeを使っていて感じるちょっとした不便を解消するために、2つの機能の実装に挑戦しました!
1. テキストからファイルを即時生成
WebサイトやChatGPTなどで見つけたコードをVS Codeで使いたいとき、皆さんはどうしていますか?
従来のVS Codeでは、コピーしたコードをファイルとして保存するために、
新しいファイルを作成 → ファイル名を入力 → コードを貼り付け
という操作が必要です。
この操作、意外と頻繁に行うのですが、毎回となると少し面倒ですよね……。
そこで今回は、コピーしたテキストをエクスプローラー上で ⌘V するだけで、新しいファイルを生成できる機能を目指しました!
さらに、コピーしたコードの内容からプログラミング言語を推定し、適切な拡張子を自動的に付けられるようにすることも目標にしました。
2. タブの整理
VS Codeでたくさんのファイルを同時に開いて作業していると、タブがごちゃごちゃして、目的のファイルが見つからなくなることはありませんか?
特に、異なる言語のファイルをいくつも開いていると、タブのアイコンやファイル名だけでは、目的のファイルを探すのが大変です。
そこで今回は、タブをファイル名順・拡張子順に並べ替え、さらにファイルの種類ごとに色分けする機能を目指しました!
具体的には、次のような機能です。
- タブの並べ替え:ファイル名順または拡張子順に並べ替える
- タブの色分け:拡張子ごとにタブの下部に異なる色の線を表示する
これなら、たくさんのファイルを開いていても、目的のファイルを見つけやすくなりそうです!
Visual Studio Codeとは?
Visual Studio Code(通称VS Code)は、Microsoftが開発するオープンソースのコードエディタです。
プログラミングをしたことがある人なら、一度は使ったことがあるのではないでしょうか?
VS Codeは、Windows・macOS・Linuxに対応しており、拡張機能を追加することで、さまざまなプログラミング言語や開発環境に対応できます。
また、VS CodeのソースコードはGitHubで公開されています。つまり、普段使っているエディタの中身を自分で調べたり、好きな機能を追加したりできるわけです!
ソースコードの構造
VS Codeのソースコードは、役割に応じて複数のディレクトリに分けられています。
特に重要なのが、src/vs 以下の構造です。
| ディレクトリ | 主な役割 |
|---|---|
base |
汎用的なユーティリティや基本的なUI部品 |
platform |
ファイル操作や設定など、共通のサービス |
editor |
テキストエディタ本体の機能 |
workbench |
エクスプローラーやターミナルなど、エディタ周辺のUI |
code |
アプリケーションの起動や実行環境に関する処理 |
例えば、今回実装したクリップボードからファイルを生成する機能では、エクスプローラーの貼り付け処理を変更する必要がありました。
そこで、主に以下のファイルを調査・変更しています。
src/vs/workbench/contrib/files/browser/fileActions.ts
このように、どの機能がどのディレクトリに属しているのかを把握することが、大規模なソフトウェアを読み解く第一歩になります。
開発環境の構築
ここからは、実際にVS Codeをソースコードからビルドしていきます!
普段はインストーラーを使って簡単に導入できるVS Codeですが、ソースコードから動かすとなると、いくつか準備が必要です。
使用した環境
今回、最終的にビルドに使用した環境は以下の通りです。
| 項目 | 使用したもの |
|---|---|
| OS | macOS(Apple Silicon) |
| ソースコード管理 | Git |
| JavaScript実行環境 | Node.js |
| パッケージ管理 | npm |
| Node.jsのバージョン管理 | fnm |
当初はLinux環境でもビルドを試みましたが、最終的にはmacOSでビルドを行いました。
ソースコードの取得
まず、GitHubからVS Codeのソースコードを取得します。
git clone https://github.com/microsoft/vscode.git
cd vscode
VS Codeのリポジトリには、ソースコードだけでなく、ビルドに必要な設定ファイルやスクリプトも含まれています。
Node.jsの準備
VS CodeのビルドにはNode.jsが必要です。
ただし、Node.jsはどのバージョンでもよいわけではなく、ソースコードが要求するバージョンを使用する必要があります。
VS Codeのリポジトリには .nvmrc というファイルがあり、使用するNode.jsのバージョンが指定されています。
今回は、Node.jsのバージョン管理ツールである fnm を利用しました。
fnm install
fnm use
これにより、リポジトリで指定されているNode.jsのバージョンを使用できます。
依存パッケージのインストール
続いて、ビルドに必要な依存パッケージをインストールします。
npm install
VS Codeは非常に多くのパッケージに依存しているため、インストールには少し時間がかかります。
ビルドと起動
依存パッケージの準備ができたら、いよいよビルドです!
npm run watch
このコマンドを実行すると、ソースコードのコンパイルが開始されます。
watch モードでは、ソースコードを変更した際にも自動的に再コンパイルが行われるため、機能を実装しながら動作確認するのに便利です。
コンパイルが完了したら、別のターミナルから次のコマンドを実行します。
./scripts/code.sh
これで、ソースコードからビルドしたVS Codeを起動できます!
普段使っているVS Codeとよく似た画面が表示されますが、こちらは自分で変更を加えられる開発版です。
ここまでできれば、いよいよ機能の実装に取りかかれます。
今回実装した機能
無事にVS Codeを起動できたところで、次は独自機能の実装です!
今回は、既存のVS Codeをより便利にすることを目指して、機能の追加に取り組みました。
1. クリップボードのテキストからファイルを生成する機能
普段、WebサイトやChatGPTなどからコードをコピーしてVS Codeで使いたいとき、どのようにしていますか?
通常は、新しいファイルを作成して、コピーしたコードを貼り付けて、ファイル名と拡張子を指定して保存する必要があります。
そこで今回は、この一連の操作をもっと簡単にできないかと考えました。
実装したのは、クリップボードにコピーしたテキストを、VS Codeのエクスプローラー上で ⌘V を押すだけで新しいファイルとして保存できる機能です!
さらに、コピーしたコードの内容からプログラミング言語を推定し、適切な拡張子を自動的に付ける補助機能も追加しました。
例えば、Pythonのコードをコピーして貼り付けると、.pyのファイルとして生成できるようになります。
この機能を実現するために、既存の貼り付け処理を調査し、クリップボードの内容に応じて処理を分岐させるように変更しました。
実装方法やコードの変更内容については、以下の記事で詳しく解説しています。
2. タブの整理機能
VS Codeでたくさんのファイルを開いて作業していると、タブがごちゃごちゃして、目的のファイルがなかなか見つからないことはありませんか?
そこで今回は、タブを自動で並べ替えたり、ファイルの種類ごとに色分けしたりする機能を実装しました!
タブの並べ替え
タブを「ファイル名順」または「拡張子順」に並べ替えられるようにしました。
さらに、一度だけ並べ替えるだけでなく、タブの順序が変わったときにも自動で並べ替えを行う機能を追加しました。
これにより、たくさんのファイルを開いていても、一定のルールに従ってタブを整理できます。
タブの色分け
並べ替えだけでなく、タブをさらに見やすくするために、ファイルの拡張子に応じて色分けする機能も追加しました。
例えば、TypeScript、JavaScript、Pythonなど、ファイルの種類ごとにタブの下部に異なる色の線を表示します。
これにより、タブを一つひとつ確認しなくても、ファイルの種類を視覚的に判別しやすくなりました!
実装方法やコードの変更内容については、以下の記事で詳しく解説しています。
おわりに
今回は、VS Codeのソースコードを取得してビルドし、独自の機能を追加してみました!
普段何気なく使っているVS Codeですが、実際にソースコードを調べてみると、非常に多くのファイルや機能が組み合わさって動作していることが分かりました。
特に、膨大なソースコードの中から目的の処理を探し出し、既存の動作を理解したうえで変更を加えることは、大規模ソフトウェアならではの難しさだと感じました。
一方で、自分が変更したコードによって、普段使っているエディタに新しい機能が追加されるのは、とても面白い経験でした。
この記事が、VS Codeのソースコードを読んでみたい方や、OSSの改造に挑戦してみたい方の参考になればうれしいです!
最後まで読んでいただき、ありがとうございました!

