improve document-symbol

resolve #1673

Author: sumneko

script/core/document-symbol.lua

@@ -5,29 +5,39 @@ local define   = require 'proto.define'
 local util     = require 'utility'
 local subber   = require 'core.substring'
 
+---@param text string
+---@return string
+local function clipLastLine(text)
+    if text:find '[\r\n]' then
+        return '... ' .. util.trim(text:match '[^\r\n]*$')
+    else
+        return text
+    end
+end
+
 local function buildName(source, sub)
     if source.type == 'setmethod'
     or source.type == 'getmethod' then
         if source.method then
-            return sub(source.start + 1, source.method.finish)
+            return clipLastLine(sub(source.start + 1, source.method.finish))
         end
     end
     if source.type == 'setfield'
     or source.type == 'tablefield'
     or source.type == 'getfield' then
         if source.field then
-            return sub(source.start + 1, source.field.finish)
+            return clipLastLine(sub(source.start + 1, source.field.finish))
         end
     end
     if source.type == 'tableindex' then
         if source.index then
-            return sub(source.start + 1, source.finish)
+            return ('[%s]'):format(clipLastLine(sub(source.index.start + 1, source.index.finish)))
         end
     end
     if source.type == 'tableexp' then
         return ('[%d]'):format(source.tindex)
     end
-    return sub(source.start + 1, source.finish)
+    return clipLastLine(sub(source.start + 1, source.finish))
 end
 
 local function buildFunctionParams(func)
@@ -205,18 +215,20 @@ local function buildAnonymous(source, sub, used, symbols)
     end
     used[source] = true
     local head = ''
+    local detail = ''
     local parent = source.parent
     if     parent.type == 'return' then
         head = 'return'
     elseif parent.type == 'callargs' then
         local call = parent.parent
         local node = call.node
-        head = buildName(node, sub) .. ' ->'
+        head = buildName(node, sub)
+        detail = '-> '
     end
     if source.type == 'function' then
         symbols[#symbols+1] = {
             name           = head,
-            detail         = ('function (%s)'):format(buildFunctionParams(source)),
+            detail         = detail .. ('function (%s)'):format(buildFunctionParams(source)),
             kind           = define.SymbolKind.Function,
             range          = { source.start, source.finish },
             selectionRange = { source.keyword[1], source.keyword[2] },
@@ -243,7 +255,7 @@ local function buildAnonymous(source, sub, used, symbols)
         end
         symbols[#symbols+1] = {
             name           = head,
-            detail         = table.concat(details),
+            detail         = detail .. table.concat(details),
             kind           = kind,
             range          = { source.start, source.finish },
             selectionRange = { source.start, source.finish },

test/document_symbol/init.lua

@@ -565,8 +565,8 @@ local t = f({
         valueRange = {10, 20002},
         children = {
             [1] = {
-                name = 'f ->',
-                detail = '{k}',
+                name = 'f',
+                detail = '-> {k}',
                 kind = define.SymbolKind.Object,
                 range = {12, 20001},
                 selectionRange = {12, 20001},
@@ -642,8 +642,8 @@ local a = f {
         valueRange = {10, 30001},
         children = {
             [1] = {
-                name = 'f ->',
-                detail = '{x}',
+                name = 'f',
+                detail = '-> {x}',
                 kind = define.SymbolKind.Object,
                 range = {12, 30001},
                 selectionRange = {12, 30001},
@@ -670,8 +670,8 @@ end)
 ]]
 {
     [1] = {
-        name = 'table.sort ->',
-        detail = 'function (a, b)',
+        name = 'table.sort',
+        detail = '-> function (a, b)',
         kind = define.SymbolKind.Function,
         range = {14, 20003},
         selectionRange = {14, 22},
@@ -858,3 +858,18 @@ end
         children = EXISTS,
     },
 }
+
+TEST [[
+X
+.Y
+.Z = 1
+]]
+{
+    {
+        name   = '... .Z',
+        detail = '1',
+        kind = define.SymbolKind.Number,
+        range = {20001, 20006},
+        selectionRange = {20001, 20002},
+    },
+}