ex_check v0.1.0 mix check View Source

Runs all checks configured in an Elixir project.

There are following benefits from using this task:

check consistency is achieved by running the same, established set of checks for the project by all developers - be it locally or on the CI server, as a Pull Request or deployment check
reasonable defaults with a set of curated checks for effortlessly ensuring top code quality and taking the best out of the rich set of tools that the Elixir ecosystem has to offer
shorter feedback loop thanks to compiling the project once and then running all the remaining checks in parallel while the output is streamed live during the check run
reduced fixing iterations thanks to executing all the checks regardless of the failures of others and reprinting the errors from all of them at the end of the check run

How it works

First it runs the compiler and aborts upon compilation errors (but not warnings). Further checks are run in parallel (unless --no-parallel option is passed) and their output is streamed one by one for instant insight.

After all checks are completed, output from those that have failed gets reprinted for sake of easily reading into them all at once.

Finally, a summary is presented with a list of all checks that have succeeded, failed or were skipped due to missing files or project dependencies (unless --no-skipped option is passed).

Checks

Following curated checks are configured by default:

:compiler (uses built-in mix compile) - produces compilation warnings that allow to early detect bugs & typos in the code eg. an attempt to call non-existing or deprecated function
:formatter (uses built-in mix format) - ensures that all the code follows the same basic formatting rules such as maximum number of chars in a line or function indentation
:credo (uses Credo) - ensures that all the code follows a further established set of software design, consistency, readability & misc rules and conventions (still statical)
:dialyzer (uses Dialyxir) - performs static code analysis around type mismatches and other issues that are commonly detected by static language compilers
:ex_unit (uses ExUnit) - starts the application in test mode and runs all runtime tests against it (defined as test modules or embedded in docs as doctests)
:ex_doc (uses ExDoc) - compiles the project documentation in order to ensure that there are no issues that would make it impossible for docs to get collected and assembled

You can disable or adjust curated checks as well as add custom ones via the config file.

Configuration

Check configuration may be adjusted with the optional .check.exs file. Use the mix check.gen.config task to get started with the configuration.

Command line options

--only dialyzer --only credo ... - run only specified check(s)
--except dialyzer --except credo ... - don't run specified check(s)
--no-skipped - don't print skipped checks in summary
--no-exit-status - don't halt EVM to return non-zero exit status
--no-parallel - don't run checks in parallel