From 4783cfbd2a24d6af45addfb04e9b9b29775dce55 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Jonatan=20K=C5=82osko?= <jonatanklosko@gmail.com>
Date: Sun, 18 Aug 2024 08:35:20 +0200
Subject: [PATCH] Generate a default signature for functions/types when docs
 are not available (#2751)

---
 lib/livebook/intellisense.ex        | 23 ++++++++++++++++-------
 test/livebook/intellisense_test.exs | 16 ++++++++++++++--
 2 files changed, 30 insertions(+), 9 deletions(-)

diff --git a/lib/livebook/intellisense.ex b/lib/livebook/intellisense.ex
index e566e82e3..043b17fa5 100644
--- a/lib/livebook/intellisense.ex
+++ b/lib/livebook/intellisense.ex
@@ -256,7 +256,7 @@ defmodule Livebook.Intellisense do
          documentation:
            join_with_newlines([
              format_documentation(documentation, :short),
-             code(format_signatures(signatures, module))
+             code(format_signatures(signatures, module, name, arity))
            ]),
          insert_text:
            cond do
@@ -494,7 +494,7 @@ defmodule Livebook.Intellisense do
          meta: meta
        }) do
     join_with_divider([
-      format_signatures(signatures, module) |> code(),
+      format_signatures(signatures, module, name, arity) |> code(),
       join_with_middle_dot([
         format_docs_link(module, {:function, name, arity}),
         format_meta(:since, meta)
@@ -514,7 +514,7 @@ defmodule Livebook.Intellisense do
          type_spec: type_spec
        }) do
     join_with_divider([
-      format_type_signature(type_spec, module) |> code(),
+      format_type_signature(type_spec, module, name, arity) |> code(),
       format_docs_link(module, {:type, name, arity}),
       format_type_spec(type_spec, @extended_line_length) |> code(),
       format_documentation(documentation, :all)
@@ -623,9 +623,11 @@ defmodule Livebook.Intellisense do
     end
   end
 
-  defp format_signatures([], _module), do: nil
+  defp format_signatures([], module, name, arity) do
+    signature_fallback(module, name, arity)
+  end
 
-  defp format_signatures(signatures, module) do
+  defp format_signatures(signatures, module, _name, _arity) do
     signatures_string = Enum.join(signatures, "\n")
 
     # Don't add module prefix to operator signatures
@@ -636,13 +638,20 @@ defmodule Livebook.Intellisense do
     end
   end
 
-  defp format_type_signature(nil, _module), do: nil
+  defp format_type_signature(nil, module, name, arity) do
+    signature_fallback(module, name, arity)
+  end
 
-  defp format_type_signature({_type_kind, type}, module) do
+  defp format_type_signature({_type_kind, type}, module, _name, _arity) do
     {:"::", _env, [lhs, _rhs]} = Code.Typespec.type_to_quoted(type)
     inspect(module) <> "." <> Macro.to_string(lhs)
   end
 
+  defp signature_fallback(module, name, arity) do
+    args = Enum.map_join(1..arity//1, ", ", fn n -> "arg#{n}" end)
+    "#{inspect(module)}.#{name}(#{args})"
+  end
+
   defp format_meta(:deprecated, %{deprecated: deprecated}) do
     "**Deprecated**. " <> deprecated
   end
diff --git a/test/livebook/intellisense_test.exs b/test/livebook/intellisense_test.exs
index a4ded3f07..d8c575ca6 100644
--- a/test/livebook/intellisense_test.exs
+++ b/test/livebook/intellisense_test.exs
@@ -2024,7 +2024,13 @@ defmodule Livebook.IntellisenseTest do
       assert %{
                label: "hello/1",
                kind: :function,
-               documentation: "No documentation available",
+               documentation: """
+               No documentation available
+
+               ```
+               RemoteModule.hello(arg1)
+               ```\
+               """,
                insert_text: "hello(${})"
              } in Intellisense.get_completion_items("RemoteModule.hel", context, node)
     end
@@ -2037,7 +2043,13 @@ defmodule Livebook.IntellisenseTest do
                %{
                  label: "unsubscribe/1",
                  kind: :function,
-                 documentation: "No documentation available",
+                 documentation: """
+                 No documentation available
+
+                 ```
+                 :mnesia.unsubscribe(arg1)
+                 ```\
+                 """,
                  insert_text: "unsubscribe(${})"
                }
              ] = Intellisense.get_completion_items(":mnesia.unsub", context, node)