diff options
| author | Lewis Russell <lewis6991@gmail.com> | 2023-09-25 12:27:57 +0100 |
|---|---|---|
| committer | Lewis Russell <lewis6991@gmail.com> | 2023-09-25 12:30:58 +0100 |
| commit | 18989b42e4fdd6d299a96256d45221f1f244046a (patch) | |
| tree | 5508b3290e774013de0f56f0c2ab7794cfe2915d | |
| parent | 00dc914c684751296ad74431cb4f6f0459c93e7d (diff) | |
| download | lua-language-server-18989b42e4fdd6d299a96256d45221f1f244046a.zip | |
feat: support param snippets with space
Currently LuaLS will expand:
```lua
---<??>
local x = function (x, y) end
```
with:
```lua
---comment
---@param x any
---@param y any
local x = function (x, y) end
```
This change adds a variation of this snippet to expand:
```lua
--- <??>
local x = function (x, y) end
```
with:
```lua
--- comment
--- @param x any
--- @param y any
local x = function (x, y) end
```
| -rw-r--r-- | script/core/completion/completion.lua | 15 | ||||
| -rw-r--r-- | test/completion/common.lua | 6 |
2 files changed, 14 insertions, 7 deletions
diff --git a/script/core/completion/completion.lua b/script/core/completion/completion.lua index 5a61919c..4462bf64 100644 --- a/script/core/completion/completion.lua +++ b/script/core/completion/completion.lua @@ -2158,7 +2158,7 @@ local function tryluaDocByErr(state, position, err, docState, results) end end -local function buildluaDocOfFunction(func) +local function buildluaDocOfFunction(func, pad) local index = 1 local buf = {} buf[#buf+1] = '${1:comment}' @@ -2182,7 +2182,8 @@ local function buildluaDocOfFunction(func) local funcArg = func.args[n] if funcArg[1] and funcArg.type ~= 'self' then index = index + 1 - buf[#buf+1] = ('---@param %s ${%d:%s}'):format( + buf[#buf+1] = ('---%s@param %s ${%d:%s}'):format( + pad and ' ' or '', funcArg[1], index, arg @@ -2200,7 +2201,7 @@ local function buildluaDocOfFunction(func) return insertText end -local function tryluaDocOfFunction(doc, results) +local function tryluaDocOfFunction(doc, results, pad) if not doc.bindSource then return end @@ -2222,7 +2223,7 @@ local function tryluaDocOfFunction(doc, results) end end end - local insertText = buildluaDocOfFunction(func) + local insertText = buildluaDocOfFunction(func, pad) results[#results+1] = { label = '@param;@return', kind = define.CompletionItemKind.Snippet, @@ -2240,9 +2241,9 @@ local function tryLuaDoc(state, position, results) end if doc.type == 'doc.comment' then local line = doc.originalComment.text - -- 尝试 ---$ - if line == '-' then - tryluaDocOfFunction(doc, results) + -- 尝试 '---$' or '--- $' + if line == '-' or line == '- ' then + tryluaDocOfFunction(doc, results, line == '- ') return end -- 尝试 ---@$ diff --git a/test/completion/common.lua b/test/completion/common.lua index bd317259..7de1c325 100644 --- a/test/completion/common.lua +++ b/test/completion/common.lua @@ -3864,6 +3864,12 @@ local x = function (x, y) end (EXISTS) TEST [[ +--- <??> +local x = function (x, y) end +]] +(EXISTS) + +TEST [[ local x = { <??> }) |