Add support for character description

Author: rampaa

VndbCharacterNames/Program.cs

@@ -18,13 +18,15 @@ public static void Main(string[] args)
         bool shouldAddDefinition = true;
         bool createAliasEntries = true;
         VndbSpoilerLevel maxSpoilerLevelForAliases = VndbSpoilerLevel.No;
+        bool includeSpoilersInDescription = false;
         string? pathOfCharacterImages = null;
         bool addDefinitionToOneWordNames = false;
         bool addDefinitionToGivenNames = false;
         bool addDefinitionToSurnames = false;
+        bool addDescriptionToDefinition = false;
 
         bool validArgs = false;
-        if (args.Length >= 8)
+        if (args.Length >= 9)
         {
             string jsonFolderPath = args[0].Trim('"', ' ');
             if (!Directory.Exists(jsonFolderPath))
@@ -81,6 +83,21 @@ public static void Main(string[] args)
                             if (result is not null)
                             {
                                 shouldAddDefinition = result.Value;
+
+                                result = GetBoolArgValue(args, "--add-description-to-definition", 2);
+                                if (result is not null)
+                                {
+                                    addDescriptionToDefinition = result.Value;
+                                    if (addDescriptionToDefinition)
+                                    {
+                                        result = GetBoolArgValue(args, "--include-spoilers-in-description", 2);
+                                        if (result is not null)
+                                        {
+                                            includeSpoilersInDescription = result.Value;
+                                        }
+                                    }
+                                }
+
                                 result = GetBoolArgValue(args, "--add-character-details-to-one-word-full-names", 2);
                                 if (result is not null)
                                 {
@@ -177,6 +194,12 @@ public static void Main(string[] args)
             shouldAddDefinition = GetAnswerOfYesNoQuestion("Add character details (age, height, etc.) to the definition of full names? Y/N");
             if (shouldAddDefinition)
             {
+                addDescriptionToDefinition = GetAnswerOfYesNoQuestion("Add character description to the definition? Y/N");
+                if (addDescriptionToDefinition)
+                {
+                    includeSpoilersInDescription = GetAnswerOfYesNoQuestion("Include spoilers in the description? Y/N");
+                }
+
                 addDefinitionToOneWordNames = GetAnswerOfYesNoQuestion("Add character details (age, height, etc.) to the definition of a character's full name when it consists of a single word? Y/N");
                 if (addDefinitionToOneWordNames)
                 {
@@ -224,7 +247,7 @@ public static void Main(string[] args)
                     }
                 }
 
-                string definition = vndbNameRecord.GetDefinition();
+                string definition = vndbNameRecord.GetDefinition(addDescriptionToDefinition, includeSpoilersInDescription);
                 List<NameRecord>? aliasRecords = createAliasEntries
                     ? vndbNameRecord.GetAliasRecords()
                     : null;

VndbCharacterNames/Utils.cs

@@ -45,4 +45,13 @@ internal static partial class Utils
 
     [GeneratedRegex(@"(.+?)\s*\(([^,]+?)\)", RegexOptions.CultureInvariant)]
     public static partial Regex NameInParentheses { get; }
+
+    [GeneratedRegex(@"\[spoiler\][\s\S]*?\[/spoiler\]", RegexOptions.CultureInvariant)]
+    public static partial Regex DescriptionInSpoilerTags { get; }
+
+    [GeneratedRegex("\n{3,}", RegexOptions.CultureInvariant)]
+    public static partial Regex ExcessNewlines { get; }
+
+    [GeneratedRegex(@"\[(\/)?(?:b|i|u|s|url|quote|spoiler|raw|code)(?:=[^\]]+)?\]", RegexOptions.CultureInvariant)]
+    public static partial Regex BbCodeTags { get; }
 }

VndbCharacterNames/VndbNameRecord.cs

@@ -17,6 +17,7 @@ internal sealed class VndbNameRecord(string fullName,
     string? cupSize,
     string? sex,
     string? imagePath,
+    string? description,
     int? bust,
     int? waist,
     int? hip,
@@ -51,6 +52,9 @@ internal sealed class VndbNameRecord(string fullName,
     [JsonPropertyName("Image Path")]
     public string? ImagePath { get; } = imagePath;
 
+    [JsonPropertyName("Description")]
+    public string? Description { get; set; } = description;
+
     [JsonPropertyName("Bust")]
     public int? Bust { get; } = bust;
 
@@ -100,7 +104,32 @@ internal sealed class VndbNameRecord(string fullName,
             : $"B/W/H: {Bust?.ToString(CultureInfo.InvariantCulture) ?? "?"}/{Waist?.ToString(CultureInfo.InvariantCulture) ?? "?"}/{Hip?.ToString(CultureInfo.InvariantCulture) ?? "?"} cm";
     }
 
-    public string GetDefinition()
+    private string? GetDescription(bool includeSpoilersInDescription)
+    {
+        if (Description is null)
+        {
+            return null;
+        }
+
+        if (!includeSpoilersInDescription)
+        {
+            Description = Utils.DescriptionInSpoilerTags.Replace(Description, "");
+        }
+
+        Description = Utils.BbCodeTags.Replace(Description, "");
+        Description = Utils.ExcessNewlines.Replace(Description, "\n\n");
+        Description = Description.Trim();
+
+        if (Description.Length is 0)
+        {
+            Description = null;
+            return null;
+        }
+
+        return $"\n{Description}";
+    }
+
+    public string GetDefinition(bool addDescriptionToDefinition, bool includeSpoilersInDescription)
     {
         StringBuilder definitionStringBuilder = new();
         _ = definitionStringBuilder.AppendLine(CultureInfo.InvariantCulture, $"Full name: {FullName} ({FullNameInRomaji})");
@@ -177,6 +206,15 @@ public string GetDefinition()
             _ = definitionStringBuilder.AppendLine(CultureInfo.InvariantCulture, $"VN: {VisualNovelTitles[0]}");
         }
 
+        if (addDescriptionToDefinition)
+        {
+            string? description = GetDescription(includeSpoilersInDescription);
+            if (description is not null)
+            {
+                _ = definitionStringBuilder.AppendLine(description);
+            }
+        }
+
         return definitionStringBuilder.Length > 0
             ? definitionStringBuilder.ToString(0, definitionStringBuilder.Length - Environment.NewLine.Length)
             : FullNameInRomaji;