Changes between Version 2 and Version 3 of els

Timestamp:

Apr 4, 2022, 10:09:35 PM (3 years ago)

Author:

manualwiki

Comment:

How to configure

els

@@ -29 +29 @@
 
 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.
+You need to create a new entry under node and tell the system which diagnostics you wish to run. See the currently supported diagnostics and the IDs of them below.
+You should have something similar in you config file:
+
+{{{
+diagnostics:
+  enabled:
+    - refactorerl
+
+refactorerl:
+  node: "nodeName@hostName"             
+  diagnostics:
+    - "unused_macros"                   
+    - "unsecure_os_call"
+}}}
+
+
+== Available diagnostics ==
+
+|| '''Diagnostic ID''' || '''Diagnostic Description''' ||
+|| unused_macros || Unused Macros ||
+|| unsecure_interoperability || Lists interoperability related weaknesses ||
+|| unsecure_concurrency || Identifies concurrency related issues ||
+|| unsecure_os_call || Checks for OS injection ||
+|| unsecure_port_creation || Identifies port creation related issues ||
+|| unsecure_file_operation || Lists unsecure file handling ||
+|| unstable_call || Shows possible atom exhaustion ||
+|| nif_calls || Identifies unsecure NIF calls ||
+|| unsecure_port_drivers || Lists the unsecure ddll usage ||
+|| decommissioned_crypto || Lists the legacy functions from crypto module ||
+|| unsecure_compile_operations || Shows unsecure compile/code loading related operations ||
+|| unsecure_process_linkage || Lists unsecure process linkage ||
+|| unsecure_prioritization || Identifies unsecure process prioritization ||
+|| unsecure_ets_traversal || Lists unsecure ETS traversal ||
+|| unsafe_network || Checks for unsecure kernel related operation ||
+|| unsecure_xml_usage || Identifies unsecure xml parsing ||
+|| unsecure_communication || Lists unsecure communication related settings ||