Chain command after optional "--" #334
-
|
Hey. I'm trying to write completions for aws-vault, but the question is probably applicable to other software as well. What is the best way to match either of:
The skeleton of the script representing the question is pasted below (the whole script is at https://gist.github.com/elieux/cb864345878f501ff8fe1ab728d52e01). I tried various modifications unsuccessfully and this is the only one that worked at least somewhat. Problems are: it covers only the second case and it doesn't suggest using "--". local function profile()
return { "foo", "bar" } -- this is actually found out dynamically
end
clink.argmatcher("aws-vault")
:addflags("--foo")
:addarg({
"exec" .. clink.argmatcher()
:addflags("--bar")
:addarg(profile)
:addflags(
"--" .. clink.argmatcher():chaincommand()
)
:nofiles(),
})
:nofiles() |
Beta Was this translation helpful? Give feedback.
Replies: 5 comments 12 replies
-
|
I'm having trouble following the question, because I don't know anything about I think you mean that And I think you mean that On the argmatcher that's linked to |
Beta Was this translation helpful? Give feedback.
-
|
Now I'm not sure whether I understood. I changed the script, but I'm getting the same results:
local function profile()
return { "foo", "bar" } -- this is actually found out dynamically
end
clink.argmatcher("aws-vault")
:addflags("--foo")
:addarg({
"exec" .. clink.argmatcher()
:addflags("--bar")
:addarg(profile)
:addflags(
"--" .. clink.argmatcher():chaincommand()
)
:chaincommand(),
})
:nofiles() |
Beta Was this translation helpful? Give feedback.
-
|
And regarding not suggesting |
Beta Was this translation helpful? Give feedback.
-
|
I actually prefer writing "--", but since both are possible, I'd like to know if there's a way to have both. |
Beta Was this translation helpful? Give feedback.
-
|
Oops, my mistake: I said to replace For now you can use But also, This script does what I think are you describing: local function profile()
return { "foo", "bar" } -- this is actually found out dynamically
end
local exec_parser = clink.argmatcher()
:addflags(
"--bar",
"--" .. clink.argmatcher():chaincommand()
)
:addarg(profile)
:chaincommand()
clink.argmatcher("aws-vault")
:addflags("--foo")
:addarg({"exec" .. exec_parser})
:nofiles()Note: I rearranged things a little, just for clarity. For example, Did you want for It's possible, but it's not easy. Currently you'd have to use make the |
Beta Was this translation helpful? Give feedback.
-
Yeah, I couldn't find how these stack in the docs. Same with how multiple
Yes, that's how
I might've found an easy way actually. It didn't want to work like this with "function as argument option", but
local map = require("funclib").map
local function profile()
return { "foo", "bar" } -- this is actually found out dynamically
end
clink.argmatcher("aws-vault")
:addflags("--foo")
:addarg({
"exec" .. clink.argmatcher()
:addflags("--bar")
:addarg({ delayinit=function()
return map(profile(), function(item)
return item .. clink.argmatcher()
:addflags(
"--" .. clink.argmatcher():chaincommand():nofiles()
):chaincommand():nofiles()
end)
end })
:nofiles(),
})
:nofiles() |
Beta Was this translation helpful? Give feedback.
-
Regarding this, I just noticed that :addflags(
"--region=" .. clink.argmatcher():addarg(region):nofiles(),
)
:addarg(profile)
:nofiles() |
Beta Was this translation helpful? Give feedback.
-
The section The Basics mentions that arguments are positional. I can try to come up with phrasing that makes it clear that arguments are positional, and therefore the order of
You did what I suggested. (I suggested But, you haven't added a You can use Also, there is an opportunity to speed it up:
The line above is happening inside a loop. So, it ends up creating two whole new argmatchers for each match. You can speed it up by creating the argmatchers outside the loop, and use them over and over inside the loop: ( local map = require("funclib").map
local function profile()
return { "foo", "bar" } -- this is actually found out dynamically
end
clink.argmatcher("aws-vault")
:addflags("--foo")
:addarg({
"exec" .. clink.argmatcher()
:addflags("--bar")
:addarg({ delayinit=function()
-- Build argmatcher outside the map() loop.
local chain = clink.argmatcher()
:addarg("--" .. clink.argmatcher():chaincommand():nofiles())
:chaincommand():nofiles()
return map(profile(), function(item)
return item .. chain -- Reuse existing argmatcher inside the map() loop.
end)
end })
:nofiles(),
})
:nofiles() |
Beta Was this translation helpful? Give feedback.
-
That was kind of what I meant. I read "positional" and "position independent" and all, but it didn't immediately give me the knowledge of:
This really wasn't obvious to me even after having read that part of the docs multiple times. Now when I know, I kind of see it there, but I recommend really giving the basics to the reader as well.
Right. I'll try to play with resetting later, but right now, this thing is very much Good Enough™ for me.
I would expect this to be explicitly mentioned in the docs on Functions As Argument Options. I can see how "table of potential matches" could maybe do that for someone, but given that this section directly follows two sections on linking matchers and the vocabulary isn't established, explicit sounds better to me in this case.
Good point. In conclusionWould it be possible to somehow use I'll be looking forward to v1.3.40 to see those two issues fixed and I'll revisit my script with those two suggestions in mind. I'd like to use my first-time experience to improve the docs. I'm willing to help out (give drafts, more suggestions, revisions...) if you're open to that. |
Beta Was this translation helpful? Give feedback.
-
"the whole set of command lines possible" -- The whole set is very large, and it isn't fair to a reader to dump all those subtly different cases on them so early. Descriptions seem like a better approach. With that said, the first example specifically calls out "arg # 1" and "arg # 2". I'm worried that part of the complication may come from many readers trying to learn Clink's API and also the Lua language at the same time. That's very difficult for the docs to overcome with just a couple of sentences.
Oops, it's a typo from an earlier attempt at clarifying the example.
"Dead end" and "suggest no completions" means parsing ends. This feels like English ambiguity: it could be interpreted as "this parser doesn't provide completions, but other parsers still can", or it could be interpreted as "the parser provides completions, but the set of completions is empty and no more parsing occurs". The latter is the intended meaning. I'll try to rephrase, but I don't want to turn it into a paragraph of details.
I think there's an easier and more concise way to clarify it, and I'll do that.
It's possible to add But what problem is intended to be solved by calling |
Beta Was this translation helpful? Give feedback.
-
You're right, it's possible, but not in an obvious way. If I naively match a profile arg, then the local function profile()
return { "foo", "bar" } -- this is actually found out dynamically
end
clink.argmatcher("aws-vault")
:addflags("--foo")
:addarg({
"exec" .. clink.argmatcher()
:addflags("--bar")
:addarg(profile)
:addarg({ "--" }) -- same result if I link clink.argmatcher():chaincommand():nofiles() here
:chaincommand():nofiles(),
})
:nofiles()It works (completes local map = require("funclib").map
local function profile()
return { "foo", "bar" } -- this is actually found out dynamically
end
clink.argmatcher("aws-vault")
:addflags("--foo")
:addarg({
"exec" .. clink.argmatcher()
:addflags("--bar")
:addarg({ delayinit=function()
return map(profile(), function(item)
return item .. clink.argmatcher()
:addarg({ "--" }) -- same result if I link clink.argmatcher():chaincommand():nofiles() here
:chaincommand():nofiles()
end)
end })
:nofiles(),
})
:nofiles()Given my current understanding of args, I don't see why the first example fails. The second example is more complicated and also cannot continue with completion without exactly matching an existing profile.
I was hoping it would:
There's also the question of how to make |
Beta Was this translation helpful? Give feedback.
-
It's because the example adds both an argument match that starts with So the
The second example works because it adds only an argument that starts with
|
Beta Was this translation helpful? Give feedback.
-
|
Thanks for the clarifications and all the help. |
Beta Was this translation helpful? Give feedback.
-
|
@elieux Based on the discussion here, I've made several changes to the docs for Argument Completion. Please take a look and share feedback on the new content. Thanks! |
Beta Was this translation helpful? Give feedback.
-
|
Looks good, thank you. |
Beta Was this translation helpful? Give feedback.
-
|
I also noticed that Functions As Argument Options says:
... (emphasis mine), while Delayed initialization for an argument position says:
I still think the first one is not entirely obvious due to multiple factors, but it's there, so I'm not gonna push it. |
Beta Was this translation helpful? Give feedback.
-
|
The documentation is different for those because they are very different kinds of functions. Functions As Argument Options is a function that is added via
The function in Function as argument optionlocal function list_colors()
-- This can return the same format that match_builder:addmatches accepts.
return { "red", "green", "blue" }
end
-- Make argmatcher for "foo", whose first argument provides completions for color names:
clink.argmatcher("foo"):addarg(list_colors)Delayed initialization for an argument positionlocal function list_colors()
-- This can return the same format that match_builder:addmatches() accepts.
return { "red", "green", "blue" }
end
-- Function to delay-initialize the first argument position:
local function delay_init()
-- This can return the same format that argmatcher:addarg() accepts.
return { list_colors }
end
-- Make argmatcher for "foo", whose first argument position exists but is not initialized yet.
-- The first time the argmatcher is used with a first argument, then the delayinit function is called.
-- When the delayinit function is called, it finishes initializing the argmatcher.
clink.argmatcher("foo"):addarg({delayinit=init_arg}) |
Beta Was this translation helpful? Give feedback.
Oops, my mistake:
I said to replace
:nofiles()with:chaincommand(). But there is a bug that in some cases falls back to the "parent" argmatcher by mistake if:nofiles()isn't used as well.For now you can use
:chaincommand():nofiles(). And the next Clink update will include a fix so that the:nofiles()isn't needed (it should be implied by:chaincommand()).But also,
aws-vault exec fooTab will behave as thoughexec.enableis False, due to a bug that is already fixed for the upcoming v1.3.40 release. It chains correctly, it just didn't respectexec.enablecorrectly after chaining.This script does what I think are you describing: