make hovers a bit nicer

Author: zth

analysis/src/Hover.ml

@@ -101,26 +101,48 @@ let findRelevantTypesFromType ~file ~package typ =
   constructors |> List.filter_map (fromConstructorPath ~env:envToSearch)
 
 let expandTypes ~file ~package ~supportsMarkdownLinks typ =
-  findRelevantTypesFromType typ ~file ~package
-  |> List.map (fun {decl; env; loc; path} ->
-         let linkToTypeDefinitionStr =
-           if supportsMarkdownLinks then
-             Markdown.goToDefinitionText ~env ~pos:loc.Warnings.loc_start
-           else ""
-         in
-         Markdown.divider
-         ^ (if supportsMarkdownLinks then Markdown.spacing else "")
-         ^ Markdown.codeBlock
-             (decl
-             |> Shared.declToString ~printNameAsIs:true
-                  (SharedTypes.pathIdentToString path))
-         ^ linkToTypeDefinitionStr ^ "\n")
+  match findRelevantTypesFromType typ ~file ~package with
+  | {decl; path} :: _
+    when Res_parsetree_viewer.has_inline_record_definition_attribute
+           decl.type_attributes ->
+    ( [
+        Markdown.codeBlock
+          (decl
+          |> Shared.declToString ~printNameAsIs:true
+               (SharedTypes.pathIdentToString path));
+      ],
+      `InlineType )
+  | all ->
+    ( all
+      |> List.map (fun {decl; env; loc; path} ->
+             let linkToTypeDefinitionStr =
+               if
+                 supportsMarkdownLinks
+                 && not
+                      (Res_parsetree_viewer
+                       .has_inline_record_definition_attribute
+                         decl.type_attributes)
+               then Markdown.goToDefinitionText ~env ~pos:loc.Warnings.loc_start
+               else ""
+             in
+             Markdown.divider
+             ^ (if supportsMarkdownLinks then Markdown.spacing else "")
+             ^ Markdown.codeBlock
+                 (decl
+                 |> Shared.declToString ~printNameAsIs:true
+                      (SharedTypes.pathIdentToString path))
+             ^ linkToTypeDefinitionStr ^ "\n"),
+      `Default )
 
 (* Produces a hover with relevant types expanded in the main type being hovered. *)
 let hoverWithExpandedTypes ~file ~package ~supportsMarkdownLinks typ =
   let typeString = Markdown.codeBlock (typ |> Shared.typeToString) in
-  typeString :: expandTypes ~file ~package ~supportsMarkdownLinks typ
-  |> String.concat "\n"
+  let expandedTypes, expansionType =
+    expandTypes ~file ~package ~supportsMarkdownLinks typ
+  in
+  match expansionType with
+  | `Default -> typeString :: expandedTypes |> String.concat "\n"
+  | `InlineType -> expandedTypes |> String.concat "\n"
 
 (* Leverages autocomplete functionality to produce a hover for a position. This
    makes it (most often) work with unsaved content. *)
@@ -171,10 +193,13 @@ let newHover ~full:{file; package} ~supportsMarkdownLinks locItem =
     let typeDef = Markdown.codeBlock (Shared.declToString name decl) in
     match decl.type_manifest with
     | None -> Some typeDef
-    | Some typ ->
-      Some
-        (typeDef :: expandTypes ~file ~package ~supportsMarkdownLinks typ
-        |> String.concat "\n"))
+    | Some typ -> (
+      let expandedTypes, expansionType =
+        expandTypes ~file ~package ~supportsMarkdownLinks typ
+      in
+      match expansionType with
+      | `Default -> Some (typeDef :: expandedTypes |> String.concat "\n")
+      | `InlineType -> Some (expandedTypes |> String.concat "\n")))
   | LModule (Definition (stamp, _tip)) | LModule (LocalReference (stamp, _tip))
     -> (
     match Stamps.findModule file.stamps stamp with

compiler/syntax/src/res_parsetree_viewer.ml

@@ -72,6 +72,20 @@ let has_await_attribute attrs =
       | _ -> false)
     attrs
 
