Skip to content

DanL/ruby-elm-compiler

 
 

Repository files navigation

elm-compiler

Build Status

Ruby wrapper for the Elm language compiler.

The project is heavily inspired by the sprockets-elm repository, written by rtfeldman.

Installation

Install the Elm platform:

http:https://elm-lang.org/install

Add this line to your application's Gemfile:

gem 'elm-compiler'

And then execute:

$ bundle

Or install it yourself as:

$ gem install elm-compiler

Usage

NOTE: Make sure Elm is installed. If the elm-make executable can't be found in the current PATH or via the elm_make_path option, the exception Elm::Compiler::ExecutableNotFound will be thrown.

Elm::Compiler.compile(elm_files, output_path: nil, elm_make_path: nil)
  • elm_files: Accepts a single file path or an array of file paths.
  • output_path: Path to the output file. If left blank, the compiled Javascript will be returned as a string.
  • elm_make_path: Path to the elm-make executable. If left blank, the executable will be looked up in the current PATH.

Examples

Compile to string of Javascript:

Elm::Compiler.compile("Clock.elm")

Compile multiple files to a string of Javascript:

Elm::Compiler.compile(["Clock.elm", "Counter.elm"])

Compile to file:

Elm::Compiler.compile("Clock.elm", output_path: "elm.js")

Compile multiple files to file:

Elm::Compiler.compile(["Clock.elm", "Counter.elm"], output_path: "elm.js")

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/fbonetti/elm-compiler.

License

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

About

Ruby wrapper for the Elm compiler

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Ruby 98.1%
  • Shell 1.9%