handling MakeCommand with completion

[milnak]

config.MakeCommand("test", testCommand, testCompletion)

testCompletion returns two tables of strings.

function testCommand(bufPane, args)

in testCommand, args is 'userdata' type. How do I determine which item from the testCompletion routine was chosen?

[Andriamanitra]

How do I determine which item from the testCompletion routine was chosen?

I don't really understand the question (what do you mean by "item" and "chosen"?) but I will try to explain how the completer system works.

Note

If you don't need custom completions you can just pass in one of the pre-defined completers: config.NoComplete, config.FileComplete, config.HelpComplete, config.OptionComplete, or config.OptionValueComplete.

When the user types "test " into the command prompt and triggers Autocomplete action (typically by pressing Tab) micro will call your testCompletion function. That function should return two tables of the same length:

• the first one contains strings that will be inserted to the buffer (I'll call these completions)
• the second one contains strings that will be shown to the user when cycling through the completions (I'll call these suggestions)

If only a single completion was returned then it will be immediately accepted and inserted into the buffer. If the function returned multiple completions the user will instead be shown the list of suggestions that they can cycle through. So when the user triggers the completer in a buffer that contains "this is a te" it might return {"st", "rrible idea"} and {"test", "terrible idea"}.

If you want a complete example you can look at how some existing plugins do it. As a simple example my gh plugin completes the names of its subcommands like this:

local subcommands = {
    ["branch"] = gh_branch,
    ["file"] = gh_file,
    ["issues"] = gh_issues,
    ["pr"] = gh_pr,
}

function init()
    local gh_completer = function (buf)
        local s = buf:Line(0):gsub("^gh ", "")

        local completions = {}
        local suggestions = {}
        for subcomm, _ in pairs(subcommands) do
            if string.find(subcomm, s, 1, true) == 1 then
                table.insert(completions, subcomm:sub(#s + 1, #subcomm) .. " ")
                table.insert(suggestions, subcomm)
            end
        end

        return completions, suggestions
    end

    config.MakeCommand("gh", gh, gh_completer)
end

[milnak]

thank you for your response, I appreciate it. What I'm looking for is the completion not to be placed into the buffer, but rather returned to my LUA code so that I can act on it, e.g. it might show a set of options:

[Option1] [Option2] [Option3]

the user would choose one and then my code would get the chosen response. Maybe completion isn't the correct object for me to use for this purpose?