Prefer require() over LoadModule() as it uses type info from the source file

vaisest · vaisest · commit 2ccdc90fa1fa · 2026-05-21T17:00:27.000+03:00
diff --git a/spec/System/TestItemTools_spec.lua b/spec/System/TestItemTools_spec.lua
@@ -48,7 +48,7 @@ describe("TestItemTools", function()
 
 	it("uses the displayed item slot for anoint comparison tooltips", function()
 		if not common.classes.ItemsTab then
-			LoadModule("Classes/ItemsTab")
+			require("Classes/ItemsTab")
 		end
 		local item = new("Item"):Item([[
 Rarity: Rare
diff --git a/src/Classes/CalcsTab.lua b/src/Classes/CalcsTab.lua
@@ -27,7 +27,7 @@ function CalcsTabClass:CalcsTab(build)
 
 	self.build = build
 
-	self.calcs = LoadModule("Modules/Calcs")
+	self.calcs = require("Modules/Calcs")
 
 	self.input = { }
 	self.input.skill_number = 1
@@ -146,7 +146,7 @@ Effective DPS: Curses and enemy properties (such as resistances and status condi
 	end)
 
 	-- Add sections from the CalcSections module
-	local sectionData = LoadModule("Modules/CalcSections")
+	local sectionData = require("Modules/CalcSections")
 	for _, section in ipairs(sectionData) do
 		self:NewSection(unpack(section))
 	end
diff --git a/src/Classes/CompareBuySimilar.lua b/src/Classes/CompareBuySimilar.lua
@@ -6,7 +6,7 @@
 local t_insert = table.insert
 local m_floor = math.floor
 local dkjson = require "dkjson"
-local tradeHelpers = LoadModule("Classes/CompareTradeHelpers")
+local tradeHelpers = require("Classes/CompareTradeHelpers")
 
 local M = {}
 
diff --git a/src/Classes/CompareEntry.lua b/src/Classes/CompareEntry.lua
@@ -48,7 +48,7 @@ function CompareEntryClass:CompareEntry(xmlText, label)
 	self.outputRevision = 1
 
 	-- Display stats (same as primary build uses)
-	self.displayStats, self.minionDisplayStats, self.extraSaveStats = LoadModule("Modules/BuildDisplayStats")
+	self.displayStats, self.minionDisplayStats, self.extraSaveStats = require("Modules/BuildDisplayStats")
 
 	-- Load from XML
 	if xmlText then
diff --git a/src/Classes/CompareTab.lua b/src/Classes/CompareTab.lua
@@ -10,11 +10,11 @@ local m_max = math.max
 local m_floor = math.floor
 local s_format = string.format
 local dkjson = require "dkjson"
-local tradeHelpers = LoadModule("Classes/CompareTradeHelpers")
-local buySimilar = LoadModule("Classes/CompareBuySimilar")
-local calcsHelpers = LoadModule("Classes/CompareCalcsHelpers")
-local buildListHelpers = LoadModule("Modules/BuildListHelpers")
-local configVisibility = LoadModule("Modules/ConfigVisibility")
+local tradeHelpers = require("Classes/CompareTradeHelpers")
+local buySimilar = require("Classes/CompareBuySimilar")
+local calcsHelpers = require("Classes/CompareCalcsHelpers")
+local buildListHelpers = require("Modules/BuildListHelpers")
+local configVisibility = require("Modules/ConfigVisibility")
 
 -- Node IDs below this value are normal passive tree nodes; IDs at or above are cluster jewel nodes
 local CLUSTER_NODE_OFFSET = 65536
@@ -188,9 +188,9 @@ function CompareTabClass:CompareTab(primaryBuild)
 	self.comparePowerCompareId = nil      -- track which compare entry was calculated
 
 	-- Pre-load static module data
-	self.configOptions = LoadModule("Modules/ConfigOptions")
-	self.calcSections = LoadModule("Modules/CalcSections")
-	self.calcs = LoadModule("Modules/Calcs")
+	self.configOptions = require("Modules/ConfigOptions")
+	self.calcSections = require("Modules/CalcSections")
+	self.calcs = require("Modules/Calcs")
 
 	-- Controls for the comparison screen
 	self:InitControls()
diff --git a/src/Classes/CompareTradeHelpers.lua b/src/Classes/CompareTradeHelpers.lua
@@ -10,7 +10,7 @@ do
 	local queryModFile = io.open("Data/QueryMods.lua", "r")
 	if queryModFile then
 		queryModFile:close()
-		queryModsData = LoadModule("Data/QueryMods")
+		queryModsData = require("Data/QueryMods")
 	end
 end
 
diff --git a/src/Classes/ConfigTab.lua b/src/Classes/ConfigTab.lua
@@ -9,8 +9,8 @@ local m_max = math.max
 local m_floor = math.floor
 local s_upper = string.upper
 
-local varList = LoadModule("Modules/ConfigOptions")
-local configVisibility = LoadModule("Modules/ConfigVisibility")
+local varList = require("Modules/ConfigOptions")
+local configVisibility = require("Modules/ConfigVisibility")
 
 ---@class ConfigTab: UndoHandler, ControlHost, Control
 local ConfigTabClass = newClass("ConfigTab", "UndoHandler", "ControlHost", "Control")
diff --git a/src/Classes/PassiveTree.lua b/src/Classes/PassiveTree.lua
@@ -56,8 +56,8 @@ function PassiveTreeClass:PassiveTree(treeVersion)
 	self.treeVersion = treeVersion
 	local versionNum = treeVersions[treeVersion].num
 
-	self.legion = LoadModule("Data/TimelessJewelData/LegionPassives")
-	self.tattoo = LoadModule("Data/TattooPassives")
+	self.legion = require("Data/TimelessJewelData/LegionPassives")
+	self.tattoo = require("Data/TattooPassives")
 
 	MakeDir("TreeData")
 
@@ -200,7 +200,7 @@ function PassiveTreeClass:PassiveTree(treeVersion)
 	end
 
 	if not self.assets then
-		self.assets = LoadModule("TreeData/3_19/Assets.lua")
+		self.assets = require("TreeData/3_19/Assets.lua")
 		self.assets = self.assets.assets
 		if self.alternate_ascendancies then
 			-- backgrounds
@@ -351,7 +351,7 @@ function PassiveTreeClass:PassiveTree(treeVersion)
 	end
 
 	-- Load legion sprite sheets and build sprite map
-	local legionSprites = LoadModule("TreeData/legion/tree-legion.lua")
+	local legionSprites = require("TreeData/legion/tree-legion.lua")
 	for type, data in pairs(legionSprites) do
 		local maxZoom = data[#data]
 		local sheet = spriteSheets[maxZoom.filename]
diff --git a/src/Classes/TradeQueryGenerator.lua b/src/Classes/TradeQueryGenerator.lua
@@ -9,7 +9,7 @@ local curl = require("lcurl.safe")
 local m_max = math.max
 local s_format = string.format
 local t_insert = table.insert
-local tradeHelpers = LoadModule("Classes/CompareTradeHelpers")
+local tradeHelpers = require("Classes/CompareTradeHelpers")
 
 -- TODO generate these from data files
 local itemCategoryTags = {
diff --git a/src/Data/Uniques/Special/Generated.lua b/src/Data/Uniques/Special/Generated.lua
@@ -689,7 +689,7 @@ for _, mod in ipairs(data.uniqueMods["Watcher's Eye"]) do
 	end
 end
 
-local unsortedMods = LoadModule("Data/Uniques/Special/BoundByDestiny")
+local unsortedMods = require("Data/Uniques/Special/BoundByDestiny")
 local sortedMods = { }
 local boundByDestinyMods = { }
 
@@ -911,7 +911,7 @@ Variant: None
 ]]
 }
 
-local unsortedCharmsMods = LoadModule("Data/ModJewelCharm")
+local unsortedCharmsMods = require("Data/ModJewelCharm")
 local sortedCharmsMods = { }
 
 for modId, mod in pairs(unsortedCharmsMods) do
diff --git a/src/Export/Main.lua b/src/Export/Main.lua
@@ -69,7 +69,7 @@ function main:Init()
 	self.popups = { }
 	self.scriptOutput = { }
 
-	self.datSpecs = LoadModule("spec")
+	self.datSpecs = require("spec")
 
 	self.datFileList = { }
 	self.datFileByName = { }
diff --git a/src/Export/Scripts/mapUniqueToFoulborn.lua b/src/Export/Scripts/mapUniqueToFoulborn.lua
@@ -3,8 +3,8 @@ if not table.containsId then
 end
 dofile("Scripts/flavourText.lua")
 
-local foulbornMods = LoadModule("../Data/ModFoulborn.lua")
-local uniques = LoadModule("../Data/FlavourText.lua")
+local foulbornMods = require("../Data/ModFoulborn.lua")
+local uniques = require("../Data/FlavourText.lua")
 local finalUniqueMap = { }
 local out = io.open("../Data/ModFoulbornMap.lua", "w")
 out:write('-- This file is automatically generated, do not edit!\n')
diff --git a/src/Export/Scripts/mods.lua b/src/Export/Scripts/mods.lua
@@ -310,7 +310,7 @@ local out = io.open("Uniques/ModTextMap.lua", "w")
 local modTextMap = {}
 out:write('-- This file is automatically generated, do not edit!\n')
 out:write('-- Item data (c) Grinding Gear Games\n\nreturn {\n')
-for modName, mod in pairsSortByKey(LoadModule("../Data/ModItemExclusive.lua")) do
+for modName, mod in pairsSortByKey(require("../Data/ModItemExclusive.lua")) do
 	if modTextMap[mod[1]:lower()] then
 		table.insert(modTextMap[mod[1]:lower()], modName)
 	else
diff --git a/src/Export/Scripts/uModsToText.lua b/src/Export/Scripts/uModsToText.lua
@@ -50,7 +50,7 @@ local function writeMods(out, statOrder)
 	end
 end
 
-local uniqueMods = LoadModule("../Data/ModItemExclusive.lua")
+local uniqueMods = require("../Data/ModItemExclusive.lua")
 for _, name in ipairs(itemTypes) do
 	local out = io.open("../Data/Uniques/"..name..".lua", "w")
 	local statOrder = {}
diff --git a/src/Export/Scripts/uTextToMods.lua b/src/Export/Scripts/uTextToMods.lua
@@ -77,8 +77,8 @@ end
 
 local usedMods = {}
 local itemUsedMods = {}
-local modTextMap = LoadModule("Uniques/ModTextMap.lua")
-local uniqueMods = LoadModule("../Data/ModItemExclusive.lua")
+local modTextMap = require("Uniques/ModTextMap.lua")
+local uniqueMods = require("../Data/ModItemExclusive.lua")
 
 for _, name in pairs(itemTypes) do
 	-- Reading the file backward lets us see the most current variant lines first
diff --git a/src/Launch.lua b/src/Launch.lua
@@ -35,7 +35,7 @@ function launch:OnInit()
 		-- Perform an immediate update to download the latest version
 		ConClear()
 		ConPrintf("Please wait while we complete installation...\n")
-		local updateMode, errMsg = LoadModule("UpdateCheck")
+		local updateMode, errMsg = require("UpdateCheck")
 		if not updateMode then
 			self.updateErrMsg = errMsg
 		elseif updateMode ~= "none" then
@@ -325,12 +325,12 @@ end
 function launch:ApplyUpdate(mode)
 	if mode == "basic" then
 		-- Need to revert to the basic environment to fully apply the update
-		LoadModule("UpdateApply", "Update/opFile.txt")
+		require("UpdateApply", "Update/opFile.txt")
 		SpawnProcess(GetRuntimePath()..'/Update', 'UpdateApply.lua Update/opFileRuntime.txt')
 		Exit()
 	elseif mode == "normal" then
 		-- Update can be applied while normal environment is running
-		LoadModule("UpdateApply", "Update/opFile.txt")
+		require("UpdateApply", "Update/opFile.txt")
 		Restart()
 		self.doRestart = "Updating..."
 	end
diff --git a/src/Modules/Build.lua b/src/Modules/Build.lua
@@ -426,7 +426,7 @@ function buildMode:Init(dbFileName, buildName, buildXML, convertBuild, importLin
 	end
 
 	-- List of display stats
-	self.displayStats, self.minionDisplayStats, self.extraSaveStats = LoadModule("Modules/BuildDisplayStats")
+	self.displayStats, self.minionDisplayStats, self.extraSaveStats = require("Modules/BuildDisplayStats")
 
 	-- Controls: Side bar
 	self.anchorSideBar = new("Control"):Control(nil, {4, 60, 0, 0})
diff --git a/src/Modules/BuildList.lua b/src/Modules/BuildList.lua
@@ -7,7 +7,7 @@ local pairs = pairs
 local ipairs = ipairs
 local t_insert = table.insert
 
-local buildListHelpers = LoadModule("Modules/BuildListHelpers")
+local buildListHelpers = require("Modules/BuildListHelpers")
 local buildSortDropList = buildListHelpers.buildSortDropList
 
 local listMode = new("ControlHost"):ControlHost()
diff --git a/src/Modules/Data.lua b/src/Modules/Data.lua
@@ -570,34 +570,34 @@ data.enchantmentSource = {
 LoadModule("Data/Misc", data)
 
 -- Stat descriptions
-data.describeStats = LoadModule("Modules/StatDescriber")
+data.describeStats = require("Modules/StatDescriber")
 
 -- Load item modifiers
 data.itemMods = {
-	Explicit = LoadModule("Data/ModExplicit"),
-	Implicit = LoadModule("Data/ModImplicit"),
-	Corrupted = LoadModule("Data/ModCorrupted"),
-	Delve = LoadModule("Data/ModDelve"),
-	Synthesis = LoadModule("Data/ModSynthesis"),
-	Scourge = LoadModule("Data/ModScourge"),
-	Eldritch = LoadModule("Data/ModEldritch"),
-	Flask = LoadModule("Data/ModFlask"),
-	Tincture = LoadModule("Data/ModTincture"),
-	Graft = LoadModule("Data/ModGraft"),
-	Jewel = LoadModule("Data/ModJewel"),
-	JewelAbyss = LoadModule("Data/ModJewelAbyss"),
-	JewelCluster = LoadModule("Data/ModJewelCluster"),
-	JewelCharm = LoadModule("Data/ModJewelCharm"),
+	Explicit = require("Data/ModExplicit"),
+	Implicit = require("Data/ModImplicit"),
+	Corrupted = require("Data/ModCorrupted"),
+	Delve = require("Data/ModDelve"),
+	Synthesis = require("Data/ModSynthesis"),
+	Scourge = require("Data/ModScourge"),
+	Eldritch = require("Data/ModEldritch"),
+	Flask = require("Data/ModFlask"),
+	Tincture = require("Data/ModTincture"),
+	Graft = require("Data/ModGraft"),
+	Jewel = require("Data/ModJewel"),
+	JewelAbyss = require("Data/ModJewelAbyss"),
+	JewelCluster = require("Data/ModJewelCluster"),
+	JewelCharm = require("Data/ModJewelCharm"),
 }
-data.masterMods = LoadModule("Data/ModMaster")
+data.masterMods = require("Data/ModMaster")
 data.enchantments = {
-	["Helmet"] = LoadModule("Data/EnchantmentHelmet"),
-	["Boots"] = LoadModule("Data/EnchantmentBoots"),
-	["Gloves"] = LoadModule("Data/EnchantmentGloves"),
-	["Belt"] = LoadModule("Data/EnchantmentBelt"),
-	["Body Armour"] = LoadModule("Data/EnchantmentBody"),
-	["Weapon"] = LoadModule("Data/EnchantmentWeapon"),
-	["UtilityFlask"] = LoadModule("Data/EnchantmentFlask"),
+	["Helmet"] = require("Data/EnchantmentHelmet"),
+	["Boots"] = require("Data/EnchantmentBoots"),
+	["Gloves"] = require("Data/EnchantmentGloves"),
+	["Belt"] = require("Data/EnchantmentBelt"),
+	["Body Armour"] = require("Data/EnchantmentBody"),
+	["Weapon"] = require("Data/EnchantmentWeapon"),
+	["UtilityFlask"] = require("Data/EnchantmentFlask"),
 }
 
 -- combined table of many mod categories
@@ -627,13 +627,13 @@ do
 		end
 	end					
 end
-data.essences = LoadModule("Data/Essence")
-data.veiledMods = LoadModule("Data/ModVeiled")
-data.beastCraft = LoadModule("Data/BeastCraft")
-data.necropolisMods = LoadModule("Data/ModNecropolis")
-data.crucible = LoadModule("Data/Crucible")
-data.pantheons = LoadModule("Data/Pantheons")
-data.costs = LoadModule("Data/Costs")
+data.essences = require("Data/Essence")
+data.veiledMods = require("Data/ModVeiled")
+data.beastCraft = require("Data/BeastCraft")
+data.necropolisMods = require("Data/ModNecropolis")
+data.crucible = require("Data/Crucible")
+data.pantheons = require("Data/Pantheons")
+data.costs = require("Data/Costs")
 
 do
 	local map = { }
@@ -642,7 +642,7 @@ do
 	end
 	setmetatable(data.costs, { __index = function(t, k) return t[map[k]] end })
 end
-data.mapMods = LoadModule("Data/ModMap")
+data.mapMods = require("Data/ModMap")
 
 -- Manually seeded modifier tag against item slot table for Mastery Item Condition based modifiers
 -- Data is informed by getTagBasedModifiers() located in Item.lua
@@ -772,7 +772,7 @@ data.itemTagSpecialExclusionPattern = {
 }
 
 -- Cluster jewel data
-data.clusterJewels = LoadModule("Data/ClusterJewels")
+data.clusterJewels = require("Data/ClusterJewels")
 
 -- Create a quick lookup cache from cluster jewel skill to the notables which use that skill
 ---@type table<string, table<string>>
@@ -836,11 +836,11 @@ data.timelessJewelSeedMax = {
 	[5] = 160000 / 20,
 	[6] = 8000,
 }
-data.timelessJewelTradeIDs = LoadModule("Data/TimelessJewelData/LegionTradeIds")
+data.timelessJewelTradeIDs = require("Data/TimelessJewelData/LegionTradeIds")
 data.timelessJewelAdditions = 96 -- #legionAdditions
-data.nodeIDList = LoadModule("Data/TimelessJewelData/NodeIndexMapping")
+data.nodeIDList = require("Data/TimelessJewelData/NodeIndexMapping")
 data.timelessJewelLUTs = { }
-data.readLUT, data.repairLUTs = LoadModule("Modules/DataLegionLookUpTableHelper")
+data.readLUT, data.repairLUTs = require("Modules/DataLegionLookUpTableHelper")
 
 -- this runs if the "size" key is missing from nodeIDList and attempts to rebuild all jewel LUTs and the nodeIDList
 -- note this should only run in dev mode
@@ -875,7 +875,7 @@ do
 		UberEvasionMean = 100 + uberEvasionTotal / uberCount
 	}
 
-	data.bossSkills, data.bossSkillsList = LoadModule("Data/BossSkills")
+	data.bossSkills, data.bossSkillsList = require("Data/BossSkills")
 
 	data.enemyIsBossTooltip = [[Bosses' damage is monster damage scaled to an average damage of their attacks
 This is divided by 4.40 to represent 4 damage types + some (40% as much) ^xD02090chaos
@@ -963,7 +963,7 @@ for skillId, grantedEffect in pairs(data.skills) do
 end
 
 -- Load gems
-data.gems = LoadModule("Data/Gems")
+data.gems = require("Data/Gems")
 data.gemForSkill = { }
 data.gemForBaseName = { }
 data.gemsByGameId = { }
@@ -1099,7 +1099,7 @@ end
 table.sort(data.itemBaseTypeList)
 
 -- Rare templates
-data.rares = LoadModule("Data/Rares")
+data.rares = require("Data/Rares")
 
 data.casterTagCrucibleUniques = {
 	["Atziri's Rule"] = true,
@@ -1150,10 +1150,10 @@ data.uniques = { }
 for _, type in pairs(itemTypes) do
 	data.uniques[type] = LoadModule("Data/Uniques/"..type)
 end
-data.uniques['race'] = LoadModule("Data/Uniques/Special/race")
+data.uniques['race'] = require("Data/Uniques/Special/race")
 data.uniqueMods = { }
 data.uniqueMods["Watcher's Eye"] = { }
-local unsortedMods = LoadModule("Data/Uniques/Special/WatchersEye")
+local unsortedMods = require("Data/Uniques/Special/WatchersEye")
 local sortedMods = { }
 for modId in pairs(unsortedMods) do
 	table.insert(sortedMods, modId)
@@ -1168,4 +1168,4 @@ end
 LoadModule("Data/Uniques/Special/Generated")
 LoadModule("Data/Uniques/Special/New")
 
-data.flavourText = LoadModule("Data/FlavourText")
+data.flavourText = require("Data/FlavourText")
diff --git a/src/Modules/Main.lua b/src/Modules/Main.lua
