Merge pull request #1141 from erlang-ls/1140-do-not-assume-string-des…

…criptions-in-make-code

[1140] Do not include error description in code

apps/els_lsp/priv/code_navigation/src/diagnostics_parse_transform_error.erl

@@ -0,0 +1,8 @@
+-module(diagnostics_parse_transform_error).
+
+-compile({parse_transform, my_parse_transform}).
+
+-export([ function_a/0 ]).
+
+function_a() ->
+  ok.

apps/els_lsp/priv/code_navigation/src/my_parse_transform.erl

@@ -0,0 +1,11 @@
+-module(my_parse_transform).
+
+-export([ parse_transform/2 ]).
+
+-export([ format_error/1 ]).
+
+parse_transform(_Forms, _Options) ->
+  [{error, {42, ?MODULE, custom_description}}].
+
+format_error(Desc) ->
+    lists:flatten(io_lib:format("~p", [Desc])).

apps/els_lsp/src/els_compiler_diagnostics.erl

@@ -630,9 +630,8 @@ make_code(erl_parse, "bad " ++ _Str) ->
 make_code(erl_parse, _Other) ->
  <<"P1799">>;
 
-make_code(Module, Reason) ->
-  unicode:characters_to_binary(
-            io_lib:format("~p:~s", [Module, Reason])).
+make_code(Module, _Reason) ->
+  unicode:characters_to_binary(io_lib:format("~p", [Module])).
 
 %-----------------------------------------------------------------------
 

apps/els_lsp/test/els_diagnostics_SUITE.erl

@@ -20,6 +20,7 @@
         , compiler_with_parse_transform_included/1
         , compiler_with_parse_transform_broken/1
         , compiler_with_parse_transform_deps/1
+        , compiler_with_parse_transform_error/1
         , compiler_telemetry/1
         , code_path_extra_dirs/1
         , use_long_names/1
@@ -348,6 +349,20 @@ compiler_with_parse_transform_deps(_Config) ->
   Hints = [],
   els_test:run_diagnostics_test(Path, Source, Errors, Warnings, Hints).
 
+%% Issue 1140
+-spec compiler_with_parse_transform_error(config()) -> ok.
+compiler_with_parse_transform_error(_Config) ->
+  Path = src_path("diagnostics_parse_transform_error.erl"),
+  Source = <<"Compiler">>,
+  Errors = [#{ code => <<"my_parse_transform">>
+             , message => <<"custom_description">>
+             , range => {{41, 0}, {42, 0}}
+             }
+           ],
+  Warnings = [],
+  Hints = [],
+  els_test:run_diagnostics_test(Path, Source, Errors, Warnings, Hints).
+
 -spec compiler_telemetry(config()) -> ok.
 compiler_telemetry(Config) ->
   Path = src_path("diagnostics.erl"),