Add support for @deprecated attributes in autocomplete and hover.

Add support for `@deprecated` attributes in autocomplete and hover.
For autocomplete: tell the client that the item is deprecated (typically shown with a strike-through by the client). Also, show the deprecation message.
For hover, show the deprecation message.

See rescript-lang/rescript-vscode#45

Author: cristianoc

Changes.md

@@ -1,4 +1,7 @@
 ## master
+- Add support for @deprecated attributes in autocomplete and hover.
+
+## Upcoming Release of rescript-vscode
 
 #### New features
 - Add support for autocomplete for pipe-first `foo->`: the type of `foo` is used to determine the module to take completions from.

editor-extensions/vscode/package-lock.json

@@ -10,7 +10,7 @@
 		"url": "https://github.com/jaredly/reason-language-server"
 	},
 	"engines": {
-		"vscode": "^1.22.0"
+		"vscode": "^1.43.0"
 	},
 	"categories": [
 		"Other"
@@ -143,7 +143,7 @@
 	},
 	"devDependencies": {
 		"vscode": "^1.1.17",
-		"vscode-languageclient": "^4.1.3",
+		"vscode-languageclient": "^6.1.3",
 		"vscode-languageserver-types": "^3.14.0",
 		"typescript": "^2.8.1"
 	}

editor-extensions/vscode/package.json

@@ -111,3 +111,17 @@ module Lib = {
   let next = (~number=0, ~year) => number + year
 }
 
+@ocaml.doc("This module is commented")
+@deprecated("This module is deprecated")
+module Dep : {
+  @ocaml.doc("Some doc comment")
+  @deprecated("Use customDouble instead")
+  let customDouble : int => int
+
+  let customDouble2 : int => int
+} = {
+  let customDouble = foo => foo * 2
+  let customDouble2 = foo => foo * 2
+}
+
+let cc = Dep.customDouble(11)

examples/example-project/src/ZZ.res

@@ -18,6 +18,7 @@ let codeBlock = code => {
 
 let showModuleTopLevel =
     (
+      ~deprecated,
       ~docstring,
       ~name,
       topLevel: list(SharedTypes.declared(SharedTypes.moduleItem)),
@@ -41,20 +42,27 @@ let showModuleTopLevel =
     | None => ""
     | Some(s) => "\n" ++ s ++ "\n"
     };
-  Some(doc ++ codeBlock(full));
+  let depr =
+    switch (deprecated) {
+    | None => ""
+    | Some(s) => "\n Deprecated: " ++ s ++ "\n"
+    };
+  Some(depr ++ doc ++ codeBlock(full));
 };
 
 let showModule =
     (
+      ~deprecated,
       ~docstring,
       ~file: SharedTypes.file,
       ~name,
       declared: option(SharedTypes.declared(SharedTypes.moduleKind)),
     ) => {
   switch (declared) {
-  | None => showModuleTopLevel(~docstring, ~name, file.contents.topLevel)
+  | None =>
+    showModuleTopLevel(~deprecated, ~docstring, ~name, file.contents.topLevel)
   | Some({item: Structure({topLevel})}) =>
-    showModuleTopLevel(~docstring, ~name, topLevel)
+    showModuleTopLevel(~deprecated, ~docstring, ~name, topLevel)
   | Some({item: Ident(_)}) => Some("Unable to resolve module reference")
   };
 };
