gemのソースコードをVSCodeで開く

Ruby Ruby on Rails VSCode

gemのソースコードを見たいときにbundle openを使うと便利です。

このコマンドを使うと、bundleしているバージョンのgemのソースコードをコマンド一発で開けます。気持ちがいいです。

Bundler: The best way to manage a Ruby application's gems

というわけでbundle openでgemのソースコードをVSCodeで開く方法について書きます。

もし既に $ bundle open <gemの名前> でgemのソースコードを開ける場合、以下の設定は不要です。

筆者の環境

VSCodeをcode コマンドで起動できるようにする

すでにcodeコマンドを使える場合は設定不要です。

  1. VSCodeを開く
  2. Command + Shift + P
  3. shellと入力
  4. インストール

ターミナルから$ code .でVSCodeが開けばOKです。

$EDITOR環境変数を設定する

-----2020-06-13追記-----

以下の環境変数設定は$EDITOR ではなく $BUNDLER_EDITORを変更したほうが良さそうです。

筆者は$EDITORの設定をした後 git commitのコミットメッセージ編集のエディタがvimからvscodeになってしまい面食らいました。

-----追記終わり-----

$ bundle open gem コマンドを打ったときに環境変数を設定してくださいというエラーメッセージが出ることがあります。

$ bundle open activerecord
To open a bundled gem, set $EDITOR or $BUNDLER_EDITOR

言われている通り設定していきます。

環境変数を~/.bashrcや~/.bash_profileに書いていきます。

export EDITOR='code'

vim使いであればexport EDITOR='vim'などとします。

更新したファイルを再読み込みします。

$ source ~/.bashrc

bundle openを使ってgemのディレクトリが開けばOKです。

$ bundle open activerecord