開発環境のセットアップ

OSBXLでは、rubyの開発に、 Sorbet を用いた開発を推奨しています。

残念ながら、Sorbetは、Windows上では実行できないので、
Windows環境を利用の方は、WSL(Windows Subsystem For Linux)を用い、Linux環境をWindows上に構築することをお勧めします。
WSLの構築方法については、本ドキュメントの対象外とさせて頂きます。

Microsoft社の提供するクロスプラットフォーム開発環境 VisualStudioCode で開発すると便利です。無料で利用できます。
VisualStudioCodeは現在も開発が継続して続けられており、最新版の取得をお勧めします。

OSBXLでは、Sorbetを通じ、 関数の自動補完や型ヒントを提供 しています。
SorbetのVisualStudioCodeのプラグインは、 Sorbet開発チームが Ruby Sorbet という名称で提供していますので、インストールしてください。

  • Sorbetのインストール

SorbetをBundler経由で実行する場合の、 Gemfile は以下となります。
rubyosbxlはローカルインストールとなるので、rubyosbxlの :pathの指定を忘れないでください。

Gemfile

gem 'sorbet', group: :development
gem 'sorbet-runtime'
gem 'tapioca', require: false, group: :development

# 通常、:pathは以下となります。
# /rubyのrootディレクトリ/versions/3.x.x/lib/ruby/gems/3.x.0/gems/rubyosbxl-1.1.0
# わからない場合、 gem uninstall rubyosbxl を実行すると、どこにインストールされているか分かります。
# (その後、再インストールしてください)
gem "rubyosbxl", "1.1.0", :path => 'rubyosbxlがインストールされているディレクトリ'

上記の`Gemfile`を記載後、以下のコマンドを入力します。

bundle install
bin/tapioca init

これでSorbetがインストールされ、初期化されます。

VsCodeのプラグインが既にインストールされている場合、一度、VsCodeを閉じて開き直してください。
(インストールされていなかったら、インストールしてださい)

Sorbetの入力補完が有効になるはずです。

(参考) VisualStudioCodeを用いた開発中の画面

_images/develop_example_ruby.png