scripts/chwd: Add more type annotations

Co-authored-by: Vasiliy Stelmachenok <[email protected]> Signed-off-by: Vasiliy Stelmachenok <[email protected]>
CachyOS · Jan 23, 2025 · f77620e · f77620e
1 parent 7bb32aa
commit f77620e
Showing 1 changed file with 54 additions and 45 deletions.
diff --git a/scripts/chwd b/scripts/chwd
@@ -18,21 +18,23 @@ with this program; if not, write to the Free Software Foundation, Inc.,
 --]]
 local pacman, pmconfig, pmroot, cachedir, sync
 
---- @param s string
---- @return nil
+---@alias hookAlias {pre_install: string?, post_install: string?, post_remove: string?, pre_remove: string?, conditional_packages: string?}
+
+---@param s string
+---@param ... any
 local function printf(s, ...)
     print(s:format(...))
 end
 
---- @param err string
---- @return nil
+---@param err string
+---@param ... any
 local function die(err, ...)
     printf(err, ...)
     os.exit(1)
 end
 
---- @param path string
---- @return boolean
+---@param path string
+---@return boolean
 local function file_exists(path)
     local file = io.open(path, "r")
     if file then
@@ -43,7 +45,7 @@ local function file_exists(path)
     end
 end
 
---- @return boolean
+---@return boolean
 local function check_on_multilib()
     local multilib_pattern = "^%[multilib%]"
     for line in io.lines(pmconfig) do
@@ -54,8 +56,8 @@ local function check_on_multilib()
     return false
 end
 
---- @param str string
---- @return table
+---@param str string
+---@return string[]
 local function split(str)
     local t = {}
     for found in str:gmatch("([^%s]+)") do
@@ -64,8 +66,8 @@ local function split(str)
     return t
 end
 
---- @param args table
---- @return table
+---@param args string[]
+---@return table<string, integer>
 local function get_opts(args)
     local options = {}
     local option_pattern = "-%-?(.+)"
@@ -81,13 +83,16 @@ local function get_opts(args)
     return options
 end
 
---- @param package_name string
---- @return boolean
+---@param package_name string
+---@return boolean
 local function is_installed(package_name)
     local handle = io.popen("/bin/pacman -Qi " .. package_name)
 
     if handle then
-        local line, provider
+        ---@type string?
+        local line
+        ---@type string?
+        local provider
         repeat
             line = handle:read("*l")
             if line then
@@ -104,26 +109,26 @@ local function is_installed(package_name)
     return false
 end
 
---- @param action string
---- @param pkgs string
---- @return integer?
+---@param action string
+---@param pkgs string
+---@return number?
 local function pacman_handle(action, pkgs)
     local cmd = table.concat({ pacman, action, pkgs }, " ")
     local _, _, code = os.execute(cmd)
     return code
 end
 
---- @param packages string
---- @return integer?
+---@param packages string
+---@return number?
 local function install(packages)
     if sync then
         return pacman_handle("--needed -Sy", packages)
     end
     return pacman_handle("--needed -S", packages)
 end
 
---- @param packages string
---- @return integer?
+---@param packages string
+---@return number?
 local function remove(packages)
     local pkgs = ""
     for _, pkg in ipairs(split(packages)) do
@@ -140,9 +145,9 @@ local function remove(packages)
     end
 end
 
---- @param hooks table
---- @param name string
---- @return string | nil
+---@param hooks hookAlias
+---@param name string
+---@return string?
 local function exec_hook(hooks, name)
     local hook = hooks[name]
 
@@ -172,19 +177,22 @@ local function exec_hook(hooks, name)
     return output
 end
 
---- @param text string
---- @return string?, integer
+---@param text string
+---@return string, integer
 local function escape_pattern(text)
     return text:gsub("([^%w])", "%%%1")
 end
 
---- @param path string
---- @return table | nil
+---@param path string
+---@return table<string, {packages: string?, hooks: hookAlias}>
 local function parse_profiles(path)
     local profile_name_pattern = "^%[([A-Za-z0-9-. ]+)%]"
     local packages_pattern     = "^packages%s*=%s*'?\"?([A-Za-z0-9- ]+)'?\"?"
     local profiles             = {}
-    local profile, captured_hook
+    ---@type string?
+    local profile
+    ---@type string?
+    local captured_hook
 
     for line in io.lines(path) do
         local profile_found = line:match(profile_name_pattern)
@@ -233,10 +241,11 @@ local function parse_profiles(path)
 end
 
 
---- @param profiles table
---- @param name string
---- @return string | nil, table
+---@param profiles table<string, {packages: string?, hooks: hookAlias}>
+---@param name string
+---@return string?, hookAlias
 local function get_profile(profiles, name)
+    ---@type string?
     local packages
     local hooks = {}
     local keys = {}
@@ -267,10 +276,11 @@ local function get_profile(profiles, name)
 
     return packages, hooks
 end
---- @param options table
---- @param option string
---- @param default nil | string
---- @return string|nil
+
+---@param options table<string, integer>
+---@param option string
+---@param default string?
+---@return string?
 local function get_opt_argument(options, option, default)
     local index = options[option]
     if index == nil then
@@ -287,6 +297,8 @@ local function get_opt_argument(options, option, default)
             return option_argument
         end
     end
+
+    return nil
 end
 
 local function main()
@@ -308,23 +320,20 @@ local function main()
     end
 
     if not file_exists(path) then
-        return die("Profiles file is not found: %s", path)
+        die("Profiles file is not found: %s", path)
     end
 
+    -- NOTE: the variable is initialized as table in 100% of the control flow
     local profiles = parse_profiles(path)
 
-    if not profiles then
-        return die("Couldn't find any profiles in %s", path)
-    end
-
     if not profiles[profile_name] then
-        return die("Profile not found in %s", path)
+        die("Profile not found")
     end
 
     local packages, hooks = get_profile(profiles, profile_name)
 
     if not packages then
-        return die("Profile %s is not valid", profile_name)
+        die("Profile %s is not valid", profile_name)
     end
 
     if packages and not check_on_multilib() then
@@ -340,7 +349,7 @@ local function main()
             packages = packages .. " " .. conditional_packages
         end
 
-        local code = install(packages)
+        local code = install(packages --[[@as string]])
         if code ~= 0 then
             exec_hook(hooks, "pre_remove")
             die("ERROR: Pacman command was failed! Exit code: %s", code)
@@ -356,7 +365,7 @@ local function main()
             packages = packages .. " " .. conditional_packages
         end
 
-        local code = remove(packages)
+        local code = remove(packages --[[@as string]])
         if code ~= 0 then
             die("ERROR: Pacman command was failed! Exit code: %s", code)
         else