♻️ refactor(full-scope)!: major revision refactoring

Code layout has been changed and improoved. Annotations are added for documentation. Automated through utility functions and data tables

BREAKING CHANGE: Tested from clean. Now properly uses LuaRocks to install dependencies.

lua/utils/init.lua

@@ -1,25 +1,42 @@
 ---@module "utils"
 --- This module aggregates various utility functions used across the configuration.
---- It provides access to caching mechanisms, Git utilities, WakaTime statistics, music status, highlighting utilities, and a blinking effect utility.
+--- It provides access to caching mechanisms, Git utilities, WakaTime statistics, music status, highlight utilities, and a blinking effect utility.
 
-local cache = require("utils.cache_stats")
-local git = require("utils.git")
-local wakatime = require("utils.wakatime_stats")
-local music = require("utils.music_stats")
-local highlight = require("utils.highlight")
-local blinky = require("utils.blinky")
+local utils = {}
 
----@alias UtilsModule
----| { cache_stats: table, git: table, wakatime_stats: table, music_stats: table, highlight: table, blinky: table }
+-- Explicitly specify modules for LSP support
+utils.cache_stats = require("utils.cache_stats")
+utils.git = require("utils.git")
+utils.wakatime_stats = require("utils.wakatime_stats")
+utils.music_stats = require("utils.music_stats")
+utils.highlight = require("utils.highlight")
+utils.blinky = require("utils.blinky")
+
+-- Function to iterate over files in the directory and load them dynamically
+local function read_utils_dir()
+  -- Getting the root path for the current module directory
+  local dir_path = vim.fn.fnamemodify(debug.getinfo(1, "S").source:sub(2), ":h")
+
+  -- Open the directory
+  local files = vim.fn.readdir(dir_path)
+
+  for _, file in ipairs(files) do
+    -- Skip init.lua
+    if file ~= "init.lua" and file:match(".*%.lua$") then
+      -- Get the module name without the .lua extension
+      local module_name = file:sub(1, -5)
+      -- Load the module if not already explicitly set
+      if not utils[module_name] then
+        utils[module_name] = require("utils." .. module_name)
+      end
+    end
+  end
+end
+
+-- Read the directory to load any additional modules
+read_utils_dir()
+
+---@alias UtilsModule table<string, any>
 
 ---@type UtilsModule
-local utils = {
-  cache_stats = cache,
-  git = git,
-  wakatime_stats = wakatime,
-  music_stats = music,
-  highlight = highlight,
-  blinky = blinky,
-}
-
 return utils