livebook-dev/livebook
1
1
Fork 0
mirror of https://github.com/livebook-dev/livebook.git synced 2025-10-26 21:36:02 +08:00
Code Issues Projects Releases Packages Wiki Activity

Simplify autocompletion info into a single markdown field (#2470)

Browse source
This commit is contained in:
Jonatan Kłosko 2024-02-02 17:55:15 +01:00 • committed by GitHub
parent 85c8b3e7ec
commit fb604dee2f
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
6 changed files with 213 additions and 204 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

25
assets/js/hooks/cell_editor/live_editor.js
View file

@ -424,28 +424,17 @@ export default class LiveEditor {
label: item.label, label: item.label,
type: item.kind, type: item.kind,
info: (completion) => { info: (completion) => {
if (item.documentation === null) return null;
// The info popup is shown automatically, we delay it a bit // The info popup is shown automatically, we delay it a bit
// to not distract the user too much as they are typing // to not distract the user too much as they are typing
return wait(350).then(() => { return wait(350).then(() => {
const node = document.createElement("div"); const node = document.createElement("div");
node.classList.add("cm-completionInfoDocs");
if (item.detail) { node.classList.add("cm-markdown");
const detail = document.createElement("div"); new Markdown(node, item.documentation, {
detail.classList.add("cm-completionInfoDetail"); defaultCodeLanguage: this.language,
detail.innerHTML = highlight(item.detail, this.language); });
node.appendChild(detail);
}
if (item.documentation) {
const docs = document.createElement("div");
docs.classList.add("cm-completionInfoDocs");
docs.classList.add("cm-markdown");
node.appendChild(docs);
new Markdown(docs, item.documentation, {
defaultCodeLanguage: this.language,
});
}
return node; return node;
}); });
}, },

18
assets/js/hooks/cell_editor/live_editor/codemirror/theme.js vendored
View file

@ -239,16 +239,8 @@ function buildEditorTheme(colors, { dark }) {
marginRight: "4px", marginRight: "4px",
}, },
"& .cm-completionInfoDetail": {
padding: "6px",
},
"& .cm-completionInfoDocs": { "& .cm-completionInfoDocs": {
padding: "6px", padding: "6px",
"&:not(:first-child)": {
borderTop: `1px solid ${colors.separator}`,
},
}, },
}, },
@ -404,8 +396,14 @@ function buildEditorTheme(colors, { dark }) {
borderRadius: "3px", borderRadius: "3px",
}, },
"& pre code": { "& pre": {
background: "transparent", marginTop: "0.5rem",
marginBottom: "0.5rem",
"& code": {
background: "transparent",
whiteSpace: "pre-wrap",
},
}, },
"& > :first-child": { "& > :first-child": {

64
lib/livebook/intellisense.ex
View file

@ -135,8 +135,7 @@ defmodule Livebook.Intellisense do
do: %{ do: %{
label: Atom.to_string(name), label: Atom.to_string(name),
kind: :variable, kind: :variable,
detail: "variable", documentation: "(variable)",
documentation: nil,
insert_text: Atom.to_string(name) insert_text: Atom.to_string(name)
} }
@ -144,8 +143,7 @@ defmodule Livebook.Intellisense do
do: %{ do: %{
label: Atom.to_string(name), label: Atom.to_string(name),
kind: :field, kind: :field,
detail: "field", documentation: "(field)",
documentation: nil,
insert_text: Atom.to_string(name) insert_text: Atom.to_string(name)
} }
@ -153,8 +151,7 @@ defmodule Livebook.Intellisense do
do: %{ do: %{
label: Atom.to_string(name), label: Atom.to_string(name),
kind: :field, kind: :field,
detail: "field", documentation: "(field)",
documentation: nil,
insert_text: "#{name}: " insert_text: "#{name}: "
} }
@ -167,16 +164,16 @@ defmodule Livebook.Intellisense do
do: %{ do: %{
label: Atom.to_string(name), label: Atom.to_string(name),
kind: :field, kind: :field,
detail: "#{inspect(struct)} struct field",
documentation: documentation:
join_with_divider([ join_with_divider([
code(name),
""" """
`%#{inspect(struct)}{}` struct field.
**Default** **Default**
``` ```
#{inspect(default, pretty: true, width: @line_length)} #{inspect(default, pretty: true, width: @line_length)}
``` ```\
""" """
]), ]),
insert_text: "#{name}: " insert_text: "#{name}: "
@ -204,8 +201,11 @@ defmodule Livebook.Intellisense do
%{ %{
label: display_name, label: display_name,
kind: kind, kind: kind,
detail: detail, documentation:
documentation: format_documentation(documentation, :short), join_with_newlines([
format_documentation(documentation, :short),
"(#{detail})"
]),
insert_text: String.trim_leading(display_name, ":") insert_text: String.trim_leading(display_name, ":")
} }
end end
@ -218,17 +218,15 @@ defmodule Livebook.Intellisense do
type: type, type: type,
display_name: display_name, display_name: display_name,
documentation: documentation, documentation: documentation,
signatures: signatures, signatures: signatures
specs: specs
}), }),
do: %{ do: %{
label: "#{display_name}/#{arity}", label: "#{display_name}/#{arity}",
kind: :function, kind: :function,
detail: format_signatures(signatures, module),
documentation: documentation:
join_with_newlines([ join_with_newlines([
format_documentation(documentation, :short), format_documentation(documentation, :short),
format_specs(specs, name, @line_length) |> code() code(format_signatures(signatures, module))
]), ]),
insert_text: insert_text:
cond do cond do
@ -255,7 +253,6 @@ defmodule Livebook.Intellisense do
defp format_completion_item(%{ defp format_completion_item(%{
kind: :type, kind: :type,
module: module,
name: name, name: name,
arity: arity, arity: arity,
documentation: documentation, documentation: documentation,
@ -264,7 +261,6 @@ defmodule Livebook.Intellisense do
do: %{ do: %{
label: "#{name}/#{arity}", label: "#{name}/#{arity}",
kind: :type, kind: :type,
detail: format_type_signature(type_spec, module),
documentation: documentation:
join_with_newlines([ join_with_newlines([
format_documentation(documentation, :short), format_documentation(documentation, :short),
@ -281,8 +277,11 @@ defmodule Livebook.Intellisense do
do: %{ do: %{
label: Atom.to_string(name), label: Atom.to_string(name),
kind: :variable, kind: :variable,
detail: "module attribute", documentation:
documentation: format_documentation(documentation, :short), join_with_newlines([
format_documentation(documentation, :short),
"(module attribute)"
]),
insert_text: Atom.to_string(name) insert_text: Atom.to_string(name)
} }
@ -296,9 +295,8 @@ defmodule Livebook.Intellisense do
%{ %{
label: Atom.to_string(name), label: Atom.to_string(name),
kind: :bitstring_option, kind: :type,
detail: "bitstring option", documentation: "(bitstring option)",
documentation: nil,
insert_text: insert_text insert_text: insert_text
} }
end end
@ -340,29 +338,25 @@ defmodule Livebook.Intellisense do
%{ %{
label: "true", label: "true",
kind: :keyword, kind: :keyword,
detail: "boolean", documentation: "(boolean)",
documentation: nil,
insert_text: "true" insert_text: "true"
}, },
%{ %{
label: "false", label: "false",
kind: :keyword, kind: :keyword,
detail: "boolean", documentation: "(boolean)",
documentation: nil,
insert_text: "false" insert_text: "false"
}, },
%{ %{
label: "nil", label: "nil",
kind: :keyword, kind: :keyword,
detail: "special atom", documentation: "(special atom)",
documentation: nil,
insert_text: "nil" insert_text: "nil"
}, },
%{ %{
label: "when", label: "when",
kind: :keyword, kind: :keyword,
detail: "guard operator", documentation: "(guard operator)",
documentation: nil,
insert_text: "when" insert_text: "when"
} }
] ]
@ -388,8 +382,12 @@ defmodule Livebook.Intellisense do
:bitstring_option :bitstring_option
] ]
defp completion_item_priority(%{kind: :struct, detail: "exception"} = completion_item) do defp completion_item_priority(%{kind: :struct} = completion_item) do
{length(@ordered_kinds), completion_item.label} if completion_item.documentation =~ "(exception)" do
{length(@ordered_kinds), completion_item.label}
else
{completion_item_kind_priority(completion_item.kind), completion_item.label}
end
end end
defp completion_item_priority(completion_item) do defp completion_item_priority(completion_item) do
@ -438,7 +436,7 @@ defmodule Livebook.Intellisense do
``` ```
#{inspect(default, pretty: true, width: @line_length)} #{inspect(default, pretty: true, width: @line_length)}
``` ```\
""" """
]) ])
end end

1
lib/livebook/runtime.ex
View file

@ -531,7 +531,6 @@ defprotocol Livebook.Runtime do
@type completion_item :: %{ @type completion_item :: %{
label: String.t(), label: String.t(),
kind: completion_item_kind(), kind: completion_item_kind(),
detail: String.t() | nil,
documentation: String.t() | nil, documentation: String.t() | nil,
insert_text: String.t() insert_text: String.t()
} }

300
test/livebook/intellisense_test.exs
View file

@ -50,12 +50,11 @@ defmodule Livebook.IntellisenseTest do
length_item = %{ length_item = %{
label: "length/1", label: "length/1",
kind: :function, kind: :function,
detail: "Kernel.length(list)",
documentation: """ documentation: """
Returns the length of `list`. Returns the length of `list`.
``` ```
@spec length(list()) :: non_neg_integer() Kernel.length(list)
```\ ```\
""", """,
insert_text: "length(${})" insert_text: "length(${})"
@ -74,8 +73,11 @@ defmodule Livebook.IntellisenseTest do
%{ %{
label: ":zlib", label: ":zlib",
kind: :module, kind: :module,
detail: "module", documentation: """
documentation: "zlib compression interface.", zlib compression interface.
(module)\
""",
insert_text: "zlib" insert_text: "zlib"
} }
] = Intellisense.get_completion_items(":zl", context, node()) ] = Intellisense.get_completion_items(":zl", context, node())
@ -94,14 +96,12 @@ defmodule Livebook.IntellisenseTest do
%{ %{
label: ":orddict", label: ":orddict",
kind: :module, kind: :module,
detail: "module",
documentation: _orddict_doc, documentation: _orddict_doc,
insert_text: "orddict" insert_text: "orddict"
}, },
%{ %{
label: ":ordsets", label: ":ordsets",
kind: :module, kind: :module,
detail: "module",
documentation: _ordsets_doc, documentation: _ordsets_doc,
insert_text: "ordsets" insert_text: "ordsets"
} }
@ -115,8 +115,11 @@ defmodule Livebook.IntellisenseTest do
lists_item = %{ lists_item = %{
label: ":lists", label: ":lists",
kind: :module, kind: :module,
detail: "module", documentation: """
documentation: "List processing functions.", List processing functions.
(module)\
""",
insert_text: "lists" insert_text: "lists"
} }
@ -139,7 +142,6 @@ defmodule Livebook.IntellisenseTest do
%{ %{
label: "open_port/2", label: "open_port/2",
kind: :function, kind: :function,
detail: ":erlang.open_port/2",
documentation: _open_port_doc, documentation: _open_port_doc,
insert_text: "open_port(${})" insert_text: "open_port(${})"
} }
@ -155,7 +157,6 @@ defmodule Livebook.IntellisenseTest do
assert %{ assert %{
label: "iterator/0", label: "iterator/0",
kind: :type, kind: :type,
detail: ":maps.iterator()",
documentation: """ documentation: """
No documentation available No documentation available
@ -169,7 +170,6 @@ defmodule Livebook.IntellisenseTest do
assert %{ assert %{
label: "iterator/2", label: "iterator/2",
kind: :type, kind: :type,
detail: ":maps.iterator(key, value)",
documentation: """ documentation: """
An iterator representing the associations in a map with keys of type `Key` and values of type `Value`. An iterator representing the associations in a map with keys of type `Key` and values of type `Value`.
@ -187,8 +187,11 @@ defmodule Livebook.IntellisenseTest do
assert %{ assert %{
label: "Elixir", label: "Elixir",
kind: :module, kind: :module,
detail: "module", documentation: """
documentation: "No documentation available", No documentation available
(module)\
""",
insert_text: "Elixir" insert_text: "Elixir"
} in Intellisense.get_completion_items("Eli", context, node()) } in Intellisense.get_completion_items("Eli", context, node())
end end
@ -200,15 +203,21 @@ defmodule Livebook.IntellisenseTest do
%{ %{
label: "Enum", label: "Enum",
kind: :module, kind: :module,
detail: "module", documentation: """
documentation: "Functions for working with collections (known as enumerables).", Functions for working with collections (known as enumerables).
(module)\
""",
insert_text: "Enum" insert_text: "Enum"
}, },
%{ %{
label: "Enumerable", label: "Enumerable",
kind: :interface, kind: :interface,
detail: "protocol", documentation: """
documentation: "Enumerable protocol used by `Enum` and `Stream` modules.", Enumerable protocol used by `Enum` and `Stream` modules.
(protocol)\
""",
insert_text: "Enumerable" insert_text: "Enumerable"
} }
] = Intellisense.get_completion_items("En", context, node()) ] = Intellisense.get_completion_items("En", context, node())
@ -217,8 +226,11 @@ defmodule Livebook.IntellisenseTest do
%{ %{
label: "Enumerable", label: "Enumerable",
kind: :interface, kind: :interface,
detail: "protocol", documentation: """
documentation: "Enumerable protocol used by `Enum` and `Stream` modules.", Enumerable protocol used by `Enum` and `Stream` modules.
(protocol)\
""",
insert_text: "Enumerable" insert_text: "Enumerable"
} }
] = Intellisense.get_completion_items("Enumera", context, node()) ] = Intellisense.get_completion_items("Enumera", context, node())
@ -227,8 +239,11 @@ defmodule Livebook.IntellisenseTest do
%{ %{
label: "RuntimeError", label: "RuntimeError",
kind: :struct, kind: :struct,
detail: "exception", documentation: """
documentation: "An exception for a generic runtime error.", An exception for a generic runtime error.
(exception)\
""",
insert_text: "RuntimeError" insert_text: "RuntimeError"
} }
] = Intellisense.get_completion_items("RuntimeE", context, node()) ] = Intellisense.get_completion_items("RuntimeE", context, node())
@ -250,8 +265,11 @@ defmodule Livebook.IntellisenseTest do
assert %{ assert %{
label: "File.Stat", label: "File.Stat",
kind: :struct, kind: :struct,
detail: "struct", documentation: """
documentation: "A struct that holds file information.", A struct that holds file information.
(struct)\
""",
insert_text: "File.Stat" insert_text: "File.Stat"
} in Intellisense.get_completion_items("%Fi", context, node()) } in Intellisense.get_completion_items("%Fi", context, node())
end end
@ -263,7 +281,6 @@ defmodule Livebook.IntellisenseTest do
%{ %{
label: "from/0", label: "from/0",
kind: :type, kind: :type,
detail: "GenServer.from()",
documentation: """ documentation: """
Tuple describing the client of a call request. Tuple describing the client of a call request.
@ -279,7 +296,6 @@ defmodule Livebook.IntellisenseTest do
%{ %{
label: "internal/1", label: "internal/1",
kind: :type, kind: :type,
detail: "MapSet.internal(value)",
documentation: """ documentation: """
No documentation available No documentation available
@ -299,8 +315,11 @@ defmodule Livebook.IntellisenseTest do
%{ %{
label: "Enumerable", label: "Enumerable",
kind: :interface, kind: :interface,
detail: "protocol", documentation: """
documentation: "Enumerable protocol used by `Enum` and `Stream` modules.", Enumerable protocol used by `Enum` and `Stream` modules.
(protocol)\
""",
insert_text: "Enumerable" insert_text: "Enumerable"
} }
] = Intellisense.get_completion_items("Enumerable", context, node()) ] = Intellisense.get_completion_items("Enumerable", context, node())
@ -312,8 +331,11 @@ defmodule Livebook.IntellisenseTest do
assert %{ assert %{
label: "Jason", label: "Jason",
kind: :module, kind: :module,
detail: "module", documentation: """
documentation: "A blazing fast JSON parser and generator in pure Elixir.", A blazing fast JSON parser and generator in pure Elixir.
(module)\
""",
insert_text: "Jason" insert_text: "Jason"
} in Intellisense.get_completion_items("Jas", context, node()) } in Intellisense.get_completion_items("Jas", context, node())
end end
@ -338,11 +360,16 @@ defmodule Livebook.IntellisenseTest do
assert [ assert [
%{ %{
detail: "Livebook.TestModules.Hidden.visible()", label: "visible/0",
documentation: "No documentation available",
insert_text: "visible()",
kind: :function, kind: :function,
label: "visible/0" documentation: """
No documentation available
```
Livebook.TestModules.Hidden.visible()
```\
""",
insert_text: "visible()"
} }
] = ] =
Intellisense.get_completion_items("Livebook.TestModules.Hidden.", context, node()) Intellisense.get_completion_items("Livebook.TestModules.Hidden.", context, node())
@ -355,8 +382,11 @@ defmodule Livebook.IntellisenseTest do
%{ %{
label: "Access", label: "Access",
kind: :interface, kind: :interface,
detail: "behaviour", documentation: """
documentation: "Key-based access to data structures.", Key-based access to data structures.
(behaviour)\
""",
insert_text: "Access" insert_text: "Access"
} }
] = Intellisense.get_completion_items("Elixir.Acce", context, node()) ] = Intellisense.get_completion_items("Elixir.Acce", context, node())
@ -369,8 +399,11 @@ defmodule Livebook.IntellisenseTest do
%{ %{
label: "ANSI", label: "ANSI",
kind: :module, kind: :module,
detail: "module", documentation: """
documentation: "Functionality to render ANSI escape sequences.", Functionality to render ANSI escape sequences.
(module)\
""",
insert_text: "ANSI" insert_text: "ANSI"
} }
] = Intellisense.get_completion_items("IO.AN", context, node()) ] = Intellisense.get_completion_items("IO.AN", context, node())
@ -389,12 +422,11 @@ defmodule Livebook.IntellisenseTest do
%{ %{
label: "version/0", label: "version/0",
kind: :function, kind: :function,
detail: "System.version()",
documentation: """ documentation: """
Elixir version information. Elixir version information.
``` ```
@spec version() :: String.t() System.version()
```\ ```\
""", """,
insert_text: "version()" insert_text: "version()"
@ -408,8 +440,13 @@ defmodule Livebook.IntellisenseTest do
regex_item = %{ regex_item = %{
label: "~r/2", label: "~r/2",
kind: :function, kind: :function,
detail: "Kernel.sigil_r(term, modifiers)", documentation: """
documentation: "Handles the sigil `~r` for regular expressions.", Handles the sigil `~r` for regular expressions.
```
Kernel.sigil_r(term, modifiers)
```\
""",
insert_text: "~r" insert_text: "~r"
} }
@ -425,14 +462,11 @@ defmodule Livebook.IntellisenseTest do
assert %{ assert %{
label: "gzip/1", label: "gzip/1",
kind: :function, kind: :function,
detail: ":zlib.gzip/1",
documentation: """ documentation: """
Compresses data with gz headers and checksum. Compresses data with gz headers and checksum.
``` ```
@spec gzip(data) :: compressed :zlib.gzip/1
when data: iodata(),
compressed: binary()
```\ ```\
""", """,
insert_text: "gzip(${})" insert_text: "gzip(${})"
@ -445,13 +479,12 @@ defmodule Livebook.IntellisenseTest do
assert %{ assert %{
label: "concat/1", label: "concat/1",
kind: :function, kind: :function,
detail: "Enum.concat(enumerables)",
documentation: """ documentation: """
Given an enumerable of enumerables, concatenates the `enumerables` into Given an enumerable of enumerables, concatenates the `enumerables` into
a single list. a single list.
``` ```
@spec concat(t()) :: t() Enum.concat(enumerables)
```\ ```\
""", """,
insert_text: "concat(${})" insert_text: "concat(${})"
@ -470,13 +503,12 @@ defmodule Livebook.IntellisenseTest do
%{ %{
label: "concat/1", label: "concat/1",
kind: :function, kind: :function,
detail: "Enum.concat(enumerables)",
documentation: """ documentation: """
Given an enumerable of enumerables, concatenates the `enumerables` into Given an enumerable of enumerables, concatenates the `enumerables` into
a single list. a single list.
``` ```
@spec concat(t()) :: t() Enum.concat(enumerables)
```\ ```\
""", """,
insert_text: "concat(${})" insert_text: "concat(${})"
@ -484,13 +516,12 @@ defmodule Livebook.IntellisenseTest do
%{ %{
label: "concat/2", label: "concat/2",
kind: :function, kind: :function,
detail: "Enum.concat(left, right)",
documentation: """ documentation: """
Concatenates the enumerable on the `right` with the enumerable on the Concatenates the enumerable on the `right` with the enumerable on the
`left`. `left`.
``` ```
@spec concat(t(), t()) :: t() Enum.concat(left, right)
```\ ```\
""", """,
insert_text: "concat(${})" insert_text: "concat(${})"
@ -505,12 +536,11 @@ defmodule Livebook.IntellisenseTest do
%{ %{
label: "utc_today/0", label: "utc_today/0",
kind: :function, kind: :function,
detail: "Date.utc_today(calendar \\\\ Calendar.ISO)",
documentation: """ documentation: """
Returns the current date in UTC. Returns the current date in UTC.
``` ```
@spec utc_today(Calendar.calendar()) :: t() Date.utc_today(calendar \\\\ Calendar.ISO)
```\ ```\
""", """,
insert_text: "utc_today()" insert_text: "utc_today()"
@ -518,12 +548,11 @@ defmodule Livebook.IntellisenseTest do
%{ %{
label: "utc_today/1", label: "utc_today/1",
kind: :function, kind: :function,
detail: "Date.utc_today(calendar \\\\ Calendar.ISO)",
documentation: """ documentation: """
Returns the current date in UTC. Returns the current date in UTC.
``` ```
@spec utc_today(Calendar.calendar()) :: t() Date.utc_today(calendar \\\\ Calendar.ISO)
```\ ```\
""", """,
insert_text: "utc_today(${})" insert_text: "utc_today(${})"
@ -541,12 +570,11 @@ defmodule Livebook.IntellisenseTest do
%{ %{
label: "version/0", label: "version/0",
kind: :function, kind: :function,
detail: "System.version()",
documentation: """ documentation: """
Elixir version information. Elixir version information.
``` ```
@spec version() :: String.t() System.version()
```\ ```\
""", """,
insert_text: "version()" insert_text: "version()"
@ -561,13 +589,11 @@ defmodule Livebook.IntellisenseTest do
%{ %{
label: "++/2", label: "++/2",
kind: :function, kind: :function,
detail: "left ++ right",
documentation: """ documentation: """
List concatenation operator. Concatenates a proper list and a term, returning a list. List concatenation operator. Concatenates a proper list and a term, returning a list.
``` ```
@spec list() ++ term() :: left ++ right
maybe_improper_list()
```\ ```\
""", """,
insert_text: "++" insert_text: "++"
@ -575,13 +601,11 @@ defmodule Livebook.IntellisenseTest do
%{ %{
label: "+/1", label: "+/1",
kind: :function, kind: :function,
detail: "+value",
documentation: """ documentation: """
Arithmetic positive unary operator. Arithmetic positive unary operator.
``` ```
@spec +integer() :: integer() +value
@spec +float() :: float()
```\ ```\
""", """,
insert_text: "+" insert_text: "+"
@ -589,15 +613,11 @@ defmodule Livebook.IntellisenseTest do
%{ %{
label: "+/2", label: "+/2",
kind: :function, kind: :function,
detail: "left + right",
documentation: """ documentation: """
Arithmetic addition operator. Arithmetic addition operator.
``` ```
@spec integer() + integer() :: integer() left + right
@spec float() + float() :: float()
@spec integer() + float() :: float()
@spec float() + integer() :: float()
```\ ```\
""", """,
insert_text: "+" insert_text: "+"
@ -628,22 +648,19 @@ defmodule Livebook.IntellisenseTest do
%{ %{
label: "bar_1", label: "bar_1",
kind: :field, kind: :field,
detail: "field", documentation: "(field)",
documentation: nil,
insert_text: "bar_1" insert_text: "bar_1"
}, },
%{ %{
label: "bar_2", label: "bar_2",
kind: :field, kind: :field,
detail: "field", documentation: "(field)",
documentation: nil,
insert_text: "bar_2" insert_text: "bar_2"
}, },
%{ %{
label: "foo", label: "foo",
kind: :field, kind: :field,
detail: "field", documentation: "(field)",
documentation: nil,
insert_text: "foo" insert_text: "foo"
} }
] = Intellisense.get_completion_items("map.", context, node()) ] = Intellisense.get_completion_items("map.", context, node())
@ -652,8 +669,7 @@ defmodule Livebook.IntellisenseTest do
%{ %{
label: "foo", label: "foo",
kind: :field, kind: :field,
detail: "field", documentation: "(field)",
documentation: nil,
insert_text: "foo" insert_text: "foo"
} }
] = Intellisense.get_completion_items("map.f", context, node()) ] = Intellisense.get_completion_items("map.f", context, node())
@ -678,8 +694,7 @@ defmodule Livebook.IntellisenseTest do
%{ %{
label: "nested", label: "nested",
kind: :field, kind: :field,
detail: "field", documentation: "(field)",
documentation: nil,
insert_text: "nested" insert_text: "nested"
} }
] = Intellisense.get_completion_items("map.nest", context, node()) ] = Intellisense.get_completion_items("map.nest", context, node())
@ -688,8 +703,7 @@ defmodule Livebook.IntellisenseTest do
%{ %{
label: "foo", label: "foo",
kind: :field, kind: :field,
detail: "field", documentation: "(field)",
documentation: nil,
insert_text: "foo" insert_text: "foo"
} }
] = Intellisense.get_completion_items("map.nested.deeply.f", context, node()) ] = Intellisense.get_completion_items("map.nested.deeply.f", context, node())
@ -698,12 +712,11 @@ defmodule Livebook.IntellisenseTest do
%{ %{
label: "version/0", label: "version/0",
kind: :function, kind: :function,
detail: "System.version()",
documentation: """ documentation: """
Elixir version information. Elixir version information.
``` ```
@spec version() :: String.t() System.version()
```\ ```\
""", """,
insert_text: "version()" insert_text: "version()"
@ -751,8 +764,13 @@ defmodule Livebook.IntellisenseTest do
%{ %{
label: "is_nil/1", label: "is_nil/1",
kind: :function, kind: :function,
detail: "Kernel.is_nil(term)", documentation: """
documentation: "Returns `true` if `term` is `nil`, `false` otherwise.", Returns `true` if `term` is `nil`, `false` otherwise.
```
Kernel.is_nil(term)
```\
""",
insert_text: "is_nil(${})" insert_text: "is_nil(${})"
} }
] = Intellisense.get_completion_items("Kernel.is_ni", context, node()) ] = Intellisense.get_completion_items("Kernel.is_ni", context, node())
@ -765,8 +783,13 @@ defmodule Livebook.IntellisenseTest do
%{ %{
label: "quote/2", label: "quote/2",
kind: :function, kind: :function,
detail: "Kernel.SpecialForms.quote(opts, block)", documentation: """
documentation: "Gets the representation of any expression.", Gets the representation of any expression.
```
Kernel.SpecialForms.quote(opts, block)
```\
""",
insert_text: "quote " insert_text: "quote "
} }
] = Intellisense.get_completion_items("quot", context, node()) ] = Intellisense.get_completion_items("quot", context, node())
@ -779,23 +802,23 @@ defmodule Livebook.IntellisenseTest do
%{ %{
label: "put_in/2", label: "put_in/2",
kind: :function, kind: :function,
detail: "Kernel.put_in(path, value)", documentation: """
documentation: "Puts a value in a nested structure via the given `path`.", Puts a value in a nested structure via the given `path`.
```
Kernel.put_in(path, value)
```\
""",
insert_text: "put_in(${})" insert_text: "put_in(${})"
}, },
%{ %{
label: "put_in/3", label: "put_in/3",
kind: :function, kind: :function,
detail: "Kernel.put_in(data, keys, value)",
documentation: """ documentation: """
Puts a value in a nested structure. Puts a value in a nested structure.
``` ```
@spec put_in( Kernel.put_in(data, keys, value)
Access.t(),
[term(), ...],
term()
) :: Access.t()
```\ ```\
""", """,
insert_text: "put_in(${})" insert_text: "put_in(${})"
@ -815,8 +838,7 @@ defmodule Livebook.IntellisenseTest do
%{ %{
label: "numbats", label: "numbats",
kind: :variable, kind: :variable,
detail: "variable", documentation: "(variable)",
documentation: nil,
insert_text: "numbats" insert_text: "numbats"
} }
] = Intellisense.get_completion_items("numba", context, node()) ] = Intellisense.get_completion_items("numba", context, node())
@ -825,15 +847,13 @@ defmodule Livebook.IntellisenseTest do
%{ %{
label: "numbats", label: "numbats",
kind: :variable, kind: :variable,
detail: "variable", documentation: "(variable)",
documentation: nil,
insert_text: "numbats" insert_text: "numbats"
}, },
%{ %{
label: "number", label: "number",
kind: :variable, kind: :variable,
detail: "variable", documentation: "(variable)",
documentation: nil,
insert_text: "number" insert_text: "number"
} }
] = Intellisense.get_completion_items("num", context, node()) ] = Intellisense.get_completion_items("num", context, node())
@ -842,8 +862,7 @@ defmodule Livebook.IntellisenseTest do
%{ %{
label: "nothing", label: "nothing",
kind: :variable, kind: :variable,
detail: "variable", documentation: "(variable)",
documentation: nil,
insert_text: "nothing" insert_text: "nothing"
}, },
%{label: "node/0"}, %{label: "node/0"},
@ -870,12 +889,11 @@ defmodule Livebook.IntellisenseTest do
assert %{ assert %{
label: "version/0", label: "version/0",
kind: :function, kind: :function,
detail: "System.version()",
documentation: """ documentation: """
Elixir version information. Elixir version information.
``` ```
@spec version() :: String.t() System.version()
```\ ```\
""", """,
insert_text: "version()" insert_text: "version()"
@ -1029,13 +1047,11 @@ defmodule Livebook.IntellisenseTest do
assert %{ assert %{
label: "max/1", label: "max/1",
kind: :function, kind: :function,
detail: ":lists.max/1",
documentation: """ documentation: """
Returns the first element of `List` that compares greater than or equal to all other elements of `List`. Returns the first element of `List` that compares greater than or equal to all other elements of `List`.
``` ```
@spec max(list) :: max :lists.max/1
when list: [t, ...], max: t, t: term()
```\ ```\
""", """,
insert_text: "max(${})" insert_text: "max(${})"
@ -1116,8 +1132,15 @@ defmodule Livebook.IntellisenseTest do
%{ %{
label: "my_val", label: "my_val",
kind: :field, kind: :field,
detail: "Livebook.IntellisenseTest.MyStruct struct field", documentation: """
documentation: "```\nmy_val\n```\n\n---\n\n**Default**\n\n```\nnil\n```\n", `%Livebook.IntellisenseTest.MyStruct{}` struct field.
**Default**
```
nil
```\
""",
insert_text: "my_val: " insert_text: "my_val: "
} }
] = ] =
@ -1154,7 +1177,6 @@ defmodule Livebook.IntellisenseTest do
%{ %{
label: "my_val", label: "my_val",
kind: :field, kind: :field,
detail: "Livebook.IntellisenseTest.MyStruct struct field",
documentation: _my_val_doc, documentation: _my_val_doc,
insert_text: "my_val: " insert_text: "my_val: "
} }
@ -1169,7 +1191,6 @@ defmodule Livebook.IntellisenseTest do
%{ %{
label: "my_val", label: "my_val",
kind: :field, kind: :field,
detail: "Livebook.IntellisenseTest.MyStruct struct field",
documentation: _my_val_doc, documentation: _my_val_doc,
insert_text: "my_val: " insert_text: "my_val: "
} }
@ -1198,8 +1219,7 @@ defmodule Livebook.IntellisenseTest do
%{ %{
label: "foo", label: "foo",
kind: :field, kind: :field,
detail: "field", documentation: "(field)",
documentation: nil,
insert_text: "foo: " insert_text: "foo: "
} }
] = Intellisense.get_completion_items("%{map | ", context, node()) ] = Intellisense.get_completion_items("%{map | ", context, node())
@ -1208,8 +1228,7 @@ defmodule Livebook.IntellisenseTest do
%{ %{
label: "foo", label: "foo",
kind: :field, kind: :field,
detail: "field", documentation: "(field)",
documentation: nil,
insert_text: "foo: " insert_text: "foo: "
} }
] = Intellisense.get_completion_items("%{map | fo", context, node()) ] = Intellisense.get_completion_items("%{map | fo", context, node())
@ -1240,8 +1259,11 @@ defmodule Livebook.IntellisenseTest do
%{ %{
label: "moduledoc", label: "moduledoc",
kind: :variable, kind: :variable,
detail: "module attribute", documentation: """
documentation: "Provides documentation for the current module.", Provides documentation for the current module.
(module attribute)\
""",
insert_text: "moduledoc" insert_text: "moduledoc"
} }
] = Intellisense.get_completion_items("@modu", context, node()) ] = Intellisense.get_completion_items("@modu", context, node())
@ -1259,8 +1281,7 @@ defmodule Livebook.IntellisenseTest do
%{ %{
label: "nil", label: "nil",
kind: :keyword, kind: :keyword,
detail: "special atom", documentation: "(special atom)",
documentation: nil,
insert_text: "nil" insert_text: "nil"
} }
| _ | _
@ -1305,30 +1326,27 @@ defmodule Livebook.IntellisenseTest do
assert [ assert [
%{ %{
detail: "bitstring option", label: "integer",
documentation: nil, kind: :type,
insert_text: "integer", documentation: "(bitstring option)",
kind: :bitstring_option, insert_text: "integer"
label: "integer"
} }
] = Intellisense.get_completion_items("<<a::intege", context, node()) ] = Intellisense.get_completion_items("<<a::intege", context, node())
assert [ assert [
%{ %{
detail: "bitstring option", label: "size",
documentation: nil, kind: :type,
insert_text: "size(${})", documentation: "(bitstring option)",
kind: :bitstring_option, insert_text: "size(${})"
label: "size"
} }
] = Intellisense.get_completion_items("<<a::siz", context, node()) ] = Intellisense.get_completion_items("<<a::siz", context, node())
assert %{ assert %{
detail: "bitstring option", label: "integer",
documentation: nil, kind: :type,
insert_text: "integer", documentation: "(bitstring option)",
kind: :bitstring_option, insert_text: "integer"
label: "integer"
} in Intellisense.get_completion_items("<<a::", context, node()) } in Intellisense.get_completion_items("<<a::", context, node())
end end
@ -1339,8 +1357,11 @@ defmodule Livebook.IntellisenseTest do
%{ %{
label: "Range", label: "Range",
kind: :struct, kind: :struct,
detail: "struct", documentation: """
documentation: "Returns an inclusive range between dates.", Returns an inclusive range between dates.
(struct)\
""",
insert_text: "Range" insert_text: "Range"
} }
] = Intellisense.get_completion_items("alias Date.", context, node()) ] = Intellisense.get_completion_items("alias Date.", context, node())
@ -1348,8 +1369,11 @@ defmodule Livebook.IntellisenseTest do
assert %{ assert %{
label: "Atom", label: "Atom",
kind: :module, kind: :module,
detail: "module", documentation: """
documentation: "Atoms are constants whose values are their own name.", Atoms are constants whose values are their own name.
(module)\
""",
insert_text: "Atom" insert_text: "Atom"
} in Intellisense.get_completion_items("alias ", context, node()) } in Intellisense.get_completion_items("alias ", context, node())

9
test/livebook/remote_intellisense_test.exs
View file

@ -73,8 +73,11 @@ defmodule Livebook.RemoteIntellisenseTest do
assert %{ assert %{
label: "RemoteModule", label: "RemoteModule",
kind: :module, kind: :module,
detail: "module", documentation: """
documentation: "No documentation available", No documentation available
(module)\
""",
insert_text: "RemoteModule" insert_text: "RemoteModule"
} in Intellisense.get_completion_items("RemoteModule", context, node) } in Intellisense.get_completion_items("RemoteModule", context, node)
end end
@ -85,7 +88,6 @@ defmodule Livebook.RemoteIntellisenseTest do
assert %{ assert %{
label: "hello/1", label: "hello/1",
kind: :function, kind: :function,
detail: nil,
documentation: "No documentation available", documentation: "No documentation available",
insert_text: "hello(${})" insert_text: "hello(${})"
} in Intellisense.get_completion_items("RemoteModule.hel", context, node) } in Intellisense.get_completion_items("RemoteModule.hel", context, node)
@ -99,7 +101,6 @@ defmodule Livebook.RemoteIntellisenseTest do
%{ %{
label: "unsubscribe/1", label: "unsubscribe/1",
kind: :function, kind: :function,
detail: nil,
documentation: "No documentation available", documentation: "No documentation available",
insert_text: "unsubscribe(${})" insert_text: "unsubscribe(${})"
} }