Opal Ruby module loader for webpack
JavaScript Ruby
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
examples
test
vendor Keep the vendor folder Mar 25, 2016
.babelrc Upgrade to Babel 6 Mar 25, 2016
.gitignore Ignore built files Mar 25, 2016
.npmignore Override npmignore to include built files Mar 25, 2016
CHANGELOG.md Prepare for a release Mar 25, 2016
Gemfile Upgrade Opal to 0.9.2 Mar 25, 2016
Gemfile.lock Upgrade Opal to 0.9.2 Mar 25, 2016
LICENSE
README.md We all love badges! Mar 25, 2016
circle.yml Bundle install first Mar 25, 2016
compiler.rb
index.es6.js Upgrade to Babel 6 Mar 25, 2016
package.json Add prepublish scripts Mar 25, 2016

README.md

opalrb-loader

Opal is a compiler for writing JavaScript in Ruby.

This package allows transpiling Ruby files using Opal and webpack.

Check out this blog post if you are interested in the project background.

npm version npm downloads Circle CI

Installation

npm install opalrb-loader --save-dev

Usage

Documentation: Using loaders

// webpack.config.js 
module: {
  loaders: [
    {
      test: /\.rb?$/,
      loader: 'opalrb-loader'
    }
  ]
}

Options

See Opal::Compiler options for possible options.

// webpack.config.js 
module: {
  loaders: [
    {
      test: /\.rb?$/,
      loader: 'opalrb-loader',
      query: {
        requirable: false,
        freezing: false,
      }
    }
  ]
}

OPAL_LOAD_PATH

By passing OPAL_LOAD_PATH environment variable to webpack, the loader will correctly resolve file other than relative path.

opalrb-loader is only bundled with compiler module. It left the decision on managing runtime, corelib or gems to developer.

See the example Rakefile for how to integrate using other Opal gems.

Compared to Opal::Builder

  • Relative require is correctly resolved.
  • require_trees is not yet implemented.
  • erb is not supported (which should be implemented as separate loader).

Known issues

  • First time compiling is relatively slow compared to Ruby one, use --watch option for webpack to speed up dev iteration.
  • Use require to load JS file is broken, but you can write as below to load JS module (webpack will correctly resolve it).
# Inside ruby file
`var $ = require("jquery")`
  • stdlib and some gems may not be correctly compiled, please file an issue if you encounter one.

Examples

It's under Examples folder.

  • simple: Basic setup without further dependency.
  • complex: Compile opal/corelib and other gems.

Development

  • npm install
  • npm run build_compiler to build compiler
  • npm start to compile & watch index.es6.js

Contact

David Chang @zetachang

License

Available under the MIT license. See the LICENSE file for more info.