Mod docs generator

.gitignore

@@ -24,6 +24,7 @@ Debug/
 DebugIntermediate/
 ImperatorToCK3.UnitTests/obj/
 ImperatorToCK3/obj/
+DocsGenerator/obj/
 Publish/
 
 

DocsGenerator/.editorconfig

@@ -0,0 +1,239 @@
+# Remove the line below if you want to inherit .editorconfig settings from higher directories
+root = true
+
+# C# files
+[*.cs]
+
+#### Core EditorConfig Options ####
+
+# Indentation and spacing
+indent_size = 4
+indent_style = tab
+tab_width = 4
+
+# New line preferences
+end_of_line = crlf
+insert_final_newline = false
+
+#### .NET Coding Conventions ####
+
+# Organize usings
+dotnet_separate_import_directive_groups = false
+dotnet_sort_system_directives_first = false
+file_header_template = unset
+
+# this. and Me. preferences
+dotnet_style_qualification_for_event = false
+dotnet_style_qualification_for_field = false
+dotnet_style_qualification_for_method = false
+dotnet_style_qualification_for_property = false
+
+# Language keywords vs BCL types preferences
+dotnet_style_predefined_type_for_locals_parameters_members = true
+dotnet_style_predefined_type_for_member_access = true
+
+# Parentheses preferences
+dotnet_style_parentheses_in_arithmetic_binary_operators = always_for_clarity
+dotnet_style_parentheses_in_other_binary_operators = always_for_clarity
+dotnet_style_parentheses_in_other_operators = never_if_unnecessary
+dotnet_style_parentheses_in_relational_binary_operators = always_for_clarity
+
+# Modifier preferences
+dotnet_style_require_accessibility_modifiers = for_non_interface_members
+
+# Expression-level preferences
+dotnet_style_coalesce_expression = true
+dotnet_style_collection_initializer = true
+dotnet_style_explicit_tuple_names = true
+dotnet_style_namespace_match_folder = true
+dotnet_style_null_propagation = true
+dotnet_style_object_initializer = true
+dotnet_style_operator_placement_when_wrapping = beginning_of_line
+dotnet_style_prefer_auto_properties = true
+dotnet_style_prefer_compound_assignment = true
+dotnet_style_prefer_conditional_expression_over_assignment = true
+dotnet_style_prefer_conditional_expression_over_return = true
+dotnet_style_prefer_inferred_anonymous_type_member_names = true
+dotnet_style_prefer_inferred_tuple_names = true
+dotnet_style_prefer_is_null_check_over_reference_equality_method = true
+dotnet_style_prefer_simplified_boolean_expressions = true
+dotnet_style_prefer_simplified_interpolation = true
+
+# Field preferences
+dotnet_style_readonly_field = true
+
+# Parameter preferences
+dotnet_code_quality_unused_parameters = all
+
+# Suppression preferences
+dotnet_remove_unnecessary_suppression_exclusions = none
+
+# New line preferences
+dotnet_style_allow_multiple_blank_lines_experimental = true
+dotnet_style_allow_statement_immediately_after_block_experimental = true
+
+#### C# Coding Conventions ####
+
+# var preferences
+csharp_style_var_elsewhere = false
+csharp_style_var_for_built_in_types = false
+csharp_style_var_when_type_is_apparent = false
+
+# Expression-bodied members
+csharp_style_expression_bodied_accessors = true:silent
+csharp_style_expression_bodied_constructors = false:silent
+csharp_style_expression_bodied_indexers = true:silent
+csharp_style_expression_bodied_lambdas = true:silent
+csharp_style_expression_bodied_local_functions = false:silent
+csharp_style_expression_bodied_methods = false:silent
+csharp_style_expression_bodied_operators = false:silent
+csharp_style_expression_bodied_properties = true:silent
+
+# Pattern matching preferences
+csharp_style_pattern_matching_over_as_with_null_check = true
+csharp_style_pattern_matching_over_is_with_cast_check = true
+csharp_style_prefer_not_pattern = true
+csharp_style_prefer_pattern_matching = true
+csharp_style_prefer_switch_expression = true
+
+# Null-checking preferences
+csharp_style_conditional_delegate_call = true:suggestion
+
+# Modifier preferences
+csharp_prefer_static_local_function = true
+csharp_preferred_modifier_order = public,private,protected,internal,static,extern,new,virtual,abstract,sealed,override,readonly,unsafe,volatile,async
+
+# Code-block preferences
+csharp_prefer_braces = true:silent
+csharp_prefer_simple_using_statement = true:suggestion
+
+# Expression-level preferences
+csharp_prefer_simple_default_expression = true
+csharp_style_deconstructed_variable_declaration = true
+csharp_style_implicit_object_creation_when_type_is_apparent = true
+csharp_style_inlined_variable_declaration = true
+csharp_style_pattern_local_over_anonymous_function = true
+csharp_style_prefer_index_operator = true
+csharp_style_prefer_range_operator = true
+csharp_style_throw_expression = true
+csharp_style_unused_value_assignment_preference = discard_variable
+csharp_style_unused_value_expression_statement_preference = discard_variable
+
+# 'using' directive preferences
+csharp_using_directive_placement = outside_namespace:silent
+
+# New line preferences
+csharp_style_allow_blank_line_after_colon_in_constructor_initializer_experimental = true
+csharp_style_allow_blank_lines_between_consecutive_braces_experimental = true
+csharp_style_allow_embedded_statements_on_same_line_experimental = true
+
+#### C# Formatting Rules ####
+
+# New line preferences
+csharp_new_line_before_catch = false
+csharp_new_line_before_else = false
+csharp_new_line_before_finally = false
+csharp_new_line_before_members_in_anonymous_types = true
+csharp_new_line_before_members_in_object_initializers = true
+csharp_new_line_before_open_brace = none
+csharp_new_line_between_query_expression_clauses = true
+
+# Indentation preferences
+csharp_indent_block_contents = true
+csharp_indent_braces = false
+csharp_indent_case_contents = true
+csharp_indent_case_contents_when_block = true
+csharp_indent_labels = one_less_than_current
+csharp_indent_switch_labels = true
+
+# Space preferences
+csharp_space_after_cast = false
+csharp_space_after_colon_in_inheritance_clause = true
+csharp_space_after_comma = true
+csharp_space_after_dot = false
+csharp_space_after_keywords_in_control_flow_statements = true
+csharp_space_after_semicolon_in_for_statement = true
+csharp_space_around_binary_operators = before_and_after
+csharp_space_around_declaration_statements = false
+csharp_space_before_colon_in_inheritance_clause = true
+csharp_space_before_comma = false
+csharp_space_before_dot = false
+csharp_space_before_open_square_brackets = false
+csharp_space_before_semicolon_in_for_statement = false
+csharp_space_between_empty_square_brackets = false
+csharp_space_between_method_call_empty_parameter_list_parentheses = false
+csharp_space_between_method_call_name_and_opening_parenthesis = false
+csharp_space_between_method_call_parameter_list_parentheses = false
+csharp_space_between_method_declaration_empty_parameter_list_parentheses = false
+csharp_space_between_method_declaration_name_and_open_parenthesis = false
+csharp_space_between_method_declaration_parameter_list_parentheses = false
+csharp_space_between_parentheses = false
+csharp_space_between_square_brackets = false
+
+# Wrapping preferences
+csharp_preserve_single_line_blocks = true
+csharp_preserve_single_line_statements = true
+
+#### Naming styles ####
+
+# Naming rules
+
+dotnet_naming_rule.interface_should_be_begins_with_i.severity = suggestion
+dotnet_naming_rule.interface_should_be_begins_with_i.symbols = interface
+dotnet_naming_rule.interface_should_be_begins_with_i.style = begins_with_i
+
+dotnet_naming_rule.types_should_be_pascal_case.severity = suggestion
+dotnet_naming_rule.types_should_be_pascal_case.symbols = types
+dotnet_naming_rule.types_should_be_pascal_case.style = pascal_case
+
+dotnet_naming_rule.non_field_members_should_be_pascal_case.severity = suggestion
+dotnet_naming_rule.non_field_members_should_be_pascal_case.symbols = non_field_members
+dotnet_naming_rule.non_field_members_should_be_pascal_case.style = pascal_case
+
+# Symbol specifications
+
+dotnet_naming_symbols.interface.applicable_kinds = interface
+dotnet_naming_symbols.interface.applicable_accessibilities = public, internal, private, protected, protected_internal, private_protected
+dotnet_naming_symbols.interface.required_modifiers = 
+
+dotnet_naming_symbols.types.applicable_kinds = class, struct, interface, enum
+dotnet_naming_symbols.types.applicable_accessibilities = public, internal, private, protected, protected_internal, private_protected
+dotnet_naming_symbols.types.required_modifiers = 
+
+dotnet_naming_symbols.non_field_members.applicable_kinds = property, event, method
+dotnet_naming_symbols.non_field_members.applicable_accessibilities = public, internal, private, protected, protected_internal, private_protected
+dotnet_naming_symbols.non_field_members.required_modifiers = 
+
+# Naming styles
+
+dotnet_naming_style.pascal_case.required_prefix = 
+dotnet_naming_style.pascal_case.required_suffix = 
+dotnet_naming_style.pascal_case.word_separator = 
+dotnet_naming_style.pascal_case.capitalization = pascal_case
+
+dotnet_naming_style.begins_with_i.required_prefix = I
+dotnet_naming_style.begins_with_i.required_suffix = 
+dotnet_naming_style.begins_with_i.word_separator = 
+dotnet_naming_style.begins_with_i.capitalization = pascal_case
+csharp_style_namespace_declarations = file_scoped:suggestion
+csharp_style_prefer_method_group_conversion = true:silent
+
+[*.{cs,vb}]
+dotnet_style_operator_placement_when_wrapping = beginning_of_line
+tab_width = 4
+indent_size = 4
+end_of_line = crlf
+dotnet_style_coalesce_expression = true:suggestion
+dotnet_style_null_propagation = true:suggestion
+dotnet_style_prefer_is_null_check_over_reference_equality_method = true:suggestion
+dotnet_style_prefer_auto_properties = true:silent
+dotnet_style_object_initializer = true:suggestion
+dotnet_style_collection_initializer = true:suggestion
+dotnet_style_prefer_conditional_expression_over_assignment = true:silent
+dotnet_style_prefer_conditional_expression_over_return = true:silent
+dotnet_style_explicit_tuple_names = true:suggestion
+dotnet_style_prefer_inferred_tuple_names = true:suggestion
+dotnet_style_prefer_inferred_anonymous_type_member_names = true:suggestion
+dotnet_style_namespace_match_folder = true:suggestion
+dotnet_style_parentheses_in_other_binary_operators = always_for_clarity:silent
+dotnet_style_parentheses_in_relational_binary_operators = always_for_clarity:silent

