Mercurial > prosody-hg
changeset 13898:aac30c5ee334
util.argparse: Rename kv_params to bool_params, remove support for arbitrary values
We have value_params now, which has overlapping behaviour and support
for '--foo bar' as well as '--foo=bar' (only the latter syntax is supported by
kv_params).
The remaining unique property of kv_params is that when used without a value,
i.e. '--foo' then it defaults to boolean true, and when used as '--no-foo' it
defaults to boolean false. This is a useful thing that value_params don't do.
So this commit officially renames kv_params to bool_params (kv_params is still
allowed for now, for some backwards compatibility).
Breaking change though: if any kv_params expected a value, it will no longer
work (--foo=bar will not work). In this case the param should be moved to
value_params.
| author | Matthew Wild <mwild1@gmail.com> |
|---|---|
| date | Thu, 19 Jun 2025 11:19:13 +0100 |
| parents | 6d067ec8ec4a |
| children | b019a30cc1b2 |
| files | spec/util_argparse_spec.lua util/argparse.lua |
| diffstat | 2 files changed, 11 insertions(+), 14 deletions(-) [+] |
line wrap: on
line diff
--- a/spec/util_argparse_spec.lua Wed Jun 18 15:02:23 2025 +0200 +++ b/spec/util_argparse_spec.lua Thu Jun 19 11:19:13 2025 +0100 @@ -42,14 +42,14 @@ do -- Same test with strict mode enabled and all parameters declared - local opts, err = parse({ "--foo"; "-b" }, { kv_params = { foo = true, bar = true }; short_params = { b = "bar" }, strict = true }); + local opts, err = parse({ "--foo"; "-b" }, { bool_params = { foo = true, bar = true }; short_params = { b = "bar" }, strict = true }); assert.falsy(err); assert.same({ foo = true; bar = true }, opts); end end); it("supports value arguments", function() - local opts, err = parse({ "--foo"; "bar"; "--baz=moo" }, { value_params = { foo = true; bar = true } }); + local opts, err = parse({ "--foo"; "bar"; "--baz=moo" }, { value_params = { foo = true; bar = true, baz = true } }); assert.falsy(err); assert.same({ foo = "bar"; baz = "moo" }, opts); end); @@ -96,9 +96,9 @@ assert.same("--foobar", err2); end); - it("accepts known kv parameters in strict mode", function () - local opts, err = parse({ "--item=foo" }, { kv_params = { item = true }, strict = true }); + it("accepts known bool parameters in strict mode", function () + local opts, err = parse({ "--item" }, { bool_params = { item = true }, strict = true }); assert.falsy(err); - assert.same("foo", opts.item); + assert.same(true, opts.item); end); end);
--- a/util/argparse.lua Wed Jun 18 15:02:23 2025 +0200 +++ b/util/argparse.lua Thu Jun 19 11:19:13 2025 +0100 @@ -2,7 +2,7 @@ local short_params = config and config.short_params or {}; local value_params = config and config.value_params or {}; local array_params = config and config.array_params or {}; - local kv_params = config and config.kv_params or {}; + local bool_params = config and (config.bool_params or config.kv_params) or {}; -- COMPAT: kv_params in 13.0 and earlier local strict = config and config.strict; local stop_on_positional = not config or config.stop_on_positional ~= false; @@ -48,16 +48,13 @@ end end else - param_k, param_v = param:match("^([^=]+)=(.+)$"); - if not param_k then - if param:match("^no%-") then - param_k, param_v = param:sub(4), false; - else - param_k, param_v = param, true; - end + if param:match("^no%-") then + param_k, param_v = param:sub(4), false; + else + param_k, param_v = param, true; end param_k = param_k:gsub("%-", "_"); - if strict and not kv_params[param_k] then + if strict and not bool_params[param_k] then return nil, "param-not-found", raw_param; end end
