Skip to content

feat(nlp): raise K2 Full draft instruction coverage (39→145) #184

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
oldrepublicwizard wants to merge 1 commit into
base: master
Choose a base branch
from
+574 −25
Open

feat(nlp): raise K2 Full draft instruction coverage (39→145) #184

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
133 changes: 111 additions & 22 deletions src/ModSync.Core/Parsing/DraftInstructionService.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,38 +73,57 @@ public static IReadOnlyList<DraftInstructionResult> GenerateDraftInstructions(

foreach (ModComponent component in components)
{
if (component.Instructions.Count > 0 || string.IsNullOrWhiteSpace(component.Directions))
if (component.Instructions.Count > 0)
{
continue;
}

ObservableCollection<Instruction> parsed;
try
{
parsed = parser.ParseInstructions(
component.Directions,
string.IsNullOrWhiteSpace(component.DownloadInstructions) ? null : component.DownloadInstructions,
component);
}
catch (Exception ex)
int added = 0;

if (!string.IsNullOrWhiteSpace(component.Directions))
{
// Graceful degradation: unparseable prose keeps today's behavior (no instructions drafted).
verbose($"[DraftInstructions] Failed to parse prose for '{component.Name}': {ex.Message}");
continue;
ObservableCollection<Instruction> parsed;
try
{
parsed = parser.ParseInstructions(
component.Directions,
string.IsNullOrWhiteSpace(component.DownloadInstructions) ? null : component.DownloadInstructions,
component);
}
catch (Exception ex)
{
// Graceful degradation: unparseable prose may still get an InstallationMethod fallback.
verbose($"[DraftInstructions] Failed to parse prose for '{component.Name}': {ex.Message}");
parsed = new ObservableCollection<Instruction>();
}

foreach (Instruction instruction in parsed)
{
if (!TrySanitizeInstruction(instruction))
{
verbose($"[DraftInstructions] Dropped non-sandboxed draft ({instruction.Action}) for '{component.Name}'");
continue;
}

instruction.SetParentComponent(component);
component.Instructions.Add(instruction);
added++;
}
}

int added = 0;
foreach (Instruction instruction in parsed)
// K2 Full and similar guides often describe TSLPatcher/HoloPatcher installs via
// Installation Method alone, or preference prose ("recommend the X option") that yields
// no regex hits. Still draft a sandboxed Patcher (or loose-file Move) for review.
if (added == 0)
{
if (!TrySanitizeInstruction(instruction))
Instruction fallback = TryCreateMethodFallbackInstruction(component);
if (fallback != null && TrySanitizeInstruction(fallback))
{
verbose($"[DraftInstructions] Dropped non-sandboxed draft ({instruction.Action}) for '{component.Name}'");
continue;
fallback.SetParentComponent(component);
component.Instructions.Add(fallback);
added++;
verbose($"[DraftInstructions] Applied InstallationMethod fallback ({fallback.Action}) for '{component.Name}'");
}

instruction.SetParentComponent(component);
component.Instructions.Add(instruction);
added++;
}

if (added > 0)
Expand All @@ -118,6 +137,76 @@ public static IReadOnlyList<DraftInstructionResult> GenerateDraftInstructions(
return results;
}

/// <summary>
/// When prose does not parse into instructions, invent a minimal sandboxed draft from
/// <see cref="ModComponent.InstallationMethod"/> and/or patcher keywords in Directions.
/// </summary>
[CanBeNull]
private static Instruction TryCreateMethodFallbackInstruction([NotNull] ModComponent component)
{
string method = component.InstallationMethod ?? string.Empty;
string directions = component.Directions ?? string.Empty;
string combined = method + " " + directions;

if (LooksLikePatcherInstall(combined))
{
return new Instruction
{
Action = Instruction.ActionType.Patcher,
Source = new List<string> { ModDirectoryPlaceholder },
Destination = KotorDirectoryPlaceholder,
Overwrite = true,
};
}

if (LooksLikeLooseFileInstall(method)
&& !LooksLikePatcherInstall(directions)
&& method.IndexOf("executable", StringComparison.OrdinalIgnoreCase) < 0)
{
string destination = directions.IndexOf("movies", StringComparison.OrdinalIgnoreCase) >= 0
? KotorDirectoryPlaceholder + @"\Movies"
: KotorDirectoryPlaceholder + @"\Override";

return new Instruction
{
Action = Instruction.ActionType.Move,
Source = new List<string> { ModDirectoryPlaceholder + @"\*" },
Destination = destination,
Overwrite = directions.IndexOf("do not overwrite", StringComparison.OrdinalIgnoreCase) < 0
&& directions.IndexOf("don't overwrite", StringComparison.OrdinalIgnoreCase) < 0,
};
}

if (method.IndexOf("executable", StringComparison.OrdinalIgnoreCase) >= 0
|| directions.IndexOf("executable", StringComparison.OrdinalIgnoreCase) >= 0)
{
return new Instruction
{
Action = Instruction.ActionType.Execute,
Source = new List<string> { ModDirectoryPlaceholder + @"\*" },
Destination = string.Empty,
Overwrite = true,
};
}

return null;
}

private static bool LooksLikePatcherInstall([NotNull] string text)
{
string lower = text.ToLowerInvariant();
return lower.IndexOf("tslpatcher", StringComparison.Ordinal) >= 0
|| lower.IndexOf("holopatcher", StringComparison.Ordinal) >= 0
|| lower.IndexOf("multi-run", StringComparison.Ordinal) >= 0;
}

private static bool LooksLikeLooseFileInstall([NotNull] string text)
{
string lower = text.ToLowerInvariant();
return lower.IndexOf("loose-file", StringComparison.Ordinal) >= 0
|| lower.IndexOf("loose file", StringComparison.Ordinal) >= 0;
}

/// <summary>
/// Normalizes placeholders and enforces the path-sandboxing rules on a draft instruction:
/// every Source entry and any non-empty Destination must start with
Expand Down
Loading
Loading