DocsGenerator/CulturesDocGenerator.cs

@@ -0,0 +1,109 @@
+using commonItems;
+using commonItems.Collections;
+using commonItems.Localization;
+using ImperatorToCK3.CK3.Cultures;
+
+namespace DocsGenerator;
+
+public static class CulturesDocGenerator {
+	private static IEnumerable<Culture> LoadCultures(string modPath) {
+		Logger.Info("Loading cultures...");
+		var culturesPath = Path.Combine(modPath, "common/culture/cultures");
+		var files = SystemUtils.GetAllFilesInFolderRecursive(culturesPath)
+			.Where(f => CommonFunctions.GetExtension(f) == "txt");
+
+		var cultures = new IdObjectCollection<string, Culture>();
+		var parser = new Parser();
+		parser.RegisterRegex(CommonRegexes.String, (reader, cultureId) => {
+			var culture = new Culture(cultureId, reader);
+			cultures.AddOrReplace(culture);
+		});
+		parser.IgnoreAndLogUnregisteredItems();
+
+		foreach (var relativePath in files) {
+			var filePath = Path.Join(culturesPath, relativePath);
+			parser.ParseFile(filePath);
+		}
+
+		return cultures;
+	}
+
+	private static string GetLocForKey(LocDB locDB, string locKey) {
+		var locBlock = locDB.GetLocBlockForKey(locKey);
+		if (locBlock is null) {
+			Logger.Warn($"No localization found for \"{locKey}\"");
+			return locKey;
+		}
+
+		var englishLoc = locBlock["english"];
+		if (englishLoc is null) {
+			Logger.Warn($"No English localization found for \"{locKey}\"");
+			return locKey;
+		}
+
+		// Check for nested loc.
+		var dollarPos = englishLoc.IndexOf('$');
+		if (dollarPos != -1) {
+			var secondDollarPos = englishLoc.IndexOf('$', dollarPos + 1);
+			if (secondDollarPos != -1) {
+				var nesting = englishLoc.Substring(dollarPos, secondDollarPos - dollarPos + 1);
+				var nestedLocKey = nesting.Trim('$');
+				englishLoc = englishLoc.Replace(nesting, GetLocForKey(locDB, nestedLocKey));
+			}
+		}
+		return englishLoc;
+	}
+
+	private static void OutputCulturesTable(IEnumerable<Culture> cultures, LocDB locDB) {
+		Logger.Info("Outputting cultures table...");
+		using var output = new StringWriter();
+
+		output.WriteLine("""
+		<style type="text/css">
+		.tg  {border-collapse:collapse;border-spacing:0;}
+		.tg td{border-color:black;border-style:solid;border-width:1px;font-family:Arial, sans-serif;font-size:14px;
+			overflow:hidden;padding:10px 5px;word-break:normal;text-align:left;vertical-align:top;}
+		.tg th{border-color:black;border-style:solid;border-width:1px;font-family:Arial, sans-serif;font-size:14px;
+			font-weight:normal;overflow:hidden;padding:10px 5px;word-break:normal;text-align:left;vertical-align:top;}
+
+		</style>
+		""");
+		output.WriteLine("<html>");
+		output.WriteLine("\t<body>");
+		output.WriteLine("\t\t<table class=\"tg\">");
+		output.WriteLine("""
+			<thead>
+				<tr>
+					<th>Culture</th>
+					<th>Heritage</th>
+					<th>Ethos</th>
+					<th>Traditions</th>
+					<th>Language</th>
+					<th>Martial custom</th>
+				</tr>
+			</thead>
+		""");
+		output.WriteLine("\t\t\t<tbody>");
+		foreach (var culture in cultures) {
+			output.WriteLine("\t\t\t\t<tr>");
+			output.WriteLine($"\t\t\t\t\t<td>{GetLocForKey(locDB, culture.Id)}</td>");
+			output.WriteLine($"\t\t\t\t\t<td>{GetLocForKey(locDB, $"{culture.HeritageId}_name")}</td>");
+			output.WriteLine($"\t\t\t\t\t<td>{GetLocForKey(locDB, $"{culture.EthosId}_name")}</td>");
+			output.WriteLine($"\t\t\t\t\t<td>{string.Join("<br>", culture.Traditions.Select(t=>GetLocForKey(locDB, $"{t}_name")))}</td>");
+			output.WriteLine($"\t\t\t\t\t<td>{GetLocForKey(locDB, $"{culture.LanguageId}_name")}</td>");
+			output.WriteLine($"\t\t\t\t\t<td>{GetLocForKey(locDB, $"{culture.MartialCustomId}_name")}</td>");
+			output.WriteLine("\t\t\t\t</tr>");
+		}
+		output.WriteLine("\t\t\t</tbody>");
+		output.WriteLine("\t\t</table>");
+		output.WriteLine("\t</body>");
+		output.WriteLine("</html>");
+
+		File.WriteAllText ("generated_docs/cultures_table.html", output.ToString());
+	}
+
+    public static void GenerateCulturesTable(string modPath, LocDB locDB) {
+	    var cultures = LoadCultures(modPath);
+	    OutputCulturesTable(cultures, locDB);
+    }
+}

