att

Author: mateusmoutinho

README.md

@@ -89,6 +89,54 @@ lua teste.lua conf:test a b
 if will show:
 ```txt
 test
+```
+## Compact Flags size
+You also can get the compact flags size
+```lua
+argv = require("luargv")
+local conf_flags = { "conf:", "conf=" }
+local size = argv.get_compact_flags_size(conf_flags)
+for i = 1, size do
+    local current_conf = argv.get_compact_flags(conf_flags, i)
+    print("conf " .. i .. ":" .. current_conf)
+end
+```
+if you run:
+```shell
+ lua teste.lua conf=a conf:b
+```
+the output will be:
+```txt
+conf 1:b
+conf 2:a
+```
+## Unused flags
+with unsed and unused flags, you can make complex CLIS, by combining flags and args
+
+```lua
+argv = require("luargv")
+--these its required to mark as used
+argv.get_arg_by_index(1)
+argv.get_arg_by_index(2)
+local output = argv.get_flag_arg_by_index({ "out", "o" }, 1)
+if not output then
+    print("output its required")
+    return
+end
+local entry = argv.get_next_unused()
+if not entry then
+    print("entry its required")
+    return
+end
+local error_flag = argv.get_next_unused()
+if error_flag then
+    print("unused flag", error_flag)
+    return
+end
+
+print("output:", output)
+print("entry:", entry)
+
 ```
 
 ## Configuring the project

src/luargv/compact_flag.lua

@@ -31,3 +31,29 @@ luargv.get_compact_flags = function(flags, index, default)
 
     return default
 end
+
+---@class Argv
+---@field get_compact_flags_size fun(flags:string[]|string):number
+luargv.get_compact_flags_size = function(flags)
+    local converted_flags = flags
+    if luargv.type(flags) == "string" then
+        ---@type string
+        flags = flags
+        converted_flags = { flags }
+    end
+    local total = 0
+    for i = 1, #flags do
+        local flag_name = flags[i]
+        local flag_size = luargv.get_str_size(flag_name)
+        local args_size = luargv.get_total_args_size()
+        for i = 1, args_size do
+            local current = luargv.get_arg_by_index_not_adding_to_used(i)
+
+            if private_luargv.starts_with(current, flag_name) then
+                total = total + 1
+            end
+        end
+    end
+
+    return total
+end