mix compile View Source
A meta task that compiles source files.
It simply runs the compilers registered in your project and returns a tuple with the compilation status and a list of diagnostics.
Configuration
:compilers
- compilers to run, defaults toMix.compilers/0
, which are[:yecc, :leex, :erlang, :elixir, :xref, :app]
.:consolidate_protocols
- whentrue
, runs protocol consolidation via thecompile.protocols
task. The default value istrue
.:build_embedded
- whentrue
, 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--no-protocol-consolidation
- skips protocol consolidation--force
- forces compilation--return-errors
- returns error status and diagnostics instead of exiting on error--erl-config
- path to an Erlang term file that will be loaded as Mix config
Link to this section Summary
Functions
Returns all compilers
Link to this section Functions
compilers() View Source
Returns all compilers.