Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rtfeldman/grunt-elm
Grunt plugin that compiles Elm files to JavaScript.
https://github.com/rtfeldman/grunt-elm
Last synced: about 2 months ago
JSON representation
Grunt plugin that compiles Elm files to JavaScript.
- Host: GitHub
- URL: https://github.com/rtfeldman/grunt-elm
- Owner: rtfeldman
- License: bsd-3-clause
- Created: 2014-10-08T04:01:10.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2018-03-24T08:58:40.000Z (over 6 years ago)
- Last Synced: 2024-04-02T02:21:23.484Z (3 months ago)
- Language: JavaScript
- Homepage:
- Size: 34.2 KB
- Stars: 19
- Watchers: 2
- Forks: 9
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Lists
- awesome-elm - grunt-elm - Grunt plugin that compiles Elm files to JavaScript. (Compile and bundle / Unmaintained)
- Awesome-BigData - grunt-elm - Grunt plugin that compiles Elm files to JavaScript. (Tools)
README
# grunt-elm
> Compile Elm files to JavaScript. [![build status][1]][2] [![NPM version][3]][4]
## Getting Started
This plugin requires Grunt `~0.4.0`
If you haven't used [Grunt](http://gruntjs.com/) before, be sure to check out the [Getting Started](http://gruntjs.com/getting-started) guide, as it explains how to create a [Gruntfile](http://gruntjs.com/sample-gruntfile) as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:
```shell
npm install grunt-elm --save-dev
```
Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:
```js
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](http://gruntjs.com/upgrading-from-0.3-to-0.4), but in case you can't please use [v0.3.2](https://github.com/gruntjs/grunt-contrib-coffee/tree/grunt-0.3-stable).*
### 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
```js
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](https://github.com/rtfeldman/node-elm-compiler) under the hood.
* The `yesToAllPrompts` option is now called `yes` and defaults to `true`.
#### 0.4.0
Initial release.
[1]: https://secure.travis-ci.org/rtfeldman/grunt-elm.svg
[2]: https://travis-ci.org/rtfeldman/grunt-elm
[3]: https://badge.fury.io/js/grunt-elm.svg
[4]: https://badge.fury.io/js/grunt-elm