Skip to content

feat: support param snippets with space #2346

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 26, 2023
Merged

feat: support param snippets with space #2346

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 8 additions & 7 deletions script/core/completion/completion.lua
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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}'
Expand All @@ -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
Expand All @@ -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
Expand All @@ -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,
Expand All @@ -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
-- 尝试 ---@$
Expand Down
6 changes: 6 additions & 0 deletions test/completion/common.lua
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3863,6 +3863,12 @@ local x = function (x, y) end
]]
(EXISTS)

TEST [[
--- <??>
local x = function (x, y) end
]]
(EXISTS)

TEST [[
local x = {
<??>
Expand Down