Mercurial > prosody-hg

comparison spec/util_argparse_spec.lua @ 13898:aac30c5ee334

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
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 81856814d74f
children
comparison
equal deleted inserted replaced
13897:6d067ec8ec4a 13898:aac30c5ee334
40 assert.same({ foo = true; bar = true }, opts); 40 assert.same({ foo = true; bar = true }, opts);
41 end 41 end
42 42
43 do 43 do
44 -- Same test with strict mode enabled and all parameters declared 44 -- Same test with strict mode enabled and all parameters declared
45 local opts, err = parse({ "--foo"; "-b" }, { kv_params = { foo = true, bar = true }; short_params = { b = "bar" }, strict = true }); 45 local opts, err = parse({ "--foo"; "-b" }, { bool_params = { foo = true, bar = true }; short_params = { b = "bar" }, strict = true });
46 assert.falsy(err); 46 assert.falsy(err);
47 assert.same({ foo = true; bar = true }, opts); 47 assert.same({ foo = true; bar = true }, opts);
48 end 48 end
49 end); 49 end);
50 50
51 it("supports value arguments", function() 51 it("supports value arguments", function()
52 local opts, err = parse({ "--foo"; "bar"; "--baz=moo" }, { value_params = { foo = true; bar = true } }); 52 local opts, err = parse({ "--foo"; "bar"; "--baz=moo" }, { value_params = { foo = true; bar = true, baz = true } });
53 assert.falsy(err); 53 assert.falsy(err);
54 assert.same({ foo = "bar"; baz = "moo" }, opts); 54 assert.same({ foo = "bar"; baz = "moo" }, opts);
55 end); 55 end);
56 56
57 it("supports value arguments in strict mode", function() 57 it("supports value arguments in strict mode", function()
94 assert.falsy(opts); 94 assert.falsy(opts);
95 assert.same("param-not-found", err); 95 assert.same("param-not-found", err);
96 assert.same("--foobar", err2); 96 assert.same("--foobar", err2);
97 end); 97 end);
98 98
99 it("accepts known kv parameters in strict mode", function () 99 it("accepts known bool parameters in strict mode", function ()
100 local opts, err = parse({ "--item=foo" }, { kv_params = { item = true }, strict = true }); 100 local opts, err = parse({ "--item" }, { bool_params = { item = true }, strict = true });
101 assert.falsy(err); 101 assert.falsy(err);
102 assert.same("foo", opts.item); 102 assert.same(true, opts.item);
103 end); 103 end);
104 end); 104 end);