refactor: Reorganize code (& temporarily remove comments)

Author: JordanViknar

rokit.toml

@@ -8,3 +8,4 @@ lune = "lune-org/[email protected]"
 darklua = "seaofvoices/[email protected]"
 selene = "Kampfkarren/[email protected]"
 StyLua = "JohnnyMorganz/[email protected]"
+wally = "UpliftGames/[email protected]"

src/Classes/SteamApp.luau

@@ -3,12 +3,10 @@ local process = require("@lune/process")
 
 local Metadata = require("../Metadata")
 
--- Constants
-local steamImageLocation = process.env.HOME .. "/.local/share/Steam/appcache/librarycache/"
-
 local SteamApp = {}
 
 SteamApp.Interface = {}
+SteamApp.Prototype = {}
 
 function SteamApp.Interface.new(
 	appID: number,
@@ -36,7 +34,7 @@ function SteamApp.Interface.new(
 	-- What type is the app ?
 	-- Current way of detecting if an app is a game or a tool... not the greatest.
 	local type: "Game" | "Other" | "Proton" = "Game"
-	if not fs.metadata(steamImageLocation .. appID .. "_library_600x900.jpg").exists then
+	if not fs.metadata(process.env.HOME .. "/.local/share/Steam/appcache/librarycache/" .. appID .. "_library_600x900.jpg").exists then
 		type = "Other"
 		if name:find("Proton") then
 			type = "Proton"

src/Configuration/Games/init.luau renamed to src/Configuration/Games/Functions.luau

@@ -1,3 +1,3 @@
 return {
-	Games = require("./Games")
+	Games = require("./Games/Functions")
 }

src/Configuration/init.luau

@@ -1,10 +1,6 @@
 local process = require("@lune/process")
 
---[=[
-	@class Metadata
-	Application constants used throughout the program.
-]=]
-local Metadata = {
+return {
 	name = "STweaks",
 	description = "A work-in-progress fast, simple and modern Libadwaita alternative to SteamTinkerLaunch.",
 	version = "indev",
@@ -16,5 +12,3 @@ local Metadata = {
 		cache = process.env.HOME .. "/.cache/Stweaks",
 	},
 }
-
-return Metadata

src/Metadata/init.luau

@@ -9,9 +9,39 @@ local SteamUtilities = require("./Utilities")
 local VDFParser = require("./VDFParser")
 local SteamApp = require("../Classes").SteamApp
 
+local function VDFHandler(filePath: string, errorMessage: string, logging: boolean?): any
+	if logging == nil then
+		logging = true
+	end
+
+	local timeStart
+	if logging then
+		timeStart = os.clock()
+		Logging.write("data", "Parsing VDF file : " .. filePath)
+	end
+
+	local result, parsedData = pcall(VDFParser.parseFile, filePath)
+	if not result then
+		error(errorMessage)
+	else
+		if logging then
+			Logging.write("speed", timeStart)
+		end
+		return parsedData
+	end
+end
+
+local function getMostRecentUserID(userData: loginusers_vdf): number
+	for id, data in pairs(userData.users) do
+		if data.MostRecent == 1 then
+			return id
+		end
+	end
+	error("No most recent user found in loginusers.vdf. What ?!")
+end
+
 -- --------------------------- Definitions -----------------------------
 
--- Steam files
 -- Note : Most of the entries are unused and simply for informative purposes.
 
 type loginusers_vdf = {
@@ -137,19 +167,14 @@ type compat_vdf = {
 
 local Configuration = {}
 
-Configuration.Private = {}
-Configuration.Public = {}
-
--- Public
-
-function Configuration.Public.getSteamConfiguration()
+function Configuration.getSteamConfiguration()
 	--[[
 		Chapter 1 : We recover the Steam user config so we can get the last active user.
 		And also the SteamID3 to access their settings folder.
 	]]
 	local userConfiguration: loginusers_vdf =
-		Configuration.Private.VDFHandler(process.env.HOME .. "/.local/share/Steam/config/loginusers.vdf", "Failed to parse loginusers.vdf file.")
-	local activeUserSteamID3 = SteamUtilities.convertToSteamID3(Configuration.Private.getMostRecentUserID(userConfiguration))
+		VDFHandler(process.env.HOME .. "/.local/share/Steam/config/loginusers.vdf", "Failed to parse loginusers.vdf file.")
+	local activeUserSteamID3 = SteamUtilities.convertToSteamID3(getMostRecentUserID(userConfiguration))
 	Logging.write("info", "Active user SteamID3 : " .. activeUserSteamID3)
 	Logging.separator()
 
@@ -158,7 +183,7 @@ function Configuration.Public.getSteamConfiguration()
 
 		Note : Error handling should be added for the scenario where the configuration can't be loaded.
 	]]
-	local localconfig_vdf: localconfig_vdf = Configuration.Private.VDFHandler(
+	local localconfig_vdf: localconfig_vdf = VDFHandler(
 		process.env.HOME .. "/.local/share/Steam/userdata/" .. activeUserSteamID3 .. "/config/localconfig.vdf",
 		"Failed to parse active user localconfig.vdf file with SteamID3: " .. activeUserSteamID3
 	)
@@ -171,7 +196,7 @@ function Configuration.Public.getSteamConfiguration()
 		We can't use it directly to get the platform details, as games that have previously used Proton will still be set to "windows" here.
 		Logically, a game completely absent from this list is a native Linux game.
 	]]
-	local compat_vdf: compat_vdf = Configuration.Private.VDFHandler(
+	local compat_vdf: compat_vdf = VDFHandler(
 		process.env.HOME .. "/.local/share/Steam/userdata/" .. activeUserSteamID3 .. "/config/compat.vdf",
 		"Failed to parse compat.vdf file."
 	)
@@ -183,7 +208,7 @@ function Configuration.Public.getSteamConfiguration()
 		We can't use just libraryfolders.vdf to get the game IDs, as Steam seems to not always update it immediately.
 	]]
 	local libraries: libraryfolders_vdf =
-		Configuration.Private.VDFHandler(process.env.HOME .. "/.local/share/Steam/config/libraryfolders.vdf", "Failed to parse libraryfolders.vdf file.")
+		VDFHandler(process.env.HOME .. "/.local/share/Steam/config/libraryfolders.vdf", "Failed to parse libraryfolders.vdf file.")
 	Logging.write("info", "Steam libraries loaded.")
 	Logging.separator()
 
@@ -200,7 +225,7 @@ function Configuration.Public.getSteamConfiguration()
 
 			Async.asyncForEach(appManifestFilenames, function(_, appManifestFilename)
 				local appManifestPath: string = library.path .. "/steamapps/" .. appManifestFilename
-				local appManifest: appmanifest_vdf = Configuration.Private.VDFHandler(appManifestPath, "Failed to parse " .. appManifestPath .. ".", false)
+				local appManifest: appmanifest_vdf = VDFHandler(appManifestPath, "Failed to parse " .. appManifestPath .. ".", false)
 
 				Logging.write("info", 'Found "' .. appManifest.AppState.name .. '" (' .. appManifest.AppState.appid .. ")")
 
@@ -247,39 +272,4 @@ function Configuration.Public.getSteamConfiguration()
 	return steamApps
 end
 
--- Private
-
-function Configuration.Private.VDFHandler(filePath: string, errorMessage: string, logging: boolean?): any
-	if logging == nil then
-		logging = true
-	end
-
-	local timeStart
-	if logging then
-		timeStart = os.clock()
-		Logging.write("data", "Parsing VDF file : " .. filePath)
-	end
-
-	local result, parsedData = pcall(VDFParser.parseFile, filePath)
-	if not result then
-		error(errorMessage)
-	else
-		if logging then
-			Logging.write("speed", timeStart)
-		end
-		return parsedData
-	end
-end
-
--- loginuser.vdf
-
-function Configuration.Private.getMostRecentUserID(userData: loginusers_vdf): number
-	for id, data in pairs(userData.users) do
-		if data.MostRecent == 1 then
-			return id
-		end
-	end
-	error("No most recent user found in loginusers.vdf. What ?!")
-end
-
-return Configuration.Public
+return Configuration

src/Steam/Configuration.luau

@@ -1,18 +1,7 @@
 local process = require("@lune/process")
 
---[=[
-	@class Utilities
-
-	Minor Steam-related helper functions.
-]=]
 local Utilities = {}
 
---[=[
-	Checks if the arguments are from Steam or not.
-	Non-Steam game support later on will probably necessitate changes.
-
-	@return number -- Returns the launched AppID if the arguments are from Steam, otherwise nil.
-]=]
 function Utilities.isSteamLaunch(): number?
 	local appIDArgumentIndex
 	for index, argument in ipairs(process.args) do
@@ -30,12 +19,6 @@ function Utilities.isSteamLaunch(): number?
 	end
 end
 
---[=[
-	Converts SteamID64 to SteamID3.
-
-	@param steamID64 number -- The SteamID64 to convert.
-	@return number -- Returns the corresponding SteamID3.
-]=]
 function Utilities.convertToSteamID3(steamID64: number): number
 	local offset_id = steamID64 - 76561197960265728
 	local account_type = offset_id % 2

src/Steam/Utilities.luau

@@ -1,48 +1,9 @@
 local fs = require("@lune/fs")
 
---[=[
-	Contains functions for parsing VDF files and strings.
-	Lune does not support VDF files natively.
-]=]
-local VDFParser = {}
-
-VDFParser.Private = {}
-VDFParser.Public = {}
-
--- ---------------------------------- Public
-
---[=[
-	Parses a VDF file into a table.
-
-	@param path string -- The path to the file.
-	@return The parsed file if successful.
-]=]
-function VDFParser.Public.parseFile(path: string)
-	return VDFParser.Public.parseString(fs.readFile(path))
-end
-
---[=[
-	Parses a VDF string into a table.
-
-	@param input string -- The VDF string to parse.
-	@return The parsed table if successful.
-]=]
-function VDFParser.Public.parseString(input: string)
-	return VDFParser.Private.sanitize(VDFParser.Private.parse(input))
-end
-
--- ---------------------------------- Private
-
 type VDFTable = { [string]: VDFValue }
 type VDFValue = string | VDFTable
 
---[=[
-	Parses a VDF string into a table. Private side of the parser.
-
-	@param input The VDF string to parse.
-	@return The parsed table if successful.
-]=]
-function VDFParser.Private.parse(input: string): VDFTable
+local function parseVDFData(input: string): VDFTable
 	-- Trim function to remove whitespace
 	local function trim(s: string): string?
 		return s:match("^%s*(.-)%s*$")
@@ -142,48 +103,46 @@ function VDFParser.Private.parse(input: string): VDFTable
 	return currentTable
 end
 
---[=[
-	Sanitizes a VDF table by converting string values to their proper types.
+local function sanitizeVDFTable(input: VDFTable)
+	local function convertValue(value: any): any
+		if type(value) == "string" then
+			-- Check for number values (integers or floats)
+			local numberValue = tonumber(value)
+			if numberValue ~= nil then
+				return numberValue
+			end
+			-- Check for empty strings
+			if value == "" then
+				return nil
+			end
+			-- If it's neither, return the original string
+			return value
+		elseif type(value) == "table" then
+			-- Recursively sanitize nested tables
+			return sanitizeVDFTable(value)
+		else
+			-- Return the value as-is for unsupported types (shouldn't happen in a VDF)
+			return value
+		end
+	end
 
-	@param input -- The VDF table to sanitize.
-	@return The sanitized table.
-]=]
-function VDFParser.Private.sanitize(input: VDFTable)
 	local result = {}
-
 	for key, value in pairs(input) do
-		result[VDFParser.Private.convertValue(key)] = VDFParser.Private.convertValue(value)
+		result[convertValue(key)] = convertValue(value)
 	end
 
 	return result
 end
 
---[=[
-	Converts a VDF value to its proper type.
-
-	@param value -- The value to convert.
-	@return The converted value.
-]=]
-function VDFParser.Private.convertValue(value: any): any
-	if type(value) == "string" then
-		-- Check for number values (integers or floats)
-		local numberValue = tonumber(value)
-		if numberValue ~= nil then
-			return numberValue
-		end
-		-- Check for empty strings
-		if value == "" then
-			return nil
-		end
-		-- If it's neither, return the original string
-		return value
-	elseif type(value) == "table" then
-		-- Recursively sanitize nested tables
-		return VDFParser.Private.sanitize(value)
-	else
-		-- Return the value as-is for unsupported types (shouldn't happen in a VDF)
-		return value
-	end
+
+local VDFParser = {}
+
+function VDFParser.parseFile(path: string)
+	return VDFParser.parseString(fs.readFile(path))
+end
+
+function VDFParser.parseString(input: string)
+	return sanitizeVDFTable(parseVDFData(input))
 end
 
-return VDFParser.Public
+return VDFParser

src/Steam/VDFParser.luau

@@ -1,18 +1,7 @@
 local task = require("@lune/task")
 
---[=[
-	@class Utilities.Async
-]=]
 local Async = {}
 
---[=[
-	Executes a function in parallel over all elements in a table.
-	It's similar to Rust's rayon.
-	Pretty big upgrade compared to the previous implementation.
-
-	@param tbl The table to iterate over.
-	@param func The function to execute in parallel for each element.
-]=]
 function Async.asyncForEach(tbl: { any }, func: (any, any) -> ())
 	local total = 0
 	local completed = 0