Skip to content

Latest commit

 

History

History
35 lines (22 loc) · 1.22 KB

README.md

File metadata and controls

35 lines (22 loc) · 1.22 KB
Raw

Volt::BrowserIrb

This gem provides a simple IRB that can run in the browser. Unlike opal-irb, volt-browser_irb does not load up the opal compiler on the client. Since volt already has a compiler loaded on the server, all compilation is done on the server and sent back to the client. This avoids the load time associated with loading the opal compiler.

Usage

Include the gem in development mode only in the Gemfile:

group :development do
  gem 'volt-browser_irb'
end

Then in app/main/config/dependencies.rb you can require it as a dependency (for dev mode only)

if Volt.env.development?
  component 'browser_irb'
end

Restart the server, and press ESCAPE to toggle the irb on the page.

Helpers

tp

volt-browser_irb adds the #tp helper method to the Promise object (short for then_puts). Calling .tp on the promise will print a .inspect of the promises resolves value or rejected error when it resolves. Typically in volt in development, this will be right away, so it can act a little similar to how you might use .sync.inspect on the server.

TODO

Currently browser-irb is pretty simple, here's some things I want to add:

  • tab completion