Examples Verified (100%)

Steepの使用

SteepはRBSを型シグネチャに使用するRuby用の静的型チェッカーです。T-RubyはSteepとシームレスに統合され、T-Rubyコンパイラが提供するもの以上の追加の型チェックを活用できます。

T-RubyでSteepを使用する理由

T-Rubyがコンパイル中に型チェックを行いますが、Steepは以下を提供します：

生成されたRubyコードの追加検証
依存関係とライブラリの型チェック
Ruby LSPを通じたIDE統合
コンパイルされたコードがRBSシグネチャと一致する検証
標準Rubyツールの互換性

インストール

プロジェクトにSteepを追加：

gem install steep

またはGemfileに：

group :development do
  gem "steep"
  gem "t-ruby"
end

その後：

bundle install

基本セットアップ

ステップ1：T-Rubyコードのコンパイル

まず、T-RubyコードをコンパイルしてRubyとRBSファイルを生成：

trc compile src/

これで生成されます：

build/          # コンパイル済みRubyファイル
sig/            # RBS型シグネチャ

ステップ2：Steepfileの作成

Steepを設定するためのSteepfileを作成：

Steepfile
target :app do
  # コンパイル済みRubyファイルをチェック
  check "build"

  # T-Ruby生成シグネチャを使用
  signature "sig"

  # Ruby標準ライブラリの型を使用
  library "pathname"
end

ステップ3：Steepの実行

steep check

SteepはコンパイルされたRubyコードが生成されたRBSシグネチャと一致するか検証します。

完全な例

完全な例を見てみましょう。

T-Rubyソース (src/user.trb)：

class User
  @id: Integer
  @name: String
  @email: String

  def initialize(id: Integer, name: String, email: String): void
    @id = id
    @name = name
    @email = email
  end

  def greet: String
    "Hello, I'm #{@name}!"
  end

  def self.find(id: Integer): User | nil
    # データベース検索がここに
    nil
  end
end

# クラスの使用
user = User.new(1, "Alice", "alice@example.com")
puts user.greet

# これは型エラーになります
# user = User.new("not a number", "Bob", "bob@example.com")

コンパイル：

trc compile src/

Steep設定 (Steepfile)：

target :app do
  check "build"
  signature "sig"
end

Steep実行：

steep check

出力：

# Type checking files:

build/user.rb:19:8: [error] Type mismatch:
  expected: Integer
  actual: String

# Typecheck result: FAILURE

Steepfile設定

基本構造

target :app do
  check "path/to/ruby/files"
  signature "path/to/rbs/files"
end

複数ターゲット

大規模プロジェクトでは複数のターゲットを使用：

# アプリケーションコード
target :app do
  check "build/app"
  signature "sig/app"

  library "pathname", "logger"
end

# テスト
target :test do
  check "build/test"
  signature "sig/test", "sig/app"

  library "pathname", "logger", "minitest"
end

ライブラリ

Ruby標準ライブラリとgemのRBSを含める：

target :app do
  check "build"
  signature "sig"

  # 標準ライブラリ
  library "pathname"
  library "json"
  library "net-http"

  # RBSサポートのあるgem
  library "activerecord"
  library "activesupport"
end

型解決

Steepが型を解決する方法を設定：

target :app do
  check "build"
  signature "sig"

  # 特定のファイルを無視
  ignore "build/vendor/**/*.rb"

  # 型チェックの厳格さを設定
  configure_code_diagnostics do |hash|
    hash[D::UnresolvedOverloading] = :information
    hash[D::FallbackAny] = :warning
  end
end

T-Rubyワークフローとの統合

開発ワークフロー

# 1. T-Rubyコードを書く
vim src/user.trb

# 2. T-Rubyでコンパイル（T-Ruby型エラーをキャッチ）
trc compile src/

# 3. Steepでチェック（Ruby出力を検証）
steep check

# 4. コードを実行
ruby build/user.rb

ウォッチモード

T-RubyウォッチとSteepウォッチを一緒に使用：

ターミナル1 - T-Rubyウォッチ：

trc watch src/ --clear

ターミナル2 - Steepウォッチ：

steep watch --code=build --signature=sig

ファイルを編集すると両方が自動的に再チェックします。

単一コマンドワークフロー

両方を実行するスクリプトを作成：

bin/typecheck
#!/bin/bash
set -e

echo "Compiling T-Ruby..."
trc compile src/

echo "Running Steep..."
steep check

echo "Type checking passed!"

chmod +x bin/typecheck
./bin/typecheck

高度な設定

厳格モード

Steepで厳格な型チェックを有効化：

target :app do
  check "build"
  signature "sig"

  # 厳格モード - すべての型問題で失敗
  configure_code_diagnostics do |hash|
    hash[D::FallbackAny] = :error
    hash[D::UnresolvedOverloading] = :error
    hash[D::UnexpectedBlockGiven] = :error
    hash[D::IncompatibleMethodTypeAnnotation] = :error
  end
