Home - hiraishikentaro/rails-factorybot-jump GitHub Wiki
Rails FactoryBot Jump
๐ Language Switcher: English | ๆฅๆฌ่ช
Technical Overview
Rails FactoryBot Jump is a VSCode extension that provides intelligent navigation from Rails test files to FactoryBot factory and trait definitions. The extension detects factory calls in test files and creates clickable links that jump directly to the corresponding factory or trait definition.
Core Technology: TypeScript-based VSCode extension with real-time file watching and intelligent caching.
Key Features
- Smart Detection: Automatically detects FactoryBot factory calls (
create(:user)
,build(:post)
, etc.) - Trait Support: Navigate to specific traits within factory definitions
- Real-time Updates: Automatic cache refresh when factory files change
- Configurable Paths: Support for custom factory directory structures
- Cross-platform: Works on Windows, macOS, and Linux
Quick Navigation
๐ Getting Started
- Development Setup - Set up development environment
- Quick Start - Get running in 5 minutes
- Architecture Overview - High-level system design
- Core Concepts - Essential concepts
๐๏ธ Architecture
- Technology Stack - Languages, frameworks, and tools
- System Design - Overall architecture patterns
- Module Structure - Code organization
- Data Flow - How data moves through the system
๐งช Testing
- Testing Strategy - Overall testing approach
- Unit Testing - Writing and running unit tests
๐ Development Guides
- Local Development - Running locally
- Debugging - Debugging techniques
- Code Styles - Coding conventions
๐ Deployment
- Build Process - How to build the project
- Configuration - Environment configuration
Technical Documentation
API References
- VSCode Extension API - Official VSCode extension documentation
- FactoryBot Documentation - Official FactoryBot documentation
Key Developer Resources
- Repository: rails-factorybot-jump
- CI/CD: GitHub Actions
- Package Registry: VSCode Marketplace
- Issues: GitHub Issues
Current Version
Version: 1.3.0
Languages: TypeScript
License: MIT