Add edoc_parse_enabled to config

erlang-ls · Dec 20, 2023 · 5880021 · 5880021
1 parent 229175e
commit 5880021
Show file tree

Hide file tree

Showing 2 changed files with 41 additions and 15 deletions.
diff --git a/apps/els_core/src/els_config.erl b/apps/els_core/src/els_config.erl
@@ -165,6 +165,7 @@ do_initialize(RootUri, Capabilities, InitOptions, {ConfigPath, Config}) ->
 
     RefactorErl = maps:get("refactorerl", Config, notconfigured),
     Providers = maps:get("providers", Config, #{}),
+    EdocParseEnabled = maps:get("edoc_parse_enabled", Config, true),
 
     %% Initialize and start Wrangler
     case maps:get("wrangler", Config, notconfigured) of
@@ -236,6 +237,7 @@ do_initialize(RootUri, Capabilities, InitOptions, {ConfigPath, Config}) ->
     ok = set(elvis_config_path, ElvisConfigPath),
     ok = set(compiler_telemetry_enabled, CompilerTelemetryEnabled),
     ok = set(edoc_custom_tags, EDocCustomTags),
+    ok = set(edoc_parse_enabled, EdocParseEnabled),
     ok = set(incremental_sync, IncrementalSync),
     ok = set(
         indexing,

diff --git a/apps/els_lsp/src/els_docs.erl b/apps/els_lsp/src/els_docs.erl
@@ -37,7 +37,7 @@
 -type application_type() :: 'local' | 'remote'.
 
 %%==============================================================================
-%% Dialyer Ignores (due to upstream bug, see ERL-1262
+%% Dialyzer Ignores (due to upstream bug, see ERL-1262
 %%==============================================================================
 -dialyzer({nowarn_function, function_docs/4}).
 
@@ -103,18 +103,33 @@ docs(_M, _POI) ->
 -spec function_docs(application_type(), atom(), atom(), non_neg_integer()) ->
     [els_markup_content:doc_entry()].
 function_docs(Type, M, F, A) ->
-    %% call via ?MODULE to enable mocking in tests
-    case ?MODULE:eep48_docs(function, M, F, A) of
-        {ok, Docs} ->
-            [{text, Docs}];
-        {error, not_available} ->
-            %% We cannot fetch the EEP-48 style docs, so instead we create
-            %% something similar using the tools we have.
+    case edoc_parse_enabled() of
+        true ->
+            %% call via ?MODULE to enable mocking in tests
+            case ?MODULE:eep48_docs(function, M, F, A) of
+                {ok, Docs} ->
+                    [{text, Docs}];
+                {error, not_available} ->
+                    %% We cannot fetch the EEP-48 style docs, so instead we create
+                    %% something similar using the tools we have.
+                    Sig = {h2, signature(Type, M, F, A)},
+                    L = [
+                        function_clauses(M, F, A),
+                        specs(M, F, A),
+                        edoc(M, F, A)
+                    ],
+                    case lists:append(L) of
+                        [] ->
+                            [Sig];
+                        Docs ->
+                            [Sig, {text, "---"} | Docs]
+                    end
+            end;
+        false ->
             Sig = {h2, signature(Type, M, F, A)},
             L = [
                 function_clauses(M, F, A),
-                specs(M, F, A),
-                edoc(M, F, A)
+                specs(M, F, A)
             ],
             case lists:append(L) of
                 [] ->
@@ -127,11 +142,16 @@ function_docs(Type, M, F, A) ->
 -spec type_docs(application_type(), atom(), atom(), non_neg_integer()) ->
     [els_markup_content:doc_entry()].
 type_docs(_Type, M, F, A) ->
-    %% call via ?MODULE to enable mocking in tests
-    case ?MODULE:eep48_docs(type, M, F, A) of
-        {ok, Docs} ->
-            [{text, Docs}];
-        {error, not_available} ->
+    case edoc_parse_enabled() of
+        true ->
+            %% call via ?MODULE to enable mocking in tests
+            case ?MODULE:eep48_docs(type, M, F, A) of
+                {ok, Docs} ->
+                    [{text, Docs}];
+                {error, not_available} ->
+                    type(M, F, A)
+            end;
+        false ->
             type(M, F, A)
     end.
 
@@ -495,3 +515,7 @@ spawn_group_proxy(Acc) ->
         M ->
             spawn_group_proxy([M | Acc])
     end.
+
+-spec edoc_parse_enabled() -> boolean().
+edoc_parse_enabled() ->
+    true == els_config:get(edoc_parse_enabled).