Merge branch 'develop' into improve_static_typing_and_style

Author: Qubus0

addons/mod_loader/mod_data.gd

@@ -45,24 +45,22 @@ func load_manifest() -> void:
 	# Load meta data file
 	var manifest_path := get_required_mod_file_path(required_mod_files.MANIFEST)
 	var manifest_dict := ModLoaderUtils.get_json_as_dict(manifest_path)
-
 	ModLoaderUtils.log_debug_json_print("%s loaded manifest data -> " % dir_name, manifest_dict, LOG_NAME)
 
 	var mod_manifest := ModManifest.new(manifest_dict)
 
-	if not mod_manifest:
-		is_loadable = false
-		return
-
+	is_loadable = has_manifest(mod_manifest)
+	if not is_loadable: return
+	is_loadable = is_mod_dir_name_same_as_id(mod_manifest)
+	if not is_loadable: return
 	manifest = mod_manifest
 
 
 # Validates if [member dir_name] matches [method ModManifest.get_mod_id]
-func is_mod_dir_name_same_as_id() -> bool:
-	var manifest_id := manifest.get_mod_id()
+func is_mod_dir_name_same_as_id(mod_manifest: ModManifest) -> bool:
+	var manifest_id := mod_manifest.get_mod_id()
 	if not dir_name == manifest_id:
-		ModLoaderUtils.log_fatal('Mod directory name "%s" does not match the data in manifest.json. Expected "%s"' % [ dir_name, manifest_id ], LOG_NAME)
-		is_loadable = false
+		ModLoaderUtils.log_fatal('Mod directory name "%s" does not match the data in manifest.json. Expected "%s" (Format: {namespace}-{name})' % [ dir_name, manifest_id ], LOG_NAME)
 		return false
 	return true
 
@@ -81,8 +79,11 @@ func has_required_files() -> bool:
 
 
 # Validates if manifest is set
-func has_manifest() -> bool:
-	return not manifest == null
+func has_manifest(mod_manifest: ModManifest) -> bool:
+	if mod_manifest == null:
+		ModLoaderUtils.log_fatal("Mod manifest could not be created correctly due to errors.", LOG_NAME)
+		return false
+	return true
 
 
 # Converts enum indices [member required_mod_files] into their respective file paths

addons/mod_loader/mod_loader_utils.gd

@@ -56,9 +56,7 @@ static func log_debug_json_print(message: String, json_printable, mod_name: Stri
 
 
 static func _loader_log(message: String, mod_name: String, log_type: String = "info") -> void:
-	var ignored_arg := get_cmd_line_arg_value("--log-ignore")
-	var ignored_names: Array = str2var(ignored_arg)
-	if ignored_names and mod_name in ignored_names:
+	if is_mod_name_ignored(mod_name):
 		return
 
 	var date := "%s   " % get_date_time_string()
@@ -89,6 +87,16 @@ static func _loader_log(message: String, mod_name: String, log_type: String = "i
 				_write_to_log_file(log_message)
 
 
+static func is_mod_name_ignored(mod_name: String) -> bool:
+	var ignored_arg := get_cmd_line_arg_value("--log-ignore")
+
+	if not ignored_arg == "":
+		var ignored_names: Array = ignored_arg.split(",")
+		if mod_name in ignored_names:
+			return true
+	return false
+
+
 static func _write_to_log_file(log_entry: String) -> void:
 	var log_file := File.new()
 

addons/mod_loader/mod_manifest.gd

@@ -2,6 +2,7 @@ extends Resource
 # Stores and validates contents of the manifest set by the user
 class_name ModManifest
 
+const LOG_NAME := "ModLoader:ModManifest"
 
 # Mod name.
 # Validated by [method is_name_or_namespace_valid]
@@ -95,33 +96,41 @@ func get_package_id() -> String:
 
 # A valid namespace may only use letters (any case), numbers and underscores
 # and has to be longer than 3 characters
-# /^[a-zA-Z0-9_]{3,}$/
+# a-z A-Z 0-9 _ (longer than 3 characters)
 static func is_name_or_namespace_valid(name: String) -> bool:
 	var re := RegEx.new()
 	re.compile("^[a-zA-Z0-9_]*$") # alphanumeric and _
 
 	if re.search(name) == null:
-		printerr('Invalid name or namespace: "%s". You may only use letters, numbers and underscores.' % name)
+		ModLoaderUtils.log_fatal('Invalid name or namespace: "%s". You may only use letters, numbers and underscores.' % name, LOG_NAME)
 		return false
 
 	re.compile("^[a-zA-Z0-9_]{3,}$") # at least 3 long
 	if re.search(name) == null:
-		printerr('Invalid name or namespace: "%s". Must be longer than 3 characters.' % name)
+		ModLoaderUtils.log_fatal('Invalid name or namespace: "%s". Must be longer than 3 characters.' % name, LOG_NAME)
 		return false
 
 	return true
 
 
 # A valid semantic version should follow this format: {mayor}.{minor}.{patch}
 # reference https://semver.org/ for details
-# /^[0-9]+\\.[0-9]+\\.[0-9]+$/
+# {0-9}.{0-9}.{0-9} (no leading 0, shorter than 16 characters total)
 static func is_semver_valid(version_number: String) -> bool:
 	var re := RegEx.new()
-	re.compile("^[0-9]+\\.[0-9]+\\.[0-9]+$")
+	re.compile("^(0|[1-9][0-9]*)\\.(0|[1-9][0-9]*)\\.(0|[1-9][0-9]*)$")
 
 	if re.search(version_number) == null:
-		printerr('Invalid semantic version: "%s". ' +
-		'You may only use numbers and periods in this format {mayor}.{minor}.{patch}' % version_number)
+		ModLoaderUtils.log_fatal('Invalid semantic version: "%s". ' +
+			'You may only use numbers without leading zero and periods following this format {mayor}.{minor}.{patch}' % version_number,
+			LOG_NAME
+		)
+		return false
+
+	if version_number.length() > 16:
+		ModLoaderUtils.log_fatal('Invalid semantic version: "%s". ' +
+			'Version number must be shorter than 16 characters.', LOG_NAME
+		)
 		return false
 
 	return true
@@ -151,7 +160,7 @@ static func dict_has_fields(dict: Dictionary, required_fields: Array) -> bool:
 			missing_fields.erase(key)
 
 	if missing_fields.size() > 0:
-		printerr("Mod data is missing required fields: " + str(missing_fields))
+		ModLoaderUtils.log_fatal("Mod manifest is missing required fields: %s" % missing_fields, LOG_NAME)
 		return false
 
 	return true