farism/elm-factory

Dev and build on Elm applications

Elm Factory

An all-in-one, zero-configuration CLI tool for developing, building, and deploying Elm applications. Don't worry about tooling and just code!

About

Elm is an awesome language. It has a lot of great individual tooling. However, using them all together in some type of workflow can be a bit tedious. On top of that, some of the tools (e.g. elm-reactor) lack some basic features that would make them into more full-fledged developer tools.

This is where Elm Factory comes in. One of the goals of this project was to not deviate too much from the existing elm tooling ecoystem. It is essentially a CLI tool that is a thin wrapper over a few core libraries while exposing additional functionality, and with only a few basic commands:

• init to scaffold new Elm projects
• dev to start up an express server to proxy elm-reactor
• build to create cache-busted and minified production builds

Features

• Custom html templates with elm-reactor
• Stylesheet management via elm-css
• CSS injection with livereload
• Define custom proxy endpoints
• Production mode builds with cache-busting

Getting Started

# Installation

yarn global add elm-factory
npm install -g elm-factory

# Create a new project

elm-factory init my-app && cd my-app

# Start the elm-factory dev server

elm-factory dev --port=3000 --template=index.dev.hbs

# Build the project for production

elm-factory build --output-path=dist --template=index.prod.hbs

Please see the cli usage for a full list of options

Configuration

Project configuration is available through an .elmfactoryrc or .elmfactoryrc.json file:

{
  "main": "src/MyApp.elm",
  "build": {
    "html": "index.prod.hbs"
  },
  "dev": {
    "port": 3000,
    "html": "index.dev.hbs"
  }
}

Please see the configuration page for a full list of options

Underlying Packages

• elm-reactor for on-the-fly compilation
• browser-sync for proxying and livereload
• find-elm-dependencies for dev mode watching
• node-elm-compiler for compiling production builds
• elm-css for managing stylesheets and extracting css assets
• gulp for orchestrating CLI tasks
• postcss for css processing and minification
• uglifyjs for js minification

Contributing

Ideas and code contributions are welcome! In lieu of a styleguide, this project uses prettier, husky, and lint-staged to maintain code style. If you have any questions, just ask.

Related projects

• elm-live
• elm-webpack-loader
• elm-webpack-starter

elm-factory's Issues

add uglify

add uglifyjs as a default to build with a --no-uglify flag

elm-factory build produces error

Output:

elm-factory build
/usr/local/lib/node_modules/elm-factory/node_modules/yargs/yargs.js:1079
      else throw err
           ^

Error: Task build-html is not configured as a task on gulp.  If this is a submodule, you may need to use require('run-sequence').use(gulp).
    at /usr/local/lib/node_modules/elm-factory/node_modules/run-sequence/index.js:23:10
    at Array.forEach (native)
    at verifyTaskSets (/usr/local/lib/node_modules/elm-factory/node_modules/run-sequence/index.js:16:11)
    at runSequence (/usr/local/lib/node_modules/elm-factory/node_modules/run-sequence/index.js:112:2)
    at Gulp.gulp.task (/usr/local/lib/node_modules/elm-factory/src/tasks/build.js:96:5)
    at module.exports (/usr/local/lib/node_modules/elm-factory/node_modules/orchestrator/lib/runTask.js:34:7)
    at Gulp.Orchestrator._runTask (/usr/local/lib/node_modules/elm-factory/node_modules/orchestrator/index.js:273:3)
    at Gulp.Orchestrator._runStep (/usr/local/lib/node_modules/elm-factory/node_modules/orchestrator/index.js:214:10)
    at Gulp.Orchestrator.start (/usr/local/lib/node_modules/elm-factory/node_modules/orchestrator/index.js:134:8)
    at Object.handler (/usr/local/lib/node_modules/elm-factory/bin/cmds/build.js:14:10)

better logging and handling of misconfiguration

should have prettier and more concise logging, and also inform the user correctly when things are misconfigured (broken paths etc)

environment specific configuration settings

{
  "development": {
    "build": {
      "uglify": false
    }
  },
  "production": {
    "build": {
      "uglify": true
    }
  }
}

Action required: Greenkeeper could not be activated 🚨

🚨 You need to enable Continuous Integration on all branches of this repository. 🚨

To enable Greenkeeper, you need to make sure that a commit status is reported on all branches. This is required by Greenkeeper because we are using your CI build statuses to figure out when to notify you about breaking changes.

Since we did not receive a CI status on the greenkeeper/initial branch, we assume that you still need to configure it.

If you have already set up a CI for this repository, you might need to check your configuration. Make sure it will run on all new branches. If you don’t want it to run on every branch, you can whitelist branches starting with greenkeeper/.

We recommend using Travis CI, but Greenkeeper will work with every other CI service as well.

Once you have installed CI on this repository, you’ll need to re-trigger Greenkeeper’s initial Pull Request. To do this, please delete the greenkeeper/initial branch in this repository, and then remove and re-add this repository to the Greenkeeper integration’s white list on Github. You'll find this list on your repo or organiszation’s settings page, under Installed GitHub Apps.

better tracking of elm-reactor child process

on uncaught exceptions elm-reactor may be left orphaned, need to find a way to better track and kill the spawned process on exit

Livereload does not work

After editing elm files, it does not auto reload the page.

build-html task to correctly use rev'd css/js

the html file generated by the build command should have the correct rev'd paths

Version 10 of node.js has been released

Version 10 of Node.js (code name Dubnium) has been released! 🎊

To see what happens to your code in Node.js 10, Greenkeeper has created a branch with the following changes:

• Replaced the old Node.js version in your .nvmrc with the new one
• The new Node.js version is in-range for the engines in 1 of your package.json files, so that was left alone

If you’re interested in upgrading this repo to Node.js 10, you can open a PR with these changes. Please note that this issue is just intended as a friendly reminder and the PR as a possible starting point for getting your code running on Node.js 10.

More information on this issue

Greenkeeper has checked the engines key in any package.json file, the .nvmrc file, and the .travis.yml file, if present.

• engines was only updated if it defined a single version, not a range.
• .nvmrc was updated to Node.js 10
• .travis.yml was only changed if there was a root-level node_js that didn’t already include Node.js 10, such as node or lts/*. In this case, the new version was appended to the list. We didn’t touch job or matrix configurations because these tend to be quite specific and complex, and it’s difficult to infer what the intentions were.

For many simpler .travis.yml configurations, this PR should suffice as-is, but depending on what you’re doing it may require additional work or may not be applicable at all. We’re also aware that you may have good reasons to not update to Node.js 10, which is why this was sent as an issue and not a pull request. Feel free to delete it without comment, I’m a humble robot and won’t feel rejected 🤖

---

FAQ and help

There is a collection of frequently asked questions. If those don’t help, you can always ask the humans behind Greenkeeper.

---

Your Greenkeeper Bot 🌴