#1061 completion for doc.type.code

Author: sumneko

changelog.md

@@ -1,5 +1,14 @@
 # changelog
 
+## 3.3.0
+* `NEW` `LuaDoc` supports `` `CODE` ``
+  ```lua
+  ---@type `CONST.X` | `CONST.Y`
+  local x
+
+  if x == -- suggest `CONST.X` and `CONST.Y` here
+  ```
+
 ## 3.2.5
 `2022-6-9`
 * `NEW` provide config docs in `LUA_LANGUAGE_SERVER/doc/`

script/core/completion/completion.lua

@@ -1136,6 +1136,12 @@ local function checkTypingEnum(state, position, defs, str, results)
                 description = def.comment and def.comment.text,
                 kind        = define.CompletionItemKind.EnumMember,
             }
+        elseif def.type == 'doc.type.code' then
+            enums[#enums+1] = {
+                label       = def[1],
+                description = def.comment and def.comment.text,
+                kind        = define.CompletionItemKind.EnumMember,
+            }
         end
     end
     cleanEnums(enums, str)
@@ -1425,6 +1431,12 @@ local function tryCallArg(state, position, results)
                 description = src.comment,
                 kind        = define.CompletionItemKind.EnumMember,
             }
+        elseif src.type == 'doc.type.code' then
+            enums[#enums+1] = {
+                label       = src[1],
+                description = src.comment,
+                kind        = define.CompletionItemKind.EnumMember,
+            }
         end
         if src.type == 'doc.type.function' then
             local insertText = buildInsertDocFunction(src)

script/core/hover/description.lua

@@ -155,7 +155,8 @@ local function buildEnumChunk(docType, name)
         types[#types+1] = vm.getInfer(tp):view(guide.getUri(docType))
         if tp.type == 'doc.type.string'
         or tp.type == 'doc.type.integer'
-        or tp.type == 'doc.type.boolean' then
+        or tp.type == 'doc.type.boolean'
+        or tp.type == 'doc.type.code' then
             enums[#enums+1] = tp
         end
         local comment = tryDocClassComment(tp)

script/parser/guide.lua

@@ -252,6 +252,7 @@ function m.isLiteral(obj)
         or tp == 'doc.type.string'
         or tp == 'doc.type.integer'
         or tp == 'doc.type.boolean'
+        or tp == 'doc.type.code'
 end
 
 --- 获取字面量

test/completion/common.lua

@@ -3348,3 +3348,37 @@ local xyz
         kind  = define.CompletionItemKind.Variable,
     }
 }
+
+TEST [[
+---@type `CONST.X` | `CONST.Y`
+local x
+
+if x == <??>
+]]
+{
+    {
+        label = 'CONST.X',
+        kind  = define.CompletionItemKind.EnumMember,
+    },
+    {
+        label = 'CONST.Y',
+        kind  = define.CompletionItemKind.EnumMember,
+    },
+}
+
+TEST [[
+---@param x `CONST.X` | `CONST.Y`
+local function f(x) end
+
+f(<??>)
+]]
+{
+    {
+        label = 'CONST.X',
+        kind  = define.CompletionItemKind.EnumMember,
+    },
+    {
+        label = 'CONST.Y',
+        kind  = define.CompletionItemKind.EnumMember,
+    },
+}