Show record field documentation on hover

Author: GearsDatapacks

compiler-core/src/ast/typed.rs

@@ -786,6 +786,7 @@ impl TypedExpr {
         match self {
             TypedExpr::Var { constructor, .. } => constructor.get_documentation(),
             TypedExpr::ModuleSelect { constructor, .. } => constructor.get_documentation(),
+            TypedExpr::RecordAccess { documentation, .. } => documentation.as_deref(),
 
             TypedExpr::Int { .. }
             | TypedExpr::Float { .. }
@@ -804,7 +805,6 @@ impl TypedExpr {
             | TypedExpr::Panic { .. }
             | TypedExpr::BitArray { .. }
             | TypedExpr::RecordUpdate { .. }
-            | TypedExpr::RecordAccess { .. }
             | TypedExpr::NegateBool { .. }
             | TypedExpr::NegateInt { .. }
             | TypedExpr::Invalid { .. } => None,

compiler-core/src/language_server/tests/hover.rs

@@ -1750,3 +1750,69 @@ const value = #(1, 2, [Wibble, Wobble(<<1, 2, 3>>), Wibble])
         find_position_of("3")
     );
 }
+
+#[test]
+fn record_field_documentation() {
+    assert_hover!(
+        "
+pub type Wibble {
+  Wibble(
+    /// This is some documentation about the wibble field.
+    wibble: Int
+  )
+}
+
+pub fn wibble(w: Wibble) {
+  w.wibble
+}
+",
+        find_position_of("w.wibble").under_char('l')
+    );
+}
+
+#[test]
+fn no_documentation_for_shared_record_field() {
+    assert_hover!(
+        "
+pub type Wibble {
+  Wibble(
+    /// This is some documentation about the wibble field.
+    wibble: Int
+  )
+  Wobble(
+    /// This won't show up because we don't know which wibble field it is
+    wibble: Int
+  )
+}
+
+pub fn wibble(w: Wibble) {
+  w.wibble
+}
+",
+        find_position_of("w.wibble").under_char('l')
+    );
+}
+
+#[test]
+fn documentation_for_shared_record_field_when_variant_is_known() {
+    assert_hover!(
+        "
+pub type Wibble {
+  Wibble(
+    /// This is some documentation about the wibble field.
+    wibble: Int
+  )
+  Wobble(
+    /// This won't show up because it's a Wibble variant
+    wibble: Int
+  )
+}
+
+pub fn wibble(w: Wibble) {
+  let assert Wibble(..) = w
+  w.wibble
+}
+",
+        find_position_of("w.wibble").under_char('l')
+    );
+}

compiler-core/src/language_server/tests/snapshots/gleam_core__language_server__tests__hover__documentation_for_shared_record_field_when_variant_is_known.snap

@@ -0,0 +1,28 @@
+---
+source: compiler-core/src/language_server/tests/hover.rs
+expression: "\npub type Wibble {\n  Wibble(\n    /// This is some documentation about the wibble field.\n    wibble: Int\n  )\n  Wobble(\n    /// This won't show up because it's a Wibble variant\n    wibble: Int\n  )\n}\n\npub fn wibble(w: Wibble) {\n  let assert Wibble(..) = w\n  w.wibble\n}\n"
+---
+pub type Wibble {
+  Wibble(
+    /// This is some documentation about the wibble field.
+    wibble: Int
+  )
+  Wobble(
+    /// This won't show up because it's a Wibble variant
+    wibble: Int
+  )
+}
+
+pub fn wibble(w: Wibble) {
+  let assert Wibble(..) = w
+  w.wibble
+  ▔▔▔▔▔▔↑▔
+}
+
+
+----- Hover content -----
+Scalar(
+    String(
+        "```gleam\nInt\n```\n This is some documentation about the wibble field.\n",
+    ),
+)

compiler-core/src/language_server/tests/snapshots/gleam_core__language_server__tests__hover__no_documentation_for_shared_record_field.snap

@@ -0,0 +1,27 @@
+---
+source: compiler-core/src/language_server/tests/hover.rs
+expression: "\npub type Wibble {\n  Wibble(\n    /// This is some documentation about the wibble field.\n    wibble: Int\n  )\n  Wobble(\n    /// This won't show up because we don't know which wibble field it is\n    wibble: Int\n  )\n}\n\npub fn wibble(w: Wibble) {\n  w.wibble\n}\n"
+---
+pub type Wibble {
+  Wibble(
+    /// This is some documentation about the wibble field.
+    wibble: Int
+  )
+  Wobble(
+    /// This won't show up because we don't know which wibble field it is
+    wibble: Int
+  )
+}
+
+pub fn wibble(w: Wibble) {
+  w.wibble
+  ▔▔▔▔▔▔↑▔
+}
+
+
+----- Hover content -----
+Scalar(
+    String(
+        "```gleam\nInt\n```\n",
+    ),
+)

compiler-core/src/language_server/tests/snapshots/gleam_core__language_server__tests__hover__record_field_documentation.snap

@@ -0,0 +1,23 @@
+---
+source: compiler-core/src/language_server/tests/hover.rs
+expression: "\npub type Wibble {\n  Wibble(\n    /// This is some documentation about the wibble field.\n    wibble: Int\n  )\n}\n\npub fn wibble(w: Wibble) {\n  w.wibble\n}\n"
+---
+pub type Wibble {
+  Wibble(
+    /// This is some documentation about the wibble field.
+    wibble: Int
+  )
+}
+
+pub fn wibble(w: Wibble) {
+  w.wibble
+  ▔▔▔▔▔▔↑▔
+}
+
+
+----- Hover content -----
+Scalar(
+    String(
+        "```gleam\nInt\n```\n This is some documentation about the wibble field.\n",
+    ),
+)