end

カスタム型ディレクトリ

T-Ruby生成のRBSと手書きのRBSがある場合：

target :app do
  check "build"

  # T-Ruby生成シグネチャ
  signature "sig/generated"

  # 手書きシグネチャ
  signature "sig/manual"

  # ベンダーシグネチャ
  signature "sig/vendor"
end

Rails統合

Railsプロジェクトの場合：

target :app do
  check "app"

  signature "sig"

  # Railsコアライブラリ
  library "pathname"
  library "logger"

  # Rails gem
  library "activerecord"
  library "actionpack"
  library "activesupport"
  library "actionview"

  # Railsパス設定
  repo_path "vendor/rbs-rails"
end

# Railsオートローディング設定
configure_code_diagnostics do |hash|
  # Railsはオートローディングを使用 - 定数に寛容に
  hash[D::UnknownConstant] = :hint
end

無視パターン

生成またはベンダーコードを無視：

target :app do
  check "build"
  signature "sig"

  # 特定パターンを無視
  ignore "build/vendor/**/*.rb"
  ignore "build/generated/**/*.rb"
  ignore "build/**/*_pb.rb"  # プロトコルバッファ生成ファイル
end

診断設定

Steepの診断レベルをカスタマイズ：

target :app do
  check "build"
  signature "sig"

  configure_code_diagnostics do |hash|
    # エラー
    hash[D::UnresolvedOverloading] = :error
    hash[D::FallbackAny] = :error

    # 警告
    hash[D::UnexpectedBlockGiven] = :warning
    hash[D::IncompatibleAssignment] = :warning

    # 情報
    hash[D::UnknownConstant] = :information

    # ヒント（最低の重要度）
    hash[D::UnsatisfiedConstraints] = :hint

    # 特定の診断を無効化
    hash[D::UnexpectedJumpValue] = nil
  end
end

一般的な診断

UnresolvedOverloading

複数のメソッドオーバーロードがあり、Steepがどれか決定できない：

# RBSで
def process: (String) -> Integer
           | (Integer) -> String

# SteepがUnresolvedOverloadingを報告する可能性
result = process(input)  # inputの型が不明確

修正：型アノテーションを追加するか、型をより明確にします。

FallbackAny

Steepが型を推論できずAnyにフォールバック：

result = some_method()  # 型不明、Anyにフォールバック

修正：T-Rubyソースに明示的な型を追加します。

IncompatibleAssignment

代入での型の不一致：

x: Integer = "string"  # エラー：互換性のない型

修正：T-Rubyソースで型を修正します。

CI/CD統合

GitHub Actions

.github/workflows/typecheck.yml
name: Type Check

on: [push, pull_request]

jobs:
  typecheck:
    runs-on: ubuntu-latest

    steps:
      - uses: actions/checkout@v4

      - name: Set up Ruby
        uses: ruby/setup-ruby@v1
        with:
          ruby-version: '3.2'
          bundler-cache: true

      - name: Install T-Ruby
        run: gem install t-ruby

      - name: Compile T-Ruby
        run: trc compile src/

      - name: Type Check with Steep
        run: bundle exec steep check

GitLab CI

.gitlab-ci.yml
typecheck:
  image: ruby:3.2
  before_script:
    - gem install t-ruby
    - bundle install
  script:
    - trc compile src/
    - bundle exec steep check

Pre-commitフック

.git/hooks/pre-commit
#!/bin/sh

echo "Type checking with T-Ruby and Steep..."

# T-Rubyコンパイル
trc compile src/ || exit 1

# Steepチェック
steep check || exit 1

echo "Type check passed!"

Steepコマンド

Check

コードを型チェック：

steep check

特定のターゲットで：

steep check --target=app

Watch

変更を監視して再チェック：

steep watch

パスを指定：

steep watch --code=build --signature=sig

Stats

型チェック統計を表示：

steep stats

出力：

Target: app
  Files: 25
  Methods: 147
  Classes: 18
  Modules: 5
  Type errors: 0
  Warnings: 3

Validate

Steepfileを検証：

steep validate

Version

Steepバージョンを表示：

steep version

トラブルシューティング

SteepがRBSファイルを見つけられない

問題：Steepが型シグネチャがないと報告。

解決：

# RBSファイルが生成されたか確認
ls -la sig/

# Steepfileのパスを確認
cat Steepfile

型の不一致

問題：Steepが生成されたコードで型エラーを報告。

解決：

T-Rubyコンパイルを確認：
```
trc check src/
```
生成されたRBSを表示：
```
cat sig/user.rbs
```
型が一致するか確認：
```
trc compile --trace src/
```

ライブラリが見つからない

問題：Steepがライブラリの型を見つけられない。

