|
1 | 1 | # Dialyxir
|
2 | 2 |
|
3 |
| -[](https://travis-ci.org/jeremyjh/dialyxir) |
4 | 3 | [](https://hex.pm/packages/dialyxir)
|
5 | 4 | [](https://hexdocs.pm/dialyxir/)
|
6 | 5 | [](https://hex.pm/packages/dialyxir)
|
|
9 | 8 |
|
10 | 9 | Mix tasks to simplify use of Dialyzer in Elixir projects.
|
11 | 10 |
|
12 |
| -## Changes in 1.0 |
13 |
| - |
14 |
| -Elixir 1.6 is required, to support the new pretty printing feature. If your |
15 |
| -project is not yet on 1.6, continue to specify 0.5 in your mix deps. |
16 |
| - |
17 |
| -Warning messages have been greatly improved, but are filtered through the legacy formatter to support your existing ignore files. You can optionally use the new Elixir [term format](#elixir-term-format) for ignore files. You may want to use the `--format short` argument in your CI pipelines. There are several formats, also there is a new `explain` feature - for details see CLI [options](#command-line-options). |
18 |
| - |
19 |
| -## Quickstart |
20 |
| -If you are planning to use Dialyzer with an application built with the [Phoenix Framework](http://www.phoenixframework.org/), check out the [Quickstart wiki](https://github.com/jeremyjh/dialyxir/wiki/Phoenix-Dialyxir-Quickstart). |
21 |
| - |
22 | 11 | ## Installation
|
23 | 12 |
|
24 | 13 | Dialyxir is available on [hex.pm](https://hex.pm/packages/dialyxir).
|
25 | 14 |
|
26 |
| -You can either add it as a dependency in your mix.exs, or install it globally as an archive task. |
27 |
| - |
28 | 15 | To add it to a mix project, just add a line like this in your deps function in mix.exs:
|
29 | 16 |
|
30 | 17 | ```elixir
|
31 | 18 | defp deps do
|
32 | 19 | [
|
33 |
| - {:dialyxir, "~> 1.0", only: [:dev], runtime: false}, |
| 20 | + {:dialyxir, "~> 1.3", only: [:dev], runtime: false}, |
34 | 21 | ]
|
35 | 22 | end
|
36 | 23 | ```
|
@@ -82,26 +69,6 @@ To use Dialyzer in CI, you must be aware of several things:
|
82 | 69 | 2) The PLT should be cached using the CI caching system
|
83 | 70 | 3) The PLT will need to be rebuilt whenever adding a new Erlang or Elixir version to build matrix
|
84 | 71 |
|
85 |
| -### Travis |
86 |
| - |
87 |
| -`.travis.yml` |
88 |
| -```markdown |
89 |
| -language: elixir |
90 |
| - |
91 |
| -elixir: |
92 |
| - - 1.8 |
93 |
| - |
94 |
| -otp_release: |
95 |
| - - 21.0 |
96 |
| - |
97 |
| -script: |
98 |
| - - mix dialyzer |
99 |
| - |
100 |
| -cache: |
101 |
| - directories: |
102 |
| - - priv/plts |
103 |
| -``` |
104 |
| - |
105 | 72 | ### Github Actions
|
106 | 73 |
|
107 | 74 | `dialyzer.yml`
|
|
0 commit comments