0.12.0 • Published 7 years ago

elm-brunch v0.12.0

Weekly downloads
40
License
MIT
Repository
github
Last release
7 years ago

elm-brunch

Brunch plugin to compile Elm code

Build Status

Quickstart

First, install Elm.

Then, install elm-brunch:

npm install --save-dev elm-brunch

Update the watched configuration in your brunch-config.js, e.g.:

paths: {
  watched: ["css", "js", "elm"]
  ...

Configuration

  // Configure your plugins in brunch-config.js (or .coffee)
    plugins: {
      ...

      elmBrunch: {
        // (required) Set to the elm file(s) containing your "main" function `elm make` 
        //            handles all elm dependencies relative to `elmFolder`
        mainModules: ['source/path/YourMainModule.elm'],

        // (optional) Set to keep an independent elm-stuff folder per mainModule. If 
        //            mainModules is an array, then the 'source/path' of each mainModule 
        //            will be appended to your elm-folder, allowing each subfolder to keep their
        //            own set of elm dependencies.
        independentModules: true,

        // (optional) Set to path where `elm-make` is located, relative to `elmFolder`
        executablePath: '../../node_modules/elm/binwrappers',

        // (optional) Set to path where elm-package.json is located, defaults to project root
        //            if your elm files are not in /app then make sure to configure 
        //            paths.watched in main brunch config
        elmFolder: 'path/to/elm-files',

        // (optional) Defaults to 'js/' folder in paths.public
        // relative to `elmFolder`
        outputFolder: 'some/path/',

        // (optional) If specified, all mainModules will be compiled to a single file 
        //            This is merged with outputFolder.
        outputFile: 'elm.js',

        // (optional) add some parameters that are passed to elm-make
        makeParameters: ['--warn']
      }
   }

The output filename is the lowercase version of the main module name:

YourMainModule.elm => outputFolder/yourmainmodule.js

Note: You should update the "source-directories" property in the elm-package.json file if you want to compile multi-file elm projects. Then configure elm-brunch:

Examples

The following repos are examples of elm-brunch configuration:

0.12.0

7 years ago

0.11.1

7 years ago

0.11.0

7 years ago

0.10.0

8 years ago

0.9.0

8 years ago

0.8.0

8 years ago

0.7.0

9 years ago

0.6.0

9 years ago

0.5.0

9 years ago

0.4.4

10 years ago

0.4.3

10 years ago

0.4.2

10 years ago

0.4.1

10 years ago

0.4.0

10 years ago

0.3.1

10 years ago

0.3.0

10 years ago

0.2.0

10 years ago

0.1.0

10 years ago