elm-benchmark-helper

Bootstraps BrianHicks/elm-benchmark in your project.

This project is merged to elm-benchmark upstream. When other features are ready, this will be released as part of the official elm-benchmark CLI!

For the mean time, you can install and use it as described below.

Install

$ npm install ymtszw/elm-benchmark-helper -D

Not published to npm registry.

You may install globally (with -g option) if you want to.

Usage

$ node_modules/.bin/elm-benchmark init    # Generates benchmarks/ directory with sample benchmark app
$ node_modules/.bin/elm-benchmark compile # Default output file is docs/index.html
$ open docs/index.html

$ node_modules/.bin/elm-benchmark install # Just installs Elm packages in benchmarks/elm-package.json

Re-running init will not overwrite existing benchmarks/elm-package.json and benchmarks/Benchmarks.elm.

Uses node_modules/.bin/elm-* binaries if they exist, otherwise look for globally installed Elm binaries.

Directory Structure

(Your Elm project directory)
|- elm-package.json # Required
|- elm-stuff/
|- src/
|- docs/
|  \- index.html # Default compile target of benchmark app
\- benchmarks/
   |- elm-package.json # Generated. Will have ['../src', '.'] as `source-directories`
   |- Benchmarks.json  # Generated
   \- elm-stuff/