editor_opener

Open source files in your editor directly from Rails error pages. This gem adds clickable links to file paths in Rails error pages, allowing you to instantly open files at the exact line where errors occur.

• 🔥 Works with Rails 7.1+
• 🔗 Clickable file links in Rails error pages
• 📝 Multiple editor support - Works with 13+ popular editors
• 🎯 Precise line targeting - Opens files at the exact error line
• 🔧 Easy configuration - Set via initializer or environment variable
• 🚀 Zero configuration - Works out of the box with EDITOR environment variable
• 📱 Custom URL schemes - Uses editor-specific protocols for seamless integration

Add this line to your application's Gemfile:

group :development do
  gem "editor_opener"
end

And then execute:

$ bundle install

$ rails generate editor_opener:install

This creates config/initializers/editor_opener.rb with all supported editors listed as comments.

Edit the initializer to set your preferred editor:

EditorOpener.setup do |config|
  config.editor = :cursor  # or any other supported editor
end

Set the EDITOR environment variable:

export EDITOR=cursor  # for Cursor
export EDITOR=atom    # for Atom
export EDITOR=subl    # for Sublime Text

1. Install and configure the gem (see above)
2. Restart your Rails server
3. Trigger an error in your Rails application
4. Click the edit icons (✏️) or line numbers in the error page to open files in your editor

The gem automatically detects error traces from:

• Application code
• Gem files
• Direct file paths

The gem supports the following editors with their respective symbols:

# config/initializers/editor_opener.rb
EditorOpener.setup do |config|
  config.editor = :cursor
end

# In your shell profile (~/.bashrc, ~/.zshrc, etc.)
export EDITOR=cursor

# Or in your .env file (if using dotenv)
EDITOR=cursor

# config/initializers/editor_opener.rb
EditorOpener.setup do |config|
  config.editor = Rails.env.development? ? :cursor : nil
end

1. Error Detection: The gem overrides Rails error pages
2. Trace Parsing: Extracts file paths and line numbers from stack traces
3. Editor Detection: Matches configured editor with supported protocols
4. URL Generation: Creates editor-specific URLs for file opening
5. Link Enhancement: Adds clickable links to error page templates

1. Check editor configuration: Ensure your editor symbol is correct
2. Verify protocol support: Make sure your editor supports URL protocols
3. Test environment variable: Try setting EDITOR environment variable
4. Restart Rails server: Configuration changes require server restart

1. Check gem is loaded: Ensure gem is in development group
2. Verify Rails environment: Gem typically only works in development
3. Test with simple error: Create a basic error to test functionality

After checking out the repo, run:

$ bin/setup
$ bin/test

To run tests:

$ bin/test
$ bin/rubocop

Bug reports and pull requests are welcome on GitHub at https://github.com/igorkasyanchuk/editor_opener.

1. Fork the project
2. Create your feature branch (git checkout -b my-new-feature)
3. Make your changes
4. Add tests for your changes
5. Ensure all tests pass (bin/test)
6. Commit your changes (git commit -am 'Add some feature')
7. Push to the branch (git push origin my-new-feature)
8. Create a new Pull Request

• verify it works with old Rails versions (test with 7.1.0 and it works, for older versions it doesn't work) possible fix:

  # in railtie.rb
    if defined?(ActionDispatch::DebugView::RESCUES_TEMPLATE_PATHS)
      ActionDispatch::DebugView::RESCUES_TEMPLATE_PATHS.unshift(path)
    else
      module X
        def initialize(assigns)
          paths = [RESCUES_TEMPLATE_PATH]
          lookup_context = ActionView::LookupContext.new(paths, path)
          super(lookup_context, assigns, nil)
        end
      end
  
      ActionDispatch::DebugView.prepend(X)

  But something is wrong in the views. Maybe we need to support older views, and create a new copy of them? Also, you don't see the full exception, maybe this setting config.action_dispatch.show_exceptions can help, or capture exception with begin/rescue and print in the console?

• more tests

• support for more error pages?

• support for more editors

The gem is available as open source under the terms of the MIT License.

Created by Igor Kasyanchuk.

• better_errors - Better error pages for Rails
• web-console - Rails console in your browser