メインコンテンツまでスキップ
Examples Verified (100%)

プロジェクト設定

大規模なプロジェクトでは、T-Rubyは設定ファイルを使用してコンパイラオプション、パス、動作を管理します。

設定ファイル​

プロジェクトルートにtrbconfig.ymlファイルを作成します：

trbconfig.yml
# T-Ruby設定

# コンパイラバージョン要件
version: ">=1.0.0"

# ソースファイル設定
source:
  # 含めるディレクトリ
  include:
    - src
    - lib
  # 除外するパターン
  exclude:
    - "**/*_test.trb"
    - "**/fixtures/**"

# 出力設定
output:
  # コンパイルされた.rbおよび.rbsファイルの書き込み先
  ruby_dir: build
  # ソースディレクトリ構造を保持
  preserve_structure: true

# コンパイラオプション
compiler:
  # 厳格さレベル: "strict" | "standard" | "permissive"
  strictness: standard
  # .rbsファイルを生成
  generate_rbs: true
  # ターゲットRubyバージョン
  target_ruby: "3.0"

プロジェクトの初期化​

trc --initを使用して設定ファイルを作成：

trc --init

これにより、適切なデフォルト値でtrbconfig.ymlが作成されます。

対話的なセットアップの場合：

trc --init --interactive

設定オプションリファレンス​

ソース設定​

source:
  # .trbファイルを含むディレクトリ
  include:
    - src
    - lib
    - app

  # 除外するファイル/パターン
  exclude:
    - "**/*_test.trb"
    - "**/*_spec.trb"
    - "**/vendor/**"
    - "**/node_modules/**"

  # 処理するファイル拡張子（デフォルト: [".trb"]）
  extensions:
    - .trb
    - .truby

出力設定​

output:
  # コンパイルされた.rbおよび.rbsファイル用ディレクトリ
  ruby_dir: build

  # RBSファイル用別ディレクトリ（オプション、デフォルトはruby_dir）
  # rbs_dir: sig

  # 出力でソースディレクトリ構造を保持
  # true:  src/models/user.trb → build/models/user.rb + build/models/user.rbs
  # false: src/models/user.trb → build/user.rb + build/user.rbs
  preserve_structure: true

  # コンパイル前に出力ディレクトリをクリーン
  clean_before_build: false

コンパイラオプション​

compiler:
  # 厳格さレベル
  # - strict: すべてのコードが完全に型付けされる必要がある
  # - standard: パブリックAPIに型が必要
  # - permissive: 最小限の型要件
  strictness: standard

  # RBSファイルを生成
  generate_rbs: true

  # ターゲットRubyバージョン（生成コードに影響）
  target_ruby: "3.0"

  # 実験的機能を有効化
  experimental:
    - pattern_matching_types
    - refinement_types

  # 追加の型チェックルール
  checks:
    # 暗黙的なany型を警告
    no_implicit_any: true
    # 未使用変数をエラー
    no_unused_vars: false
    # 厳格なnilチェック
    strict_nil: true

ウォッチモード設定​

watch:
  # 追加で監視するディレクトリ
  paths:
    - config

  # デバウンス遅延（ミリ秒）
  debounce: 100

  # リビルド時にターミナルをクリア
  clear_screen: true

  # コンパイル成功後に実行するコマンド
  on_success: "bundle exec rspec"

ディレクトリ構造​

典型的なT-Rubyプロジェクト構造：

my-project/
├── trbconfig.yml         # 設定
├── src/                  # T-Rubyソースファイル（.trb）
│   ├── models/
│   │   ├── user.trb
│   │   └── post.trb
│   ├── services/
│   │   └── auth_service.trb
│   └── main.trb
├── build/                # コンパイル出力（.rb + .rbs）
│   ├── models/
│   │   ├── user.rb
│   │   ├── user.rbs
│   │   ├── post.rb
│   │   └── post.rbs
│   └── ...
└── test/                 # テスト（.rbまたは.trb）
    └── ...

環境別設定​

環境変数または複数の設定ファイルを使用：

trbconfig.yml
# ベース設定

compiler:
  strictness: ${TRC_STRICTNESS:-standard}

output:
  ruby_dir: ${TRC_OUTPUT:-build}

または別ファイルを使用：

# 開発
trc --config trc.development.yaml

# 本番
trc --config trc.production.yaml

Bundler統合​

GemfileにT-Rubyを追加：

Gemfile
source "https://rubygems.org"

group :development do
  gem "t-ruby"
end

# その他の依存関係

Rakeタスクを作成：

Rakefile
require "t-ruby/rake_task"

TRuby::RakeTask.new(:compile) do |t|
  t.config_file = "trbconfig.yml"
end

# テスト実行前にコンパイル
task test: :compile

これで以下を実行できます：

bundle exec rake compile
bundle exec rake test

Rails統合​

Railsプロジェクトの場合、Rails構造に合わせてT-Rubyを設定：

trbconfig.yml
source:
  include:
    - app/models
    - app/controllers
    - app/services
    - lib

output:
  ruby_dir: app  # その場でコンパイル
  preserve_structure: true

compiler:
  strictness: standard

config/application.rbに追加：

# 開発中に.trbファイルを監視
config.watchable_extensions << "trb"

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: Type Check
        run: trc check .

      - name: Compile
        run: trc .

GitLab CI​

.gitlab-ci.yml
typecheck:
  image: ruby:3.2
  script:
    - gem install t-ruby
    - trc check .
    - trc .

モノレポ設定​

複数パッケージを持つモノレポの場合：

monorepo/
├── packages/
│   ├── core/
│   │   ├── trbconfig.yml
│   │   └── src/
│   ├── web/
│   │   ├── trbconfig.yml
│   │   └── src/
│   └── api/
│       ├── trbconfig.yml
│       └── src/
└── trc.workspace.yaml
trc.workspace.yaml
workspace:
  packages:
    - packages/core
    - packages/web
    - packages/api

  # 共有設定
  shared:
    compiler:
      strictness: strict
      target_ruby: "3.2"

すべてのパッケージをビルド：

trc --workspace

次のステップ​

プロジェクトが設定できたら、以下を探索しましょう：