Changes between Version 1 and Version 2 of els

Timestamp:

Apr 4, 2022, 10:00:14 PM (3 years ago)

Author:

manualwiki

Comment:

--

els

@@ -1 @@
-ELS diagnostics
+== Erlang LS diagnostics ==
+
+RefactorErl now can integrate its diagnostics into Erlang LS. To following page will help you with the setup and give you some feature highlight.
+
+
+== What you need ==
+ -[https://erlang-ls.github.io Erlang LS] version: ****
+ - RefactorErl version: *****
+
+
+== How to set it up ==
+
+RefactorErl is like any other diagnostics in ELS, just it is computed outside of it. To enable you need to enable it in the config file of ELS.
+To learn more about how to config Erlang LS visit: [https://erlang-ls.github.io/configuration/ ELS Configuration]
+
+{{{
+diagnostics:
+  enabled:
+    - refactorerl
+}}}
+
+Some extra configuration is needed as the diagnostics are computed on the RefactorErl node.
+You need to add a new root entry to diagnostic file, containing the node's name where RefactorErl is running. (you must start the tool in distributed mode)
+
+{{{
+refactorerl:
+  node: "nodeName@hostName"             
+}}}
+
+Finally by default there are no diagnostics are run, even if the tool is enabled as a Erlang LS diagnostic. You need to enable certain diagnostics manually.
+
+
+