feat(lsp): Better place comments and support modules

Author: spotandjake

compiler/src/language_server/code_action.re

@@ -84,36 +84,7 @@ let named_arg_label = (range, uri, arg_label) => {
   };
 };
 
-let add_graindoc = (range, uri, expr_type: Types.type_expr) => {
-  let output = Buffer.create(128);
-  Buffer.add_string(output, "/**\n");
-  Buffer.add_string(output, " *\n"); // Blank spot for description entry
-  switch (expr_type.desc) {
-  | TTyArrow(args, ret_typ, _) =>
-    Buffer.add_string(output, " *\n"); // Spacing
-    List.iteri(
-      (index, (label, _)) => {
-        let param_name =
-          switch (label) {
-          | Types.Labeled({txt})
-          | Default({txt}) => txt
-          | Unlabeled => string_of_int(index)
-          };
-        Buffer.add_string(
-          output,
-          Printf.sprintf(" * @param %s:\n", param_name),
-        );
-      },
-      args,
-    );
-    Buffer.add_string(output, " * @returns \n");
-  | _ => ()
-  };
-  Buffer.add_string(output, " *\n"); // Spacing
-  Buffer.add_string(output, " * @example\n");
-  Buffer.add_string(output, " *\n"); // Spacing
-  Buffer.add_string(output, " * @since\n");
-  Buffer.add_string(output, " */\n");
+let add_graindoc = (range, uri, message) => {
   ResponseResult.{
     title: "Add Graindoc",
     kind: "add-graindoc",
@@ -127,7 +98,7 @@ let add_graindoc = (range, uri, expr_type: Types.type_expr) => {
           edits: [
             {
               range,
-              new_text: Buffer.contents(output),
+              new_text: message,
             },
           ],
         },
@@ -265,6 +236,34 @@ let rec process_add_or_remove_braces = (uri, results: list(Sourcetree.node)) =>
     }
   );
 };
+
+let get_end_of_last_line = (loc: Location.t) => {
+  {
+    ...loc,
+    loc_start: {
+      ...loc.loc_start,
+      pos_cnum: Int.max_int,
+      pos_lnum: loc.loc_start.pos_lnum - 1,
+    },
+    loc_end: {
+      ...loc.loc_start,
+      pos_cnum: Int.max_int,
+      pos_lnum: loc.loc_start.pos_lnum - 1,
+    },
+  };
+};
+let template_graindoc = fn => {
+  let output = Buffer.create(128);
+  Buffer.add_string(output, "\n/**\n");
+  Buffer.add_string(output, " *\n"); // Blank spot for description entry
+  Buffer.add_string(output, " *\n"); // Spacing
+  fn(output);
+  Buffer.add_string(output, " * @example\n");
+  Buffer.add_string(output, " *\n"); // Spacing
+  Buffer.add_string(output, " * @since\n");
+  Buffer.add_string(output, " */");
+  Buffer.contents(output);
+};
 let rec process_graindoc =
         (
           uri,
@@ -273,17 +272,49 @@ let rec process_graindoc =
         ) => {
   switch (results) {
   | [LetBind({pat, expr, loc}), ..._] =>
-    let loc = {
-      ...loc,
-      loc_end: loc.loc_start,
+    let ordered = Comments.to_ordered(~extract_attributes=false, comments);
+    let comment =
+      Comments.Doc.ending_on(~lnum=loc.loc_start.pos_lnum - 1, ordered);
+    switch (comment) {
+    | Some((Doc(_), _, _)) => None
+    | _ =>
+      let loc = get_end_of_last_line(loc);
+      let message =
+        template_graindoc(output => {
+          switch (expr.exp_type.desc) {
+          | TTyArrow(args, ret_typ, _) =>
+            Buffer.add_string(output, " *\n"); // Spacing
+            List.iteri(
+              (index, (label, _)) => {
+                let param_name =
+                  switch (label) {
+                  | Types.Labeled({txt})
+                  | Default({txt}) => txt
+                  | Unlabeled => string_of_int(index)
+                  };
+                Buffer.add_string(
+                  output,
+                  Printf.sprintf(" * @param %s:\n", param_name),
+                );
+              },
+              args,
+            );
+            Buffer.add_string(output, " * @returns \n");
+          | _ => ()
+          }
+        });
+      Some(add_graindoc(Utils.loc_to_range(loc), uri, message));
     };
-    // TODO: Better place after and
+  | [Module({loc}), ...rest] =>
     let ordered = Comments.to_ordered(~extract_attributes=false, comments);
     let comment =
       Comments.Doc.ending_on(~lnum=loc.loc_start.pos_lnum - 1, ordered);
     switch (comment) {
     | Some((Doc(_), _, _)) => None
-    | _ => Some(add_graindoc(Utils.loc_to_range(loc), uri, expr.exp_type))
+    | _ =>
+      let loc = get_end_of_last_line(loc);
+      let message = template_graindoc(_ => ());
+      Some(add_graindoc(Utils.loc_to_range(loc), uri, message));
     };
   | [_, ...rest] => process_graindoc(uri, rest, comments)
   | _ => None

compiler/src/language_server/sourcetree.re

@@ -587,10 +587,7 @@ module Sourcetree: Sourcetree = {
                         mut_flag,
                         pat: vb_pat,
                         expr: vb_expr,
-                        loc: {
-                          ...vb_loc,
-                          loc_start: stmt.ttop_loc.loc_start,
-                        },
+                        loc: vb_loc,
                       }),
                     ),
                     ...segments,