You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: README.md
+13-9
Original file line number
Diff line number
Diff line change
@@ -51,13 +51,12 @@ mix dialyzer
51
51
52
52
*`--no-compile` - do not compile even if needed.
53
53
*`--no-check` - do not perform (quick) check to see if PLT needs to be updated.
54
-
*`--ignore-exit-status` - display warnings but do not halt the VM or return an exit status code
55
-
*`--format short` - format the warnings in a compact format.
56
-
*`--format raw` - format the warnings in format returned before Dialyzer formatting
57
-
*`--format dialyxir` - format the warnings in a pretty printed format
58
-
*`--format dialyzer` - format the warnings in the original Dialyzer format
59
-
*`--format ignore_file` - format the warnings to be suitable for adding to "Elixir Term Format" ignore file
60
-
*`--quiet` - suppress all informational messages
54
+
*`--ignore-exit-status` - display warnings but do not halt the VM or return an exit status code.
55
+
*`--format short` - format the warnings in a compact format, suitable for ignore file using Elixir term format.
56
+
*`--format raw` - format the warnings in format returned before Dialyzer formatting.
57
+
*`--format dialyxir` - format the warnings in a pretty printed format.
58
+
*`--format dialyzer` - format the warnings in the original Dialyzer format, suitable for ignore file using simple string matches.
59
+
*`--quiet` - suppress all informational messages.
61
60
62
61
Warning flags passed to this task are passed on to `:dialyzer` - e.g.
63
62
@@ -292,6 +291,8 @@ end
292
291
293
292
This file comes in two formats: `--format dialyzer` string matches (compatible with `<= 0.5.1` ignore files), and the [term format](#elixir-term-format).
294
293
294
+
Dialyzer will look for an ignore file using the term format with the name `.dialyzer_ignore.exs` by default if you don't specify something otherwise.
295
+
295
296
#### Simple String Matches
296
297
297
298
Any line of dialyzer format output (partially) matching a line in `"dialyzer.ignore-warnings"` is filtered.
@@ -327,8 +328,8 @@ done (warnings were emitted)
327
328
328
329
#### Elixir Term Format
329
330
330
-
Dialyxir also recognizes an Elixir format of the ignore file. If your ignore file is an `exs` file, Dialyxir will evaluate it and process its data structure. Entries for existing warnings can be generated with `mix dialyzer --format ignore_file`. Lines may be either tuples or an arbitrary Regex
331
-
applied to the *short-description* (`mix dialyzer --format short`). The file looks like the following:
331
+
Dialyxir also recognizes an Elixir format of the ignore file. If your ignore file is an `exs` file, Dialyxir will evaluate it and process its data structure. A line may be either a tuple or an arbitrary Regex
332
+
applied to the *short-description*format of Dialyzer output (`mix dialyzer --format short`). The file looks like the following:
332
333
333
334
```elixir
334
335
# .dialyzer_ignore.exs
@@ -350,6 +351,9 @@ applied to the *short-description* (`mix dialyzer --format short`). The file loo
350
351
]
351
352
```
352
353
354
+
Entries for existing warnings can be generated with `mix dialyzer --format short`. Just remember to put the output in quotes and braces to match the format above.
355
+
356
+
353
357
#### List unused Filters
354
358
355
359
As filters tend to become obsolete (either because a discrepancy was fixed, or because the location
0 commit comments