解決：RBSコレクションをインストールするかSteepfileにライブラリを追加：

# RBSコレクションを初期化
rbs collection init

# 依存関係をインストール
rbs collection install

# Steepfileで
target :app do
  signature "sig"
  library "pathname", "json"
end

パフォーマンス問題

問題：大規模プロジェクトでSteepが遅い。

解決：

複数ターゲットを使用：

target :core do
  check "build/core"
  signature "sig/core"
end

target :plugins do
  check "build/plugins"
  signature "sig/plugins"
end

不要なファイルを無視：

target :app do
  check "build"
  ignore "build/vendor/**"
end

ベストプラクティス

1. CIでSteepを実行

常にCIでSteepを実行して型エラーをキャッチ：

- name: Type Check
  run: |
    trc compile src/
    steep check

2. 開発中はSteep Watchを使用

即時フィードバックのためにSteepを実行状態に維持：

steep watch --code=build --signature=sig

3. 診断を適切に設定

寛容から始めて、時間とともに厳格さを増加：

# ここから始める
configure_code_diagnostics do |hash|
  hash[D::FallbackAny] = :warning
end

# ここへ移行
configure_code_diagnostics do |hash|
  hash[D::FallbackAny] = :error
end

4. RBSファイルをバージョン管理に保持

生成されたRBSファイルをコミット：

git add sig/
git commit -m "Update RBS signatures"

5. T-RubyとSteepチェックの両方を使用

T-Rubyはコンパイル時に問題をキャッチし、Steepはランタイム動作を検証：

trc check src/     # コンパイル時チェック
trc compile src/   # Ruby + RBS生成
steep check        # ランタイム動作チェック

Steep vs T-Ruby型チェック

側面	T-Ruby	Steep
いつ	コンパイル時	コンパイル後
何を	`.trb`ファイル	`.rb`と`.rbs`ファイル
目的	T-Rubyコードの型安全性	Ruby出力の検証
エラー	コンパイルを防止	問題を報告
速度	高速（単一ファイル）	低速（全プロジェクト）
統合	内蔵	別ツール

両方使用：開発にはT-Ruby、検証にはSteep。

実世界の例

本番アプリケーション用の完全なセットアップ：

Steepfile
target :app do
  check "build/app"
  signature "sig/app"

  library "pathname"
  library "logger"
  library "json"
  library "net-http"

  ignore "build/app/vendor/**"

  configure_code_diagnostics do |hash|
    hash[D::FallbackAny] = :error
    hash[D::UnresolvedOverloading] = :warning
    hash[D::IncompatibleAssignment] = :error
  end
end

target :test do
  check "build/test"
  signature "sig/app", "sig/test"

  library "minitest"

  configure_code_diagnostics do |hash|
    hash[D::FallbackAny] = :warning  # テストではより寛容に
  end
end

trbconfig.yml
source:
  include:
    - src/app
    - src/test

output:
  ruby_dir: build
  rbs_dir: sig
  preserve_structure: true

compiler:
  strictness: strict
  generate_rbs: true

bin/ci
#!/bin/bash
set -e

echo "==> Compiling T-Ruby..."
trc compile src/app --strict

echo "==> Type checking with Steep..."
steep check --target=app

echo "==> Running tests..."
ruby -Ibuild/test -Ibuild/app build/test/all_tests.rb

echo "==> All checks passed!"

次のステップ

Ruby LSP統合 - Steepと一緒にIDEサポート
RBS統合 - RBSについてもっと学ぶ
Steepドキュメント - 公式Steepドキュメント

T-RubyでSteepを使用する理由​

インストール​

基本セットアップ​

ステップ1：T-Rubyコードのコンパイル​

ステップ2：Steepfileの作成​

ステップ3：Steepの実行​

完全な例​

Steepfile設定​

基本構造​

複数ターゲット​

ライブラリ​

型解決​

T-Rubyワークフローとの統合​

開発ワークフロー​

ウォッチモード​

単一コマンドワークフロー​

高度な設定​

厳格モード​

カスタム型ディレクトリ​

Rails統合​

無視パターン​

診断設定​

一般的な診断​

UnresolvedOverloading​

FallbackAny​

IncompatibleAssignment​

CI/CD統合​

GitHub Actions​

GitLab CI​

Pre-commitフック​

Steepコマンド​

Check​

Watch​

Stats​

Validate​

Version​

トラブルシューティング​

SteepがRBSファイルを見つけられない​

型の不一致​

ライブラリが見つからない​

パフォーマンス問題​

ベストプラクティス​

1. CIでSteepを実行​

2. 開発中はSteep Watchを使用​

3. 診断を適切に設定​

4. RBSファイルをバージョン管理に保持​

5. T-RubyとSteepチェックの両方を使用​

Steep vs T-Ruby型チェック​

実世界の例​

次のステップ​