Grunt plugin that compiles Elm files to JavaScript.
Switch branches/tags
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
tasks
test
.gitignore
.jshintrc
.travis.yml
Gruntfile.js
LICENSE
README.md
elm-package.json
package.json

README.md

grunt-elm

Compile Elm files to JavaScript. build status NPM version

Getting Started

This plugin requires Grunt ~0.4.0

If you haven't used Grunt before, be sure to check out the Getting Started guide, as it explains how to create a Gruntfile as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:

npm install grunt-elm --save-dev

Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:

grunt.loadNpmTasks('grunt-elm');

This plugin was designed to work with Grunt 0.4.x. If you're still using grunt v0.3.x it's strongly recommended that you upgrade, but in case you can't please use v0.3.2.

Options

yes

Type: Boolean Default: true

Automatically answer yes to any prompts that come up during the build.

debug

Type: Boolean Default: false

Run elm make with the --debug flag

Usage Examples

elm: {
  compile: {
    files: {
      'output-dir/': 'path/to/Source.elm',
      'other-output-dir/': ['path/to/sources/*.elm', 'path/to/more/*.elm']
    }
  },

Changelog

2.0.0

  • Upgraded to node-elm-compiler 4.2.1
  • debug option supported with default to false
  • Upgraded to elm 0.18.0

1.0.0

  • Switches to using node-elm-compiler under the hood.
  • The yesToAllPrompts option is now called yes and defaults to true.

0.4.0

Initial release.