insert needed requires as additional text edits

skip completions that would need to alter imports

Author: lukaszsamson

apps/language_server/lib/language_server/providers/completion.ex

@@ -349,15 +349,15 @@ defmodule ElixirLS.LanguageServer.Providers.Completion do
         &("alias " <> &1)
       )
 
-    struct(completion_without_additional_text_edit,
+    %__MODULE__{completion_without_additional_text_edit |
       additional_text_edit: %TextEdit{
         range: range(line_to_insert_alias, 0, line_to_insert_alias, 0),
         newText: alias_edit
       },
       documentation: name <> "\n" <> summary,
       label_details: label_details,
       priority: 24
-    )
+    }
   end
 
   defp from_completion_item(
@@ -673,6 +673,14 @@ defmodule ElixirLS.LanguageServer.Providers.Completion do
        ),
        do: nil
 
+  # import with only or except was used and the completion would need to change it
+  # this is not trivial to implement and most likely not wanted so let's skip that
+  defp from_completion_item(
+        %{needed_import: needed_import},
+        _context,
+        _options
+      ) when needed_import != nil, do: nil
+
   defp from_completion_item(
          %{name: name, origin: origin} = item,
          %{def_before: nil} = context,
@@ -682,15 +690,39 @@ defmodule ElixirLS.LanguageServer.Providers.Completion do
 
     completion =
       if origin == "Kernel" || origin == "Kernel.SpecialForms" do
-        %{completion | kind: :keyword, priority: 18}
+        %__MODULE__{completion | kind: :keyword, priority: 18}
       else
         completion
       end
 
+    completion = if item.needed_require do
+      {line_to_insert_require, column_to_insert_require} = context.position_to_insert_alias
+      indentation =
+        if column_to_insert_require >= 1,
+          do: 1..column_to_insert_require |> Enum.map_join(fn _ -> " " end),
+          else: ""
+      require_edit = indentation <> "require " <> item.needed_require <> "\n"
+      label_details =
+        Map.update!(
+          completion.label_details,
+          "description",
+          &("require " <> &1)
+        )
+      %__MODULE__{completion | 
+        additional_text_edit: %TextEdit{
+          range: range(line_to_insert_require, 0, line_to_insert_require, 0),
+          newText: require_edit
+        },
+        label_details: label_details
+      }
+    else
+      completion
+    end
+
     file_path = Keyword.get(options, :file_path)
 
     if snippet = snippet_for({origin, name}, Map.put(context, :file_path, file_path)) do
-      %{completion | insert_text: snippet, kind: :snippet, label: name}
+      %__MODULE__{completion | insert_text: snippet, kind: :snippet, label: name}
     else
       completion
     end
@@ -977,7 +1009,6 @@ defmodule ElixirLS.LanguageServer.Providers.Completion do
   defp function_completion(info, context, options) do
     %{
       type: type,
-      args: args,
       args_list: args_list,
       name: name,
       summary: summary,
@@ -986,15 +1017,10 @@ defmodule ElixirLS.LanguageServer.Providers.Completion do
       origin: origin,
       metadata: metadata
     } = info
-
-    # ElixirSense now returns types as an atom
-    type = to_string(type)
-
     %{
       pipe_before?: pipe_before?,
       capture_before?: capture_before?,
       text_after_cursor: text_after_cursor,
-      module: module
     } = context
 
     locals_without_parens = Keyword.get(options, :locals_without_parens)
@@ -1036,15 +1062,6 @@ defmodule ElixirLS.LanguageServer.Providers.Completion do
           {label, insert_text}
       end
 
-    detail_prefix =
-      if inspect(module) == origin do
-        "(#{type}) "
-      else
-        "(#{type}) #{origin}."
-      end
-
-    detail = Enum.join([detail_prefix, name, "(", args, ")"])
-
     footer = SourceFile.format_spec(spec, line_length: 30)
 
     command =
@@ -1058,7 +1075,7 @@ defmodule ElixirLS.LanguageServer.Providers.Completion do
     %__MODULE__{
       label: label,
       kind: :function,
-      detail: detail,
+      detail: to_string(type),
       label_details: %{
         "detail" => "(#{Enum.join(args_list, ", ")})",
         "description" => "#{origin}.#{name}/#{arity}"

apps/language_server/test/providers/completion_test.exs

@@ -73,7 +73,7 @@ defmodule ElixirLS.LanguageServer.Providers.CompletionTest do
 
     completions =
       items
-      |> Enum.filter(&(&1["detail"] =~ "engineering_department"))
+      |> Enum.filter(&(&1["label"] =~ "engineering_department"))
       |> Enum.map(& &1["insertText"])
 
     assert completions == ["engineering_department()"]
@@ -483,6 +483,68 @@ defmodule ElixirLS.LanguageServer.Providers.CompletionTest do
     end
   end
 
+  describe "auto require" do
+    test "suggests require as additionalTextEdits" do
+      text = """
+      defmodule MyModule do
+        def dummy_function() do
+          Logger.err
+          #         ^
+        end
+      end
+      """
+
+      {line, char} = {2, 14}
+      TestUtils.assert_has_cursor_char(text, line, char)
+
+      {:ok, %{"items" => items}} = Completion.completion(text, line, char, @supports)
+
+      assert [item] = items
+
+      # 3 is function
+      assert item["kind"] == 3
+      assert item["label"] == "error"
+      assert item["detail"] == "macro"
+      assert item["labelDetails"]["detail"] == "(message_or_fun, metadata \\\\ [])"
+
+      assert item["labelDetails"]["description"] ==
+               "require Logger.error/2"
+
+      assert [%{newText: "  require Logger\n"}] =
+               item["additionalTextEdits"]
+
+      assert [
+               %{
+                 range: %{
+                   "end" => %{"character" => 0, "line" => 1},
+                   "start" => %{"character" => 0, "line" => 1}
+                 }
+               }
+             ] = item["additionalTextEdits"]
+    end
+  end
+
+  describe "auto import" do
+    test "no suggestion if import excluded" do
+      text = """
+      defmodule MyModule do
+        import Enum, only: [all?: 1]
+        def dummy_function() do
+          cou
+          #  ^
+        end
+      end
+      """
+
+      {line, char} = {3, 7}
+      TestUtils.assert_has_cursor_char(text, line, char)
+
+      {:ok, %{"items" => items}} = Completion.completion(text, line, char, @supports)
+
+      assert [] == items
+    end
+  end
+
   describe "structs and maps" do
     test "completions of structs are rendered as a struct" do
       text = """
@@ -974,11 +1036,11 @@ defmodule ElixirLS.LanguageServer.Providers.CompletionTest do
       {:ok, %{"items" => [pub, priv]}} = Completion.completion(text, line, char, @supports)
 
       assert pub["label"] == "my_func"
-      assert pub["detail"] == "(function) my_func(text)"
+      assert pub["detail"] == "function"
       assert pub["labelDetails"]["detail"] == "(text)"
       assert pub["labelDetails"]["description"] == "MyModule.my_func/1"
       assert priv["label"] == "my_func_priv"
-      assert priv["detail"] == "(function) my_func_priv(text)"
+      assert priv["detail"] == "function"
       assert priv["labelDetails"]["detail"] == "(text)"
       assert priv["labelDetails"]["description"] == "MyModule.my_func_priv/1"
     end
@@ -1004,7 +1066,7 @@ defmodule ElixirLS.LanguageServer.Providers.CompletionTest do
       {:ok, %{"items" => [item | _]}} = Completion.completion(text, line, char, @supports)
 
       assert item["label"] == "func"
-      assert item["detail"] == "(function) RemoteMod.func()"
+      assert item["detail"] == "function"
       assert item["labelDetails"]["detail"] == "()"
       assert item["labelDetails"]["description"] == "RemoteMod.func/0"
     end