@@ -70,12 +78,12 @@ let newHover = (~rootUri, ~file: SharedTypes.file, ~getModule, loc) => {
     let%opt md = Hashtbl.find_opt(file.stamps.modules, stamp);
     let%opt (file, declared) =
       References.resolveModuleReference(~file, ~getModule, md);
-    let (name, docstring) =
+    let (name, deprecated, docstring) =
       switch (declared) {
-      | Some(d) => (d.name.txt, d.docstring)
-      | None => (file.moduleName, file.contents.docstring)
+      | Some(d) => (d.name.txt, d.deprecated, d.docstring)
+      | None => (file.moduleName, None, file.contents.docstring)
       };
-    showModule(~docstring, ~name, ~file, declared);
+    showModule(~deprecated, ~docstring, ~name, ~file, declared);
   | LModule(GlobalReference(moduleName, path, tip)) =>
     let%opt file = getModule(moduleName);
     let env = Query.fileEnv(file);
@@ -84,16 +92,17 @@ let newHover = (~rootUri, ~file: SharedTypes.file, ~getModule, loc) => {
     let%opt md = Hashtbl.find_opt(file.stamps.modules, stamp);
     let%opt (file, declared) =
       References.resolveModuleReference(~file, ~getModule, md);
-    let (name, docstring) =
+    let (name, deprecated, docstring) =
       switch (declared) {
-      | Some(d) => (d.name.txt, d.docstring)
-      | None => (file.moduleName, file.contents.docstring)
+      | Some(d) => (d.name.txt, d.deprecated, d.docstring)
+      | None => (file.moduleName, None, file.contents.docstring)
       };
-    showModule(~docstring, ~name, ~file, declared);
+    showModule(~deprecated, ~docstring, ~name, ~file, declared);
   | LModule(NotFound) => None
   | TopLevelModule(name) =>
     let%opt file = getModule(name);
     showModule(
+      ~deprecated=None,
       ~docstring=file.contents.docstring,
       ~name=file.moduleName,
       ~file,
@@ -113,7 +122,7 @@ let newHover = (~rootUri, ~file: SharedTypes.file, ~getModule, loc) => {
       },
     )
   | Typed(t, locKind) =>
-    let fromType = (~docstring, typ) => {
+    let fromType = (~deprecated, ~docstring, typ) => {
       let typeString = codeBlock(typ |> Shared.typeToString);
       let extraTypeInfo = {
         let env = Query.fileEnv(file);
@@ -125,35 +134,44 @@ let newHover = (~rootUri, ~file: SharedTypes.file, ~getModule, loc) => {
         if (isUncurriedInternal) {
           None;
         } else {
-          Some((decl |> Shared.declToString(txt), docstring));
+          Some((decl |> Shared.declToString(txt), deprecated, docstring));
         };
       };
-      let (typeString, docstring) =
+      let (typeString, deprecated, docstring) =
         switch (extraTypeInfo) {
-        | None => (typeString, docstring)
-        | Some((extra, extraDocstring)) => (
+        | None => (typeString, deprecated, docstring)
+        | Some((extra, extraDeprecated, extraDocstring)) => (
             typeString ++ "\n\n" ++ codeBlock(extra),
+            extraDeprecated,
             extraDocstring,
           )
         };
-      (Some(typeString), docstring);
+      let deprecatedMsg =
+        switch (deprecated) {
+        | None => None
+        | Some(s) => Some("Deprecated: " ++ s)
+        };
+      (Some(typeString), deprecatedMsg, docstring);
     };
 
     let parts =
       switch (References.definedForLoc(~file, ~getModule, locKind)) {
       | None =>
-        let (typeString, docstring) = t |> fromType(~docstring=None);
-        [typeString, docstring];
-      | Some((docstring, {uri}, res)) =>
+        let (typeString, deprecatedMsg, docstring) =
+          t |> fromType(~deprecated=None, ~docstring=None);
+        [typeString, deprecatedMsg, docstring];
+      | Some((deprecated, docstring, {uri}, res)) =>
         let pathFromRoot = uri |> Uri2.pathFromRoot(~rootUri);
 
         let parts =
           switch (res) {
           | `Declared =>
-            let (typeString, docstring) = t |> fromType(~docstring);
-            [typeString, docstring];
+            let (typeString, deprecatedMsg, docstring) =
+              t |> fromType(~deprecated, ~docstring);
+            [typeString, deprecatedMsg, docstring];
           | `Constructor({cname: {txt}, args}) =>
-            let (typeString, docstring) = t |> fromType(~docstring);
+            let (typeString, deprecatedMsg, docstring) =
+              t |> fromType(~deprecated, ~docstring);
 
             let argsString =
               switch (args) {
@@ -165,10 +183,16 @@ let newHover = (~rootUri, ~file: SharedTypes.file, ~getModule, loc) => {
                 |> Printf.sprintf("(%s)")
               };
 
-            [typeString, Some(codeBlock(txt ++ argsString)), docstring];
+            [
+              typeString,
+              Some(codeBlock(txt ++ argsString)),
+              deprecatedMsg,
+              docstring,
+            ];
           | `Field({typ}) =>
-            let (typeString, docstring) = typ |> fromType(~docstring);
-            [typeString, docstring];
+            let (typeString, deprecatedMsg, docstring) =
+              typ |> fromType(~deprecated, ~docstring);
+            [typeString, deprecatedMsg, docstring];
           };
 
         parts @ [Some(pathFromRoot)];

src/rescript-editor-support/Hover.re

@@ -577,26 +577,33 @@ let getItems =
 
 module J = JsonShort;
 
-let mkItem = (~name, ~kind, ~detail, ~docstring, ~uri, ~pos_lnum) => {
+let mkItem = (~name, ~kind, ~detail, ~deprecated, ~docstring, ~uri, ~pos_lnum) => {
+  let valueMessage =
+    (
+      switch (deprecated) {
+      | None => ""
+      | Some(s) => "Deprecated: " ++ s ++ "\n\n"
+      }
+    )
+    ++ (
+      switch (docstring) {
+      | None => ""
+      | Some(s) => s ++ "\n\n"
+      }
+    )
+    ++ "\n"
+    ++ Uri2.toString(uri)
+    ++ ":"
+    ++ string_of_int(pos_lnum);
+  let tags = deprecated == None ? [] : [J.i(1 /* deprecated */)];
   J.o([
     ("label", J.s(name)),
     ("kind", J.i(kind)),
+    ("tags", J.l(tags)),
     ("detail", detail |> J.s),
     (
       "documentation",
-      J.o([
-        ("kind", J.s("markdown")),
-        (
-          "value",
-          J.s(
-            (docstring |? "No docs")
-            ++ "\n\n"
-            ++ Uri2.toString(uri)
-            ++ ":"
-            ++ string_of_int(pos_lnum),
-          ),
-        ),
-      ]),
+      J.o([("kind", J.s("markdown")), ("value", J.s(valueMessage))]),
     ),
   ]);
 };
@@ -639,6 +646,7 @@ let computeCompletions = (~full, ~maybeText, ~package, ~pos, ~state) => {
                uri,
                {
                  SharedTypes.name: {txt: name, loc: {loc_start: {pos_lnum}}},
+                 deprecated,
                  docstring,
                  item,
                },
@@ -647,6 +655,7 @@ let computeCompletions = (~full, ~maybeText, ~package, ~pos, ~state) => {
            mkItem(
              ~name,
              ~kind=kindToInt(item),
+             ~deprecated,
              ~detail=detail(name, item),
              ~docstring,
              ~uri,
@@ -761,6 +770,7 @@ let computeCompletions = (~full, ~maybeText, ~package, ~pos, ~state) => {
                        txt: name,
                        loc: {loc_start: {pos_lnum}},
                      },
+                     deprecated,
                      docstring,
                      item,
                    },
@@ -770,6 +780,7 @@ let computeCompletions = (~full, ~maybeText, ~package, ~pos, ~state) => {
                  ~name=completionName(name),
                  ~kind=kindToInt(item),
                  ~detail=detail(name, item),
+                 ~deprecated,
                  ~docstring,
                  ~uri,
                  ~pos_lnum,
@@ -786,6 +797,7 @@ let computeCompletions = (~full, ~maybeText, ~package, ~pos, ~state) => {
         mkItem(
           ~name,
           ~kind=4,
+          ~deprecated=None,
           ~detail="",
           ~docstring=None,
           ~uri=full.file.uri,
@@ -862,6 +874,7 @@ let computeCompletions = (~full, ~maybeText, ~package, ~pos, ~state) => {
         mkItem(
           ~name,
           ~kind=4,
+          ~deprecated=None,
           ~detail=typ |> Shared.typeToString,
           ~docstring=None,
           ~uri=full.file.uri,