DocsGenerator/DocsGenerator.csproj

@@ -0,0 +1,19 @@
+<Project Sdk="Microsoft.NET.Sdk">
+
+    <PropertyGroup>
+        <OutputType>Exe</OutputType>
+        <TargetFramework>net7.0</TargetFramework>
+        <ImplicitUsings>enable</ImplicitUsings>
+        <Nullable>enable</Nullable>
+        <IsPackable>false</IsPackable>
+    </PropertyGroup>
+
+    <ItemGroup>
+      <ProjectReference Include="..\ImperatorToCK3\ImperatorToCK3.csproj" />
+    </ItemGroup>
+
+    <ItemGroup>
+      <PackageReference Include="CommandLineParser" Version="2.9.1" />
+    </ItemGroup>
+
+</Project>

DocsGenerator/Options.cs

@@ -0,0 +1,13 @@
+using CommandLine;
+
+namespace DocsGenerator; 
+
+public class Options {
+	[Option('r', "gameRoot", Required = true,
+		HelpText = "CK3 game root path, for example \"C:/SteamLibrary/steamapps/common/Crusader Kings III/game\".")]
+	public string GameRoot { get; set; } = Directory.GetCurrentDirectory();
+
+	[Option('m', "modPath", Required = true,
+		HelpText = "Path to mod directory, for example \"C:/Users/User/Documents/Paradox Interactive/Crusader Kings III/mod/test_mod\"")]
+	public string ModPath { get; set; } = Directory.GetCurrentDirectory();
+}