Skip to content

Commit 6634ba5

Browse files
authored
update readme.md (#26)
Update README.md
1 parent d90553b commit 6634ba5

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,20 @@ Plug 'amiralies/coc-elixir', {'do': 'yarn install && yarn prepack'}
3232
- Smart closing of code blocks
3333
- Code formatter
3434

35+
## Dialayzer integration
36+
Coc-elixir will automatically analyze your project with [Dialyzer](http://erlang.org/doc/apps/dialyzer/dialyzer_chapter.html) after each successful build. It maintains a "manifest" file in `.elixir_ls/dialyzer_manifest` that stores the results of the analysis.
37+
38+
You can control which warnings are shown using the `elixirLS.dialyzerWarnOpts` setting in `coc-setting.json`, found at `~/config/nvim/coc-settings.json`, or use command `:CocConfig` to open configuration file.
39+
You can find available options in Erlang [docs](http://erlang.org/doc/man/dialyzer.html) at section "Warning options".
40+
41+
To disable Dialyzer completely add setting:
42+
```json
43+
{
44+
"elixirLS.dialyzerEnabled": false
45+
}
46+
```
47+
You can also set the module attribute @dialyzer to show or hide warnings at a module or function level.
48+
3549
## Troubleshooting
3650

3751
### Server fails to start

0 commit comments

Comments
 (0)