https://github.com/benthepoet/grunt-elm-make

A plugin for compiling Elm files.
https://github.com/benthepoet/grunt-elm-make

elm grunt grunt-elm

Last synced: about 2 months ago
JSON representation

A plugin for compiling Elm files.

• Host: GitHub
• URL: https://github.com/benthepoet/grunt-elm-make
• Owner: benthepoet
• License: mit
• Created: 2016-08-07T02:09:27.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2016-11-28T12:33:42.000Z (about 8 years ago)
• Last Synced: 2024-11-05T10:08:13.005Z (3 months ago)
• Topics: elm, grunt, grunt-elm
• Language: JavaScript
• Homepage:
• Size: 6.84 KB
• Stars: 1
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# grunt-elm-make

> A plugin for compiling Elm files.

## Getting Started

This plugin requires Grunt `~0.4.5`

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-make --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-make');

```

## The "elm_make" task

### Overview

In your project's Gruntfile, add a section named `elm_make` to the data object passed into `grunt.initConfig()`.

```js

grunt.initConfig({

  elm_make: {

    your_target: {

      // Target-specific file lists and/or options go here.

    },

  },

});

```

### Usage Examples

```js

grunt.initConfig({

  elm_make: {

    default: {

      files: {

        'dest/Main.js': ['src/Main.elm'],

      },

    },

  },

});

```

## Contributing

In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using [Grunt](http://gruntjs.com/).