https://github.com/mattcheely/elm-fancy-brunch

https://github.com/mattcheely/elm-fancy-brunch

Last synced: 24 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/mattcheely/elm-fancy-brunch
• Owner: MattCheely
• License: other
• Created: 2017-10-22T03:30:24.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2018-09-02T12:30:40.000Z (about 6 years ago)
• Last Synced: 2024-09-14T15:19:53.412Z (2 months ago)
• Language: JavaScript
• Size: 36.1 KB
• Stars: 3
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
elm-fancy-brunch

===================

Adds [elm](http://elm-lang.org) support to [brunch](http://brunch.io).

## Install

	npm install --save-dev elm-fancy-brunch

## Usage

The plugin will run automatically. Note that by default no elm files will

be compiled unless `elm-package.json` or `brunch-config.js` specifies

`exposed-modules`. See below for details.

## Configuration

The following defaults can be overridden in `brunch-config.js`:

```javacript

{

  ...

  plugins: {

    elm: {

      "exposed-modules": [],

      "source-directories": [],

      compilerOptions {

        debug: true,

        optimize: true

      }

    }

  }

  ...

}

```

The `exposed-modules` and `source-directories` fields correspond to

the fields of the same name in `elm-package.json` and will be

parsed from that file if it is present. These two fields determine

what modules to compile and where to find them.

## Example

If all elm code is kept in `web/static/elm` and we wish to compile

`web/static/elm/Main.elm` ensure the following configuration is present

in `elm-package.json` or the `brunch-config.js` plugin configuration:

```javascript

{

  ...

  "exposed-modules": ["Main"],

  "source-directories": ["web/static/elm"]

  ...

}

```