JA Getting Started Quick Start - hiraishikentaro/rails-factorybot-jump GitHub Wiki

はじめに: クイックスタート

Rails FactoryBot Jump 拡張機能を 5 分で動作させます。

インストール

オプション 1: VSCode Marketplace（推奨）

  1. VSCode を開く
  2. 拡張機能に移動（Ctrl+Shift+X / Cmd+Shift+X）
  3. "Rails FactoryBot Jump" を検索
  4. "インストール" をクリック

オプション 2: 開発版インストール

# クローンとセットアップ
git clone https://github.com/hiraishikentaro/rails-factorybot-jump.git
cd rails-factorybot-jump
npm install
npm run compile

# VSCode で起動
code .
# F5 を押して Extension Development Host を開始

基本的な使い方

1. Rails プロジェクトを開く

プロジェクトに以下があることを確認してください：

  • FactoryBot セットアップ
  • spec/factories/ または test/factories/ にファクトリーファイル
  • FactoryBot を使用するテストファイル

2. 拡張機能をテスト

FactoryBot 呼び出しを含むテストファイルを作成または開きます：

# spec/models/user_spec.rb
RSpec.describe User do
  it "creates a user" do
    user = create(:user)  # ← これがクリック可能になります
    expect(user).to be_valid
  end

  it "builds a user with admin trait" do
    admin = create(:user, :admin)  # ← ファクトリーとトレイトの両方がクリック可能
    expect(admin.admin?).to be_truthy
  end
end

3. ファクトリーへナビゲート

  1. Cmd（Mac）または Ctrl（Windows）を押しながら
  2. ファクトリー呼び出し（例：:user）にホバー
  3. リンクをクリックしてファクトリー定義にジャンプ

サポートされるファクトリーメソッド

拡張機能は以下の FactoryBot メソッドを検出します：

create(:user)                    # 基本的なファクトリー作成
build(:user)                     # 保存せずにビルド
create_list(:user, 5)           # 複数のレコードを作成
build_list(:user, 3)            # 複数のレコードをビルド
build_stubbed(:user)            # スタブされたレコードをビルド
build_stubbed_list(:user, 2)    # 複数のスタブされたレコードをビルド

# トレイト付き
create(:user, :admin)           # トレイト付きファクトリー
build(:post, :published, :featured)  # 複数のトレイト

設定

デフォルトセットアップ

拡張機能は標準的な Rails ファクトリーパスで箱から出してすぐに動作します：

  • spec/factories/**/*.rb（デフォルト）

カスタムパス

VSCode 設定（settings.json）に追加：

{
  "rails-factorybot-jump.factoryPaths": [
    "spec/factories/**/*.rb",
    "test/factories/**/*.rb",
    "lib/factories/**/*.rb"
  ]
}

ソース: package.json#L55-L65

動作確認

ファクトリー検出のテスト

  1. ファクトリーファイルを開きます（例：spec/factories/users.rb）：
FactoryBot.define do
  factory :user do
    name { "John Doe" }
    email { "[email protected]" }

    trait :admin do
      admin { true }
    end
  end
end
  1. ファクトリー呼び出しを含むテストファイルを開く
  2. ファクトリー名にホバーしたときにリンクが表示されることを確認

トラブルシューティング

リンクが表示されない場合：

  • 拡張機能がアクティベートされていることを確認（ステータスバーをチェック）
  • 設定されたパスにファクトリーファイルが存在することを確認
  • ファイルの言語が Ruby に設定されていることを確認

間違ったファクトリーファイルが開かれる場合：

  • 重複するファクトリー名をチェック
  • 拡張機能は最初に見つかったファクトリーを優先します

設定が動作しない場合：

  • 設定変更後に VSCode を再起動
  • settings.json の JSON 構文を確認

次のステップ