+let has_inline_record_definition_attribute attrs =
+  List.exists
+    (function
+      | {Location.txt = "res.inlineRecordDefinition"}, _ -> true
+      | _ -> false)
+    attrs
+
+let has_inline_record_reference_attribute attrs =
+  List.exists
+    (function
+      | {Location.txt = "res.inlineRecordReference"}, _ -> true
+      | _ -> false)
+    attrs
+
 let has_res_pat_variant_spread_attribute attrs =
   List.exists
     (function

compiler/syntax/src/res_parsetree_viewer.mli

@@ -15,6 +15,8 @@ val functor_type :
   * Parsetree.module_type
 
 val has_await_attribute : Parsetree.attributes -> bool
+val has_inline_record_definition_attribute : Parsetree.attributes -> bool
+val has_inline_record_reference_attribute : Parsetree.attributes -> bool
 val has_res_pat_variant_spread_attribute : Parsetree.attributes -> bool
 val has_dict_pattern_attribute : Parsetree.attributes -> bool
 

tests/analysis_tests/tests-reanalyze/termination/package-lock.json

@@ -10,9 +10,18 @@ let options = {
   //   ^hov
   extra: {
     name: "test",
+    //^hov
     superExtra: {
       age: 2222,
+      //^hov
     },
-    otherExtra: Some({test: true, anotherInlined: {record: true}}),
+    otherExtra: Some({
+      test: true,
+      // ^hov
+      anotherInlined: {
+        record: true,
+        // ^hov
+      },
+    }),
   },
 }

tests/analysis_tests/tests/src/NestedRecordsHover.res

@@ -9,7 +9,7 @@ ContextPath Value[options]
 Path options
 Package opens Stdlib.place holder Pervasives.JsxModules.place holder
 Resolved opens 1 Stdlib
-{"contents": {"kind": "markdown", "value": "```rescript\noptions\n```\n\n---\n\n```\n \n```\n```rescript\ntype options = {\n  extra: {name: string, superExtra: {age: int}},\n}\n```\nGo to: [Type definition](command:rescript-vscode.go_to_location?%5B%22NestedRecords.res%22%2C1%2C0%5D)\n\n\n---\n\n```\n \n```\n```rescript\ntype options.extra = {name: string, superExtra: {age: int}}\n```\nGo to: [Type definition](command:rescript-vscode.go_to_location?%5B%22NestedRecords.res%22%2C2%2C9%5D)\n"}}
+{"contents": {"kind": "markdown", "value": "```rescript\noptions\n```\n\n---\n\n```\n \n```\n```rescript\ntype options = {\n  extra: {name: string, superExtra: {age: int}},\n}\n```\nGo to: [Type definition](command:rescript-vscode.go_to_location?%5B%22NestedRecords.res%22%2C1%2C0%5D)\n\n\n---\n\n```\n \n```\n```rescript\ntype options.extra = {name: string, superExtra: {age: int}}\n```\n"}}
 
 Hover src/NestedRecords.res 20:13
 Nothing at that position. Now trying to use completion.
@@ -28,7 +28,7 @@ CPPipe pathFromEnv: found:true
 Path NestedRecords.extra
 Package opens Stdlib.place holder Pervasives.JsxModules.place holder
 Resolved opens 1 Stdlib
-{"contents": {"kind": "markdown", "value": "```rescript\n\\\"options.extra\"\n```\n\n---\n\n```\n \n```\n```rescript\ntype options.extra = {name: string, superExtra: {age: int}}\n```\nGo to: [Type definition](command:rescript-vscode.go_to_location?%5B%22NestedRecords.res%22%2C2%2C9%5D)\n\n\n---\n\n```\n \n```\n```rescript\ntype options.extra.superExtra = {age: int}\n```\nGo to: [Type definition](command:rescript-vscode.go_to_location?%5B%22NestedRecords.res%22%2C4%2C16%5D)\n"}}
+{"contents": {"kind": "markdown", "value": "```rescript\ntype options.extra = {name: string, superExtra: {age: int}}\n```"}}
 
 Hover src/NestedRecords.res 23:26
 Nothing at that position. Now trying to use completion.
@@ -59,7 +59,7 @@ CPPipe pathFromEnv: found:true
 Path NestedRecords.superExtra
 Package opens Stdlib.place holder Pervasives.JsxModules.place holder
 Resolved opens 1 Stdlib
-{"contents": {"kind": "markdown", "value": "```rescript\n\\\"options.extra.superExtra\"\n```\n\n---\n\n```\n \n```\n```rescript\ntype options.extra.superExtra = {age: int}\n```\nGo to: [Type definition](command:rescript-vscode.go_to_location?%5B%22NestedRecords.res%22%2C4%2C16%5D)\n"}}
+{"contents": {"kind": "markdown", "value": "```rescript\ntype options.extra.superExtra = {age: int}\n```"}}
 
 Hover src/NestedRecords.res 26:29
 Nothing at that position. Now trying to use completion.

tests/analysis_tests/tests/src/expected/NestedRecords.res.txt

@@ -1,3 +1,15 @@
 Hover src/NestedRecordsHover.res 8:7
-{"contents": {"kind": "markdown", "value": "```rescript\noptions\n```\n\n---\n\n```\n \n```\n```rescript\ntype options = {\n  extra?: {\n    name: string,\n    superExtra?: {age: int},\n    otherExtra: option<\n      {\n        test: bool,\n        anotherInlined: {record: bool},\n      },\n    >,\n  },\n}\n```\nGo to: [Type definition](command:rescript-vscode.go_to_location?%5B%22NestedRecordsHover.res%22%2C0%2C0%5D)\n\n\n---\n\n```\n \n```\n```rescript\ntype options.extra = {\n  name: string,\n  superExtra?: {age: int},\n  otherExtra: option<\n    {\n      test: bool,\n      anotherInlined: {record: bool},\n    },\n  >,\n}\n```\nGo to: [Type definition](command:rescript-vscode.go_to_location?%5B%22NestedRecordsHover.res%22%2C1%2C10%5D)\n"}}
+{"contents": {"kind": "markdown", "value": "```rescript\noptions\n```\n\n---\n\n```\n \n```\n```rescript\ntype options = {\n  extra?: {\n    name: string,\n    superExtra?: {age: int},\n    otherExtra: option<\n      {\n        test: bool,\n        anotherInlined: {record: bool},\n      },\n    >,\n  },\n}\n```\nGo to: [Type definition](command:rescript-vscode.go_to_location?%5B%22NestedRecordsHover.res%22%2C0%2C0%5D)\n\n\n---\n\n```\n \n```\n```rescript\ntype options.extra = {\n  name: string,\n  superExtra?: {age: int},\n  otherExtra: option<\n    {\n      test: bool,\n      anotherInlined: {record: bool},\n    },\n  >,\n}\n```\n"}}
+
+Hover src/NestedRecordsHover.res 11:6
+{"contents": {"kind": "markdown", "value": "```rescript\ntype options.extra = {\n  name: string,\n  superExtra?: {age: int},\n  otherExtra: option<\n    {\n      test: bool,\n      anotherInlined: {record: bool},\n    },\n  >,\n}\n```"}}
+
+Hover src/NestedRecordsHover.res 14:8
+{"contents": {"kind": "markdown", "value": "```rescript\ntype options.extra.superExtra = {age: int}\n```"}}
+
+Hover src/NestedRecordsHover.res 18:9
+{"contents": {"kind": "markdown", "value": "```rescript\ntype options.extra.otherExtra = {\n  test: bool,\n  anotherInlined: {record: bool},\n}\n```"}}
+
+Hover src/NestedRecordsHover.res 21:11
+{"contents": {"kind": "markdown", "value": "```rescript\ntype options.extra.otherExtra.anotherInlined = {\n  record: bool,\n}\n```"}}