Rerun mix tasks on code modification
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
config
docs
lib
test
.gitignore
.tool-versions
CHANGELOG.md
LICENSE.md
README.md
mix.exs
mix.lock

README.md

ExRerun

Recompiles mix project on any change to the project src files.

The initial version of this project is inspired by the - currently unmaintained - remix project by AgilionApps: https://github.com/AgilionApps/remix

Installation

Install ex_rerun by adding it as a dependency to mix.exs.

def deps do
  [{:ex_rerun, "~> 0.1", only: :dev}]
end

Configuration

It is possible to configure ex_rerun using the following parameters:

Note: the example below shows the default values.

config :ex_rerun,
  scan_interval: 4000,
  silent: false,
  file_types: [".ex", ".exs", ".eex", ".json"],
  paths: ["lib", "priv"],
  tasks: [:elixir]

where:

  • scan_interval specifies the number of ms to wait between rerun checks,
  • silent toggles whether to print the output of the tasks registered, every time ex_rerun runs,
  • file_types lists which file types that will trigger a rerun when changed,
  • paths lists which folders to monitor, and
  • tasks enumerates the mix tasks to run each time a code modification occurs, possible built-in values are: :elixir, :test, :escript, where
    • :elixir recompiles Elixir source code (same as Mix.Tasks.Compile.Elixir),
    • :test reruns any mix tests in the project (same as Mix.Tasks.Test), and
    • escript rebuilds a escript file (same as Mix.Tasks.Escript.Build).

Furthermore, tasks can also include custom mix tasks. For example, the hex package elm_compile defines the Mix.Tasks.Compile.Elm task which allows mix to also compile Elm files in a mix project. An example project config using ex_rerun and elm_compile might look like so:

config :ex_rerun,
  file_types: [".elm", ".ex", ".exs", ".eex", ".json"],
  paths: ["lib", "priv", "web"],
  tasks: [:elixir, Mix.Tasks.Compile.Elm]

Another example of a custom mix task could be to generate API documentation for a project based on a set of RAML files.