Mix

v1.5.0

Mix

Mix v1.5.0 mix compile View Source

A meta task that compiles source files.

It simply runs the compilers registered in your project.

Configuration

  • :compilers - compilers to run, defaults to Mix.compilers/0, which are [:yecc, :leex, :erlang, :elixir, :xref, :app].

  • :consolidate_protocols - when true, runs protocol consolidation via the compile.protocols task. The default value is true.

  • :build_embedded - when true, embeds all code and priv content in the _build directory instead of using symlinks.

  • :build_path - the directory where build artifacts should be written to. This option is intended only for child apps within a larger umbrella application so that each child app can use the common _build directory of the parent umbrella. In a non-umbrella context, configuring this has undesirable side-effects (such as skipping some compiler checks) and should be avoided.

Compilers

To see documentation for each specific compiler, you must invoke help directly for the compiler command:

mix help compile.elixir
mix help compile.erlang

You can get a list of all compilers by running:

mix compile --list

Command line options

  • --list - lists all enabled compilers
  • --no-archives-check - skips checking of archives
  • --no-deps-check - skips checking of dependencies
  • --force - forces compilation

Link to this section Summary

Functions

compilers()

Returns all compilers

manifests()

Returns manifests for all compilers

run(args)

A task needs to implement run which receives a list of command line args

Link to this section Functions

Link to this function compilers() View Source

Returns all compilers.

Link to this function manifests() View Source

Returns manifests for all compilers.

Link to this function run(args) View Source 
run(OptionParser.argv()) :: :ok | :noop

A task needs to implement run which receives a list of command line args.

Callback implementation for Mix.Task.run/1.