Assay (assay v0.6.0)

Copy Markdown View Source

Public entrypoints for running incremental Dialyzer via Assay.

Summary

Functions

Runs incremental Dialyzer using configuration sourced from the host project.

Functions

run(opts \\ [])

@spec run(keyword()) :: Assay.Runner.run_result()

Runs incremental Dialyzer using configuration sourced from the host project.

Returns :ok when Dialyzer finishes cleanly, :warnings when incremental Dialyzer exits with code 1, and raises on any other exit.

When used via mix assay, exit codes are:

  • 0 - Clean (no warnings after ignores)
  • 1 - Warnings detected
  • 2 - Error occurred