From d8d90ebb192363733763503581fc21e728fcc07c Mon Sep 17 00:00:00 2001 From: ProducerMatt <58014742+ProducerMatt@users.noreply.github.com> Date: Tue, 18 Jun 2024 16:08:57 -0500 Subject: [PATCH] Update docs --- README.md | 4 ++++ lib/mix/tasks/dialyzer.ex | 3 ++- 2 files changed, 6 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index cc71da9..d5a27cb 100644 --- a/README.md +++ b/README.md @@ -39,6 +39,9 @@ mix dialyzer * `--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 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) @@ -47,6 +50,7 @@ mix dialyzer * `--format ignore_file` - format the warnings in {file, warning} format for Elixir Format ignore file. * `--format ignore_file_strict` - format the warnings in {file, short_description} format for Elixir Format ignore file. * `--quiet` - suppress all informational messages. + * `--quiet-with-result` - suppress all informational messages except for the final result message Warning flags passed to this task are passed on to `:dialyzer` - e.g. diff --git a/lib/mix/tasks/dialyzer.ex b/lib/mix/tasks/dialyzer.ex index 5b4eeda..768935f 100644 --- a/lib/mix/tasks/dialyzer.ex +++ b/lib/mix/tasks/dialyzer.ex @@ -22,7 +22,8 @@ defmodule Mix.Tasks.Dialyzer do * `--format dialyxir` - format the warnings in a pretty printed format * `--format dialyzer` - format the warnings in the original Dialyzer format * `--format github` - format the warnings in the Github Actions message format - * `--format ignore_file` - format the warnings to be suitable for adding to Elixir Format ignore file + * `--format ignore_file` - format the warnings in {file, warning} format for Elixir Format ignore file + * `--format ignore_file_strict` - format the warnings in {file, short_description} format for Elixir Format ignore file. * `--quiet` - suppress all informational messages * `--quiet-with-result` - suppress all informational messages except for the final result message