Add completions for prelude values

gleam-lang · Sep 10, 2024 · 44691b3 · 44691b3
1 parent a40f501
commit 44691b3
Show file tree

Hide file tree

Showing 38 changed files with 768 additions and 36 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -363,6 +363,9 @@
   unused.
   ([Giacomo Cavalieri](https://github.com/giacomocavalieri))
 
+- The Language Server now correctly shows completions for values in the Gleam prelude.
+  ([Surya Rose](https://github.com/GearsDatapacks))
+
 ## v1.4.1 - 2024-08-04
 
 ### Bug Fixes

diff --git a/compiler-core/src/language_server/completer.rs b/compiler-core/src/language_server/completer.rs
@@ -16,7 +16,7 @@ use crate::{
     line_numbers::LineNumbers,
     type_::{
         collapse_links, pretty::Printer, AccessorsMap, FieldMap, ModuleInterface, PreludeType,
-        Type, TypeConstructor, ValueConstructorVariant,
+        Type, TypeConstructor, ValueConstructorVariant, PRELUDE_MODULE_NAME,
     },
     Result,
 };
@@ -42,7 +42,7 @@ enum CompletionKind {
     LocallyDefined,
     // Values or types defined in an already imported module
     ImportedModule,
-    // Types defined in the prelude
+    // Types or values defined in the prelude
     Prelude,
     // Types defined in a module that has not been imported
     ImportableModule,
@@ -531,6 +531,41 @@ where
 
         let (insert_range, module_select) = surrounding_completion;
 
+        let mut push_prelude_completion = |label: &str, kind| {
+            let label = label.to_string();
+            let sort_text = Some(sort_text(CompletionKind::Prelude, &label));
+            completions.push(CompletionItem {
+                label,
+                detail: Some(PRELUDE_MODULE_NAME.into()),
+                kind: Some(kind),
+                sort_text,
+                ..Default::default()
+            });
+        };
+
+        // Prelude values
+        for type_ in PreludeType::iter() {
+            match type_ {
+                PreludeType::Bool => {
+                    push_prelude_completion("True", CompletionItemKind::ENUM_MEMBER);
+                    push_prelude_completion("False", CompletionItemKind::ENUM_MEMBER);
+                }
+                PreludeType::Nil => {
+                    push_prelude_completion("Nil", CompletionItemKind::ENUM_MEMBER);
+                }
+                PreludeType::Result => {
+                    push_prelude_completion("Ok", CompletionItemKind::CONSTRUCTOR);
+                    push_prelude_completion("Error", CompletionItemKind::CONSTRUCTOR);
+                }
+                PreludeType::BitArray
+                | PreludeType::Float
+                | PreludeType::Int
+                | PreludeType::List
+                | PreludeType::String
+                | PreludeType::UtfCodepoint => {}
+            }
+        }
+
         // Module values
         // Do not complete direct module values if the user has already started typing a module select.
         // e.x. when the user has typed mymodule.| we know local module values are no longer relevant

diff --git a/compiler-core/src/language_server/tests/completion.rs b/compiler-core/src/language_server/tests/completion.rs
@@ -1479,3 +1479,14 @@ fn fun() {
     );
     assert_eq!(completions, vec![],);
 }
+
+#[test]
+fn completions_for_prelude_values() {
+    let code = "
+pub fn main() {
+  let my_bool = T
+}
+";
+
+    assert_completion!(TestProject::for_source(code), Position::new(2, 17));
+}
diff --git a/...hots/gleam_core__language_server__tests__completion__completions_for_function_labels.snap b/...hots/gleam_core__language_server__tests__completion__completions_for_function_labels.snap
@@ -1,6 +1,5 @@
 ---
 source: compiler-core/src/language_server/tests/completion.rs
-assertion_line: 1439
 expression: "\nfn wibble(wibble arg1: String, wobble arg2: String) {\n  arg1 <> arg2\n}\n\nfn fun() { // completion inside parens below includes labels\n  let wibble = wibble()\n}\n"
 ---
 fn wibble(wibble arg1: String, wobble arg2: String) {
@@ -13,6 +12,26 @@ fn fun() { // completion inside parens below includes labels
 
 
 ----- Completion content -----
+Error
+  kind:   Constructor
+  detail: gleam
+  sort:   4_Error
+False
+  kind:   EnumMember
+  detail: gleam
+  sort:   4_False
+Nil
+  kind:   EnumMember
+  detail: gleam
+  sort:   4_Nil
+Ok
+  kind:   Constructor
+  detail: gleam
+  sort:   4_Ok
+True
+  kind:   EnumMember
+  detail: gleam
+  sort:   4_True
 fun
   kind:   Function
   detail: fn() -> String

diff --git a/...m_core__language_server__tests__completion__completions_for_imported_function_labels.snap b/...m_core__language_server__tests__completion__completions_for_imported_function_labels.snap
@@ -1,6 +1,5 @@
 ---
 source: compiler-core/src/language_server/tests/completion.rs
-assertion_line: 1457
 expression: "\nimport dep\n\nfn fun() { // completion inside parens below includes labels\n  let wibble = dep.wibble()\n}\n"
 ---
 import dep
@@ -11,6 +10,26 @@ fn fun() { // completion inside parens below includes labels
 
 
 ----- Completion content -----
+Error
+  kind:   Constructor
+  detail: gleam
+  sort:   4_Error
+False
+  kind:   EnumMember
+  detail: gleam
+  sort:   4_False
+Nil
+  kind:   EnumMember
+  detail: gleam
+  sort:   4_Nil
+Ok
+  kind:   Constructor
+  detail: gleam
+  sort:   4_Ok
+True
+  kind:   EnumMember
+  detail: gleam
+  sort:   4_True
 dep.wibble
   kind:   Function
   detail: fn(String, String) -> String

diff --git a/...eam_core__language_server__tests__completion__completions_for_imported_record_labels.snap b/...eam_core__language_server__tests__completion__completions_for_imported_record_labels.snap
@@ -1,6 +1,5 @@
 ---
 source: compiler-core/src/language_server/tests/completion.rs
-assertion_line: 1421
 expression: "\nimport dep\n\nfn fun() { // completion inside parens below includes labels\n  let wibble = dep.Wibble()\n}\n"
 ---
 import dep
@@ -11,6 +10,26 @@ fn fun() { // completion inside parens below includes labels
 
 
 ----- Completion content -----
+Error
+  kind:   Constructor
+  detail: gleam
+  sort:   4_Error
+False
+  kind:   EnumMember
+  detail: gleam
+  sort:   4_False
+Nil
+  kind:   EnumMember
+  detail: gleam
+  sort:   4_Nil
+Ok
+  kind:   Constructor
+  detail: gleam
+  sort:   4_Ok
+True
+  kind:   EnumMember
+  detail: gleam
+  sort:   4_True
 dep.Wibble
   kind:   Constructor
   detail: fn(String, Int) -> Wibble

diff --git a/...shots/gleam_core__language_server__tests__completion__completions_for_prelude_values.snap b/...shots/gleam_core__language_server__tests__completion__completions_for_prelude_values.snap
@@ -0,0 +1,37 @@
+---
+source: compiler-core/src/language_server/tests/completion.rs
+expression: "\npub fn main() {\n  let my_bool = T\n}\n"
+---
+pub fn main() {
+  let my_bool = T|
+}
+
+
+----- Completion content -----
+Error
+  kind:   Constructor
+  detail: gleam
+  sort:   4_Error
+False
+  kind:   EnumMember
+  detail: gleam
+  sort:   4_False
+Nil
+  kind:   EnumMember
+  detail: gleam
+  sort:   4_Nil
+Ok
+  kind:   Constructor
+  detail: gleam
+  sort:   4_Ok
+True
+  kind:   EnumMember
+  detail: gleam
+  sort:   4_True
+main
+  kind:   Function
+  detail: fn() -> a
+  sort:   2_main
+  desc:   app
+  edits:
+    [2:16-2:16]: "main"
diff --git a/...leam_core__language_server__tests__completion__completions_for_private_record_access.snap b/...leam_core__language_server__tests__completion__completions_for_private_record_access.snap
@@ -1,6 +1,5 @@
 ---
 source: compiler-core/src/language_server/tests/completion.rs
-assertion_line: 1362
 expression: "\ntype Wibble {\n  Wibble(wibble: Int, wobble: Int)\n  Wobble(wabble: Int, wobble: Int)\n}\n\nfn fun() {\n  let wibble = Wibble(1, 2)\n  wibble.wobble\n}\n"
 ---
 type Wibble {
@@ -15,6 +14,26 @@ fn fun() {
 
 
 ----- Completion content -----
+Error
+  kind:   Constructor
+  detail: gleam
+  sort:   4_Error
+False
+  kind:   EnumMember
+  detail: gleam
+  sort:   4_False
+Nil
+  kind:   EnumMember
+  detail: gleam
+  sort:   4_Nil
+Ok
+  kind:   Constructor
+  detail: gleam
+  sort:   4_Ok
+True
+  kind:   EnumMember
+  detail: gleam
+  sort:   4_True
 wobble
   kind:   Field
   detail: Int

diff --git a/...pshots/gleam_core__language_server__tests__completion__completions_for_record_access.snap b/...pshots/gleam_core__language_server__tests__completion__completions_for_record_access.snap
@@ -1,6 +1,5 @@
 ---
 source: compiler-core/src/language_server/tests/completion.rs
-assertion_line: 1345
 expression: "\npub type Wibble {\n  Wibble(wibble: Int, wobble: Int)\n  Wobble(wabble: Int, wobble: Int)\n}\n\nfn fun() {\n  let wibble = Wibble(1, 2)\n  wibble.wobble\n}\n"
 ---
 pub type Wibble {
@@ -15,6 +14,26 @@ fn fun() {
 
 
 ----- Completion content -----
+Error
+  kind:   Constructor
+  detail: gleam
+  sort:   4_Error
+False
+  kind:   EnumMember
+  detail: gleam
+  sort:   4_False
+Nil
+  kind:   EnumMember
+  detail: gleam
+  sort:   4_Nil
+Ok
+  kind:   Constructor
+  detail: gleam
+  sort:   4_Ok
+True
+  kind:   EnumMember
+  detail: gleam
+  sort:   4_True
 wobble
   kind:   Field
   detail: Int

diff --git a/...pshots/gleam_core__language_server__tests__completion__completions_for_record_labels.snap b/...pshots/gleam_core__language_server__tests__completion__completions_for_record_labels.snap
@@ -1,6 +1,5 @@
 ---
 source: compiler-core/src/language_server/tests/completion.rs
-assertion_line: 1403
 expression: "\npub type Wibble {\n  Wibble(wibble: String, wobble: Int)\n}\n\nfn fun() { // completion inside parens below includes labels\n  let wibble = Wibble()\n}\n"
 ---
 pub type Wibble {
@@ -13,6 +12,26 @@ fn fun() { // completion inside parens below includes labels
 
 
 ----- Completion content -----
+Error
+  kind:   Constructor
+  detail: gleam
+  sort:   4_Error
+False
+  kind:   EnumMember
+  detail: gleam
+  sort:   4_False
+Nil
+  kind:   EnumMember
+  detail: gleam
+  sort:   4_Nil
+Ok
+  kind:   Constructor
+  detail: gleam
+  sort:   4_Ok
+True
+  kind:   EnumMember
+  detail: gleam
+  sort:   4_True
 Wibble
   kind:   Constructor
   detail: fn(String, Int) -> Wibble

diff --git a/..._completion__importable_adds_extra_new_line_if_import_exists_below_other_definitions.snap b/..._completion__importable_adds_extra_new_line_if_import_exists_below_other_definitions.snap
@@ -1,13 +1,32 @@
 ---
 source: compiler-core/src/language_server/tests/completion.rs
-assertion_line: 339
 expression: "\nimport dep2\n"
 ---
 |
 import dep2
 
 
 ----- Completion content -----
+Error
+  kind:   Constructor
+  detail: gleam
+  sort:   4_Error
+False
+  kind:   EnumMember
+  detail: gleam
+  sort:   4_False
+Nil
+  kind:   EnumMember
+  detail: gleam
+  sort:   4_Nil
+Ok
+  kind:   Constructor
+  detail: gleam
+  sort:   4_Ok
+True
+  kind:   EnumMember
+  detail: gleam
+  sort:   4_True
 dep.wobble
   kind:   Function
   detail: fn() -> Nil

diff --git a/...re__language_server__tests__completion__importable_adds_extra_new_line_if_no_imports.snap b/...re__language_server__tests__completion__importable_adds_extra_new_line_if_no_imports.snap
@@ -1,9 +1,28 @@
 ---
 source: compiler-core/src/language_server/tests/completion.rs
-assertion_line: 331
 expression: ""
 ---
 ----- Completion content -----
+Error
+  kind:   Constructor
+  detail: gleam
+  sort:   4_Error
+False
+  kind:   EnumMember
+  detail: gleam
+  sort:   4_False
+Nil
+  kind:   EnumMember
+  detail: gleam
+  sort:   4_Nil
+Ok
+  kind:   Constructor
+  detail: gleam
+  sort:   4_Ok
+True
+  kind:   EnumMember
+  detail: gleam
+  sort:   4_True
 dep.wobble
   kind:   Function
   detail: fn() -> Nil