[#2094] Add documentation to LSP hovers

Motivation and Context

We want to save comments in AST to show documentation on hover.

Related issues

Resolves none .

Part of #2094

Checklist for the LIGO Language Server

• I checked whether I need to update the README.md file for the plugin and did so if necessary:
  • If I implemented a new LSP request, I added it to the list of supported features that may be disabled
  • If I implemented a new LSP method, I added it to the list of supported functionality
• I checked that my changes work in Emacs, Vim, and Visual Studio Code
• (Before merging) The commit history is squashed and prettified, and follows the Serokell commit policy, or the MR is set to squash the commits

Description

To do this we're inserting [@comment "..."] attributes during a lexer self-pass.

Adopt Nanopasses.Trivial.To_core. so it allows such attributes everywhere and saves them to Ast where needed.

Adopt scopes definition pass so it remembers attributes.

Obtain attributes of a hovered object, if needed add a markdown for this comment to the returned list of hovers.

Component

• compiler
• website
• webide
• vscode-plugin
• debugger

Types of changes

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to not work as expected)
• Performance improvement (non-breaking change that improves performance)
• None (change with no changelog)

Changelog

Now we show documentation comments (like (** *) in CameLIGO and /** */ in JsLIGO) in LSP hovers

Checklist:

• Changes follow the existing coding style (use dune @fmt to check).
• Tests for the changes have been added (for bug fixes / feature).
• Documentation has been updated.
• Changelog description has been added (if appropriate).
• Start titles under ## Changelog section with #### (if appropriate).
• There is no image or uploaded file in changelog
• Examples in changed behaviour have been added to the changelog (for breaking change / feature).

src/passes/02-parsing/cameligo/Parser.mly

@@ -52,7 +52,7 @@ let rec hook mk_attr attrs node =
 let hook_E_Attr = hook @@ fun a e -> E_Attr (a,e)
 let hook_T_Attr = hook @@ fun a t -> T_Attr (a,t)
 
-(* Transforming comments related to declarations to  attributes *)
+(* Transforming comments related to declarations to attributes *)
 let add_comments_as_attributes decl comments =
   let add_one_comment decl comment =
     match comment with
@@ -71,6 +71,7 @@ let add_comments_as_sig_attributes sig_item comments =
     | Line _ -> sig_item
   in Core.List.fold ~init:sig_item ~f:add_one_comment comments
 
+
 (* END HEADER *)
 %}
 
@@ -292,11 +293,11 @@ type_decl:
   "type" ioption(type_vars) type_name "=" type_expr {
     let region = cover $1#region (type_expr_to_region $5)
     and value  = {kwd_type=$1; params=$2; name=$3; eq=$4; type_expr=$5}
-    in {region; value}, $1#comments }
+    in {body = {region; value}; comments = $1#comments} }
 
 global_type_decl:
   type_decl {
-    let decl, comments = $1 in
+    let {body = decl; comments} = $1 in
     let decl = D_Type decl in
     add_comments_as_attributes decl comments }
 
@@ -565,11 +566,11 @@ module_decl:
   "module" module_name ioption(module_constraint) "=" module_expr {
     let region = cover $1#region (module_expr_to_region $5)
     and value  = {kwd_module=$1; name=$2; eq=$4; module_expr=$5; annotation=$3}
-    in {region; value}, $1#comments }
+    in {body = {region; value}; comments = $1#comments} }
 
 global_module_decl:
   module_decl {
-    let decl, comments = $1 in
+    let {body = decl; comments} = $1 in
     let decl = D_Module decl in
     add_comments_as_attributes decl comments }
 
@@ -936,7 +937,7 @@ let_mut_in_expr(right_expr):
 
 local_type_decl(right_expr):
   type_decl "in" right_expr {
-    let decl, _comments = $1 in
+    let {body = decl; comments = _} = $1 in
     let region = cover decl.region (expr_to_region $3)
     and value  = {type_decl=decl; kwd_in=$2; body=$3}
     in E_TypeIn {region; value} }
@@ -945,7 +946,7 @@ local_type_decl(right_expr):
 
 local_module_decl(right_expr):
   module_decl "in" right_expr {
-    let decl, _comments = $1 in
+    let {body = decl; comments = _} = $1 in
     let region = cover decl.region (expr_to_region $3)
     and value  = {mod_decl=decl; kwd_in=$2; body=$3}
     in E_ModIn {region; value} }