Question 1

How do I ignore warnings in Dialyxir?

Accepted Answer

You can ignore warnings using module attributes (@dialyzer), ignore files in string or Elixir term format, or by specifying ignore_warnings in mix.exs. The README provides examples for both simple string matches and the more flexible Elixir term format.

Question 2

What's the best way to cache PLT files in CI with Dialyxir?

Accepted Answer

Configure plt_file or plt_local_path in mix.exs to store PLTs in a directory like priv/plts, then use your CI's caching system. Dialyxir includes example configs for GitHub Actions, CircleCI, and GitLab CI to streamline this process.

Question 3

Dialyxir vs using raw Dialyzer directly?

Accepted Answer

Dialyxir is preferred for most Elixir projects because it automates PLT management and integrates seamlessly with Mix. Raw Dialyzer requires manual setup and is more complex to configure for repeated use, especially in CI environments.

Question 4

How can I speed up Dialyxir runs locally?

Accepted Answer

Ensure PLT files are built and up-to-date, use the --no-check flag to skip PLT updates when unnecessary, and configure plt_add_deps to limit analyzed dependencies. Caching PLTs in a central location like MIX_HOME also helps.

Question 5

What Dialyzer flags should I enable for better analysis?

Accepted Answer

Common useful flags include :unmatched_returns and :error_handling, but Dialyxir defaults to only :unknown. You can customize flags in mix.exs based on your project's needs, though the README cautions that some flags may produce confusing warnings.

Question 6

How do I handle Dialyzer warnings in umbrella projects?

Accepted Answer

Dialyxir automatically treats projects with lockfiles in parent folders as umbrellas, but you can override this with the no_umbrella flag. Configure dialyzer settings per sub-project or globally to manage warnings effectively.

dialyxir

What is dialyxir?

Overview

Use Cases

Best For

Related Projects

Found a gem we're missing?

Not Ideal For

Pros & Cons

Pros

Cons

Frequently Asked Questions