0.0.4 • Published 9 years ago
opalrb-loader-cj v0.0.4
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.
Installation
npm install opalrb-loader --save-dev
Usage
// 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
./build_compiler.sh
to build compilernpm start
to compileindex.es6.js
(Babel CLI is required)
Contact
License
Available under the MIT license. See the LICENSE file for more info.
0.0.4
9 years ago