据我所知,Clink ( http://mridgers.github.io/clink/ ) 没有提供任何关于如何使用它提到的 lua API 的文档。
我查看了安装目录中的 clink.lua 文件的内容,我可以大致了解它是如何工作的,但我想知道如何编写自己的 lua 文件来添加新的参数自动完成(我不想直接编辑 clink.lua,以免破坏现有功能)并让 Clink 检测并使用我的文件。
过去有没有人玩过这个?
最佳答案
我相信many people have the same question .
我找到的最全面的手册是this document ,它在 git 中,但不在 master 中。它写得很好,涵盖了很多内容。
简要总结:
文件位置
在clink v0.4.6中,安装有一个profile/
目录。将 lua 完成文件放入该目录后,它们会在启动新进程或使用 Ctl-Q 刷新时被拾取。
文件谈到c:\Documents and Settings\<username>\Local Settings\Application Data
(对于 XP)和 c:\Users\<username>\AppData\Local
(从 Vista 开始)。我用 clink-1.0.0a1.823d84 试过了,但(还)没能让它工作。
语法
这是命令 foobar 的简单解析器示例;
my_parser = clink.arg.new_parser()
my_parser:set_flags("-foo", "-bar")
my_parser:set_arguments(
{ "hello", "hi" }, -- first position
{ "world", "wombles" } -- second position
)
clink.arg.register_parser("foobar", my_parser)
在第一个位置(foobar
之后)clink 会提示hello
或 hi
.
之后,在第二个位置(foobar hello
或foobar hi
之后),clink 将提示world
。或 wombles
.
标志与位置无关。
而不是调用 set_flags
和 set_arguments
, 你也可以使用这个简洁的语法:
some_parser = clink.arg.new_parser(
{ "arg1-1", "arg1-2" },
{ "arg2-1", "arg2-2" },
"-flag1", "-flag2"
)
高级语法
解析器可以嵌套,这对于采用有限数量有效值的标志很有用。
Clink 允许您使用 Lua 的 ..
链接解析器连接运算符。例如:
local parser = clink.arg.new_parser
local my_parser = parser(
"-s" .. parser({"ruby", "webpi", "cygwin", "windowsfeatures", "python"}),
"--source" .. parser({"ruby", "webpi", "cygwin", "windowsfeatures", "python"}),
"--version",
clink.arg.register_parser("mycommand", my_parser)
这也可以用于实现“命令套件”(带有子命令的命令)的完成。例如:
local parser = clink.arg.new_parser
local git_parser = parser(
{
"add" .. parser({}, -- empty {}: don't suggest any positional args
"-n", "--dry-run",
"-v", "--verbose",
"-f", "--force",
"-i", "--interactive",
"-A", "--all",
"--refresh"
),
"commit" .. parser(
"-a", "--all",
"-m", "--message=",
"-e", "--edit",
"--amend",
"-u", "--untracked-files", "--untracked-files=", -- .. parser({"no", "normal", "all"}),
"-v", "--verbose",
"-q", "--quiet",
"--"
),
"remote"..parser({
"add" ..parser(
"-t"..parser({branches}), -- defined elsewhere
"-m",
"-f",
"--mirror",
"--tags", "--no-tags"
),
"rename"..parser({remotes}),
"remove"..parser({remotes}),
"rm"..parser({remotes}),
"set-head"..parser({remotes}, {branches},
"-a", "--auto",
"-d", "--delete"
),
"set-branches"..parser("--add", {remotes}, {branches}),
"set-url"..parser(
"--add"..parser("--push", {remotes}),
"--delete"..parser("--push", {remotes})
),
"get-url"..parser({remotes}, "--push", "--all"),
"show"..parser("-n", {remotes}),
"prune"..parser("-n", "--dry-run", {remotes}),
"update"..parser({remotes}, "-p", "--prune")
}, "-v", "--verbose"),
},
"--version",
"--help",
"-c",
"--git-dir",
)
clink.arg.register_parser("git", git_parser)
这是 Vladimir Kotikov 的 git.lua 的缩略版完成脚本。有关完整来源,请参阅原文。
预构建的 CLink 完成
弗拉基米尔·科蒂科夫 (Vladimir Kotikov) 创建了一个非常不错的 clink-completion scripts 系列对于许多常用命令。他还pointed out我之前提到的隐藏的碰杯手册。不要忘记给他的 GitHub 项目留个星标! :-)
关于lua - 如何使用 Clink lua api?,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/59788504/