dialyxir

# Dialyxir

[![CI](https://github.com/jeremyjh/dialyxir/actions/workflows/test.yml/badge.svg)](https://github.com/jeremyjh/dialyxir/actions/workflows/test.yml)
[![Module Version](https://img.shields.io/hexpm/v/dialyxir.svg)](https://hex.pm/packages/dialyxir)
[![Hex Docs](https://img.shields.io/badge/hex-docs-lightgreen.svg)](https://hexdocs.pm/dialyxir/)
[![Total Download](https://img.shields.io/hexpm/dt/dialyxir.svg)](https://hex.pm/packages/dialyxir)
[![License](https://img.shields.io/hexpm/l/dialyxir.svg)](https://github.com/jeremyjh/dialyxir/blob/master/LICENSE)
[![Last Updated](https://img.shields.io/github/last-commit/jeremyjh/dialyxir.svg)](https://github.com/jeremyjh/dialyxir/commits/master)

Mix tasks to simplify use of Dialyzer in Elixir projects.

## Installation

Dialyxir is available on [hex.pm](https://hex.pm/packages/dialyxir).

To add it to a mix project, just add a line like this in your deps function in mix.exs:

```elixir
defp deps do
  [
    {:dialyxir, "~> 1.4", only: [:dev, :test], runtime: false},
  ]
end
```

```console
mix do deps.get, deps.compile
```

## Usage

Use dialyxir from the directory of the mix project you want to analyze; a PLT file will be created or updated if required and the project will be automatically compiled.

```console
mix dialyzer
```

### Command line options

  * `--no-compile`                  - do not compile even if needed.
  * `--no-check`                    - do not perform (quick) check to see if PLT needs to be updated.
  * `--ignore-exit-status`          - display warnings but do not halt the VM or return an exit status code.
  * `--list-unused-filters`         - list unused ignore filters useful for CI. do not use with `mix do`.
  * `--plt`                         - only build the required PLT(s) and exit.
  * `--format <name>`               - Specify the format for the warnings, can be specified multiple times to print warnings multiple times in different output formats. Defaults to `dialyxir`.
    * `--format short`              - format the warnings in a compact format, suitable for ignore file using Elixir term format.
    * `--format raw`                - format the warnings in format returned before Dialyzer formatting.
    * `--format dialyxir`           - format the warnings in a pretty printed format. (default)
    * `--format dialyzer`           - format the warnings in the original Dialyzer format, suitable for ignore file using simple string matches.
    * `--format github`             - format the warnings in the Github Actions message format.
    * `--format ignore_file`        - format warnings as `{file, warning_type}` entries for an Elixir term ignore file.
    * `--format ignore_file_strict` - format warnings as `{file, warning_description}` entries for an Elixir term ignore file.
  * `--quiet`                       - suppress all informational messages.
  * `--quiet-with-result`           - suppress all informational messages except for the final result message.

Warni