prioritize matching data keys over script keys

mcmonkey4eva · mcmonkey4eva · commit 467121eba49b · 2023-12-28T02:58:03.000-08:00
diff --git a/SharpDenizenTools/ScriptAnalysis/ScriptChecker.cs b/SharpDenizenTools/ScriptAnalysis/ScriptChecker.cs
@@ -44,6 +44,9 @@ public class ScriptChecker
         /// <summary>Keys that always mean a section is a script.</summary>
         public static string[] AlwaysScriptKeys = ["script", "scripts", "subscripts", "subtasks", "inject", "injects", "injectables", "subprocedures"];
 
+        /// <summary>Keys that always mean simple data.</summary>
+        public static string[] AlwaysDataKeys = ["data", "description"];
+
         /// <summary>A non-complete set of Denizen commands that can end with a colon and contain arguments, for checking certain syntax errors.</summary>
         public static HashSet<string> CommandsWithColonsAndArguments =
         [
@@ -1029,7 +1032,11 @@ void checkBasicList(List<object> list, bool canBeScript)
                         }
                         if (valueAtKey is List<object> listAtKey)
                         {
-                            if (MatchesSet(keyName, script.KnownType.ScriptKeys) || MatchesSet(keyName, AlwaysScriptKeys))
+                            if (MatchesSet(keyName, AlwaysDataKeys) || typeString.Text == "data")
+                            {
+                                checkBasicList(listAtKey, false);
+                            }
+                            else if (MatchesSet(keyName, script.KnownType.ScriptKeys) || MatchesSet(keyName, AlwaysScriptKeys))
                             {
                                 checkAsScript(listAtKey);
                             }
@@ -1041,11 +1048,6 @@ void checkBasicList(List<object> list, bool canBeScript)
                             {
                                 warnScript(Warnings, keyLine.Line, "list_should_be_value", $"Bad key `{keyName.Replace('`', '\'')}` (was expected to be a direct Value, but was instead a list - check `!lang {typeString.Text} script containers` for format rules)!");
                             }
-                            else if (typeString.Text == "data" || keyName == "data" || keyName == "description")
-                            {
-                                // Always allow 'data'
-                                checkBasicList(listAtKey, false);
-                            }
                             else if (script.KnownType.Strict)
                             {
                                 warnScript(Warnings, keyLine.Line, "unknown_key_" + typeString.Text, $"Unexpected list key `{keyName.Replace('`', '\'')}` (unrecognized - check `!lang {typeString.Text} script containers` for format rules)!");
@@ -1129,15 +1131,15 @@ void checkSubMaps(Dictionary<LineTrackedString, object> subMap, bool canBeScript
                             if (script.KnownType.ValueKeys.Contains(keyText) || script.KnownType.ListKeys.Contains(keyText) || script.KnownType.ScriptKeys.Contains(keyText) || AlwaysScriptKeys.Contains(keyName)
                                 || script.KnownType.ValueKeys.Contains("*") || script.KnownType.ListKeys.Contains("*") || script.KnownType.ScriptKeys.Contains("*"))
                             {
-                                checkSubMaps(keyPairMap, typeString.Text != "data" && keyName != "data");
+                                checkSubMaps(keyPairMap, typeString.Text != "data" && !MatchesSet(keyName, AlwaysDataKeys));
                             }
                             else if (script.KnownType.Strict && keyName != "data")
                             {
                                 warnScript(Warnings, keyLine.Line, "unknown_key_" + typeString.Text, $"Unexpected submapping key `{keyName.Replace('`', '\'')}` (unrecognized - check `!lang {typeString.Text} script containers` for format rules)!");
                             }
                             else
                             {
-                                checkSubMaps(keyPairMap, typeString.Text != "data" && !keyName.StartsWith("definemap") && keyName != "data");
+                                checkSubMaps(keyPairMap, typeString.Text != "data" && !keyName.StartsWith("definemap") && !MatchesSet(keyName, AlwaysDataKeys));
                             }
                         }
                     }
@@ -1906,7 +1908,11 @@ void procAsScript(List<object> list)
                 }
                 if (valueAtKey is List<object> listAtKey)
                 {
-                    if (MatchesSet(keyName, script.KnownType.ScriptKeys) || MatchesSet(keyName, AlwaysScriptKeys))
+                    if (MatchesSet(keyName, AlwaysDataKeys))
+                    {
+                        // ignore
+                    }
+                    else if (MatchesSet(keyName, script.KnownType.ScriptKeys) || MatchesSet(keyName, AlwaysScriptKeys))
                     {
                         procAsScript(listAtKey);
                     }

Original file line number	Diff line number	Diff line change
`@@ -44,6 +44,9 @@ public class ScriptChecker`
`44`	`44`	`/// <summary>Keys that always mean a section is a script.</summary>`
`45`	`45`	`public static string[] AlwaysScriptKeys = ["script", "scripts", "subscripts", "subtasks", "inject", "injects", "injectables", "subprocedures"];`
`46`	`46`
	`47`	`+ /// <summary>Keys that always mean simple data.</summary>`
	`48`	`+ public static string[] AlwaysDataKeys = ["data", "description"];`
	`49`	`+`
`47`	`50`	`/// <summary>A non-complete set of Denizen commands that can end with a colon and contain arguments, for checking certain syntax errors.</summary>`
`48`	`51`	`public static HashSet<string> CommandsWithColonsAndArguments =`
`49`	`52`	`[`
`@@ -1029,7 +1032,11 @@ void checkBasicList(List<object> list, bool canBeScript)`
`1029`	`1032`	`}`
`1030`	`1033`	`if (valueAtKey is List<object> listAtKey)`
`1031`	`1034`	`{`
`1032`		`- if (MatchesSet(keyName, script.KnownType.ScriptKeys) \|\| MatchesSet(keyName, AlwaysScriptKeys))`
	`1035`	`+ if (MatchesSet(keyName, AlwaysDataKeys) \|\| typeString.Text == "data")`
	`1036`	`+ {`
	`1037`	`+ checkBasicList(listAtKey, false);`
	`1038`	`+ }`
	`1039`	`+ else if (MatchesSet(keyName, script.KnownType.ScriptKeys) \|\| MatchesSet(keyName, AlwaysScriptKeys))`
`1033`	`1040`	`{`
`1034`	`1041`	`checkAsScript(listAtKey);`
`1035`	`1042`	`}`
`@@ -1041,11 +1048,6 @@ void checkBasicList(List<object> list, bool canBeScript)`
`1041`	`1048`	`{`
`1042`	`1049`	warnScript(Warnings, keyLine.Line, "list_should_be_value", $"Bad key `{keyName.Replace('`', '\'')}` (was expected to be a direct Value, but was instead a list - check `!lang {typeString.Text} script containers` for format rules)!");
`1043`	`1050`	`}`
`1044`		`- else if (typeString.Text == "data" \|\| keyName == "data" \|\| keyName == "description")`
`1045`		`- {`
`1046`		`- // Always allow 'data'`
`1047`		`- checkBasicList(listAtKey, false);`
`1048`		`- }`
`1049`	`1051`	`else if (script.KnownType.Strict)`
`1050`	`1052`	`{`
`1051`	`1053`	warnScript(Warnings, keyLine.Line, "unknown_key_" + typeString.Text, $"Unexpected list key `{keyName.Replace('`', '\'')}` (unrecognized - check `!lang {typeString.Text} script containers` for format rules)!");
`@@ -1129,15 +1131,15 @@ void checkSubMaps(Dictionary<LineTrackedString, object> subMap, bool canBeScript`
`1129`	`1131`	`if (script.KnownType.ValueKeys.Contains(keyText) \|\| script.KnownType.ListKeys.Contains(keyText) \|\| script.KnownType.ScriptKeys.Contains(keyText) \|\| AlwaysScriptKeys.Contains(keyName)`
`1130`	`1132`	`\|\| script.KnownType.ValueKeys.Contains("") \|\| script.KnownType.ListKeys.Contains("") \|\| script.KnownType.ScriptKeys.Contains("*"))`
`1131`	`1133`	`{`
`1132`		`- checkSubMaps(keyPairMap, typeString.Text != "data" && keyName != "data");`
	`1134`	`+ checkSubMaps(keyPairMap, typeString.Text != "data" && !MatchesSet(keyName, AlwaysDataKeys));`
`1133`	`1135`	`}`
`1134`	`1136`	`else if (script.KnownType.Strict && keyName != "data")`
`1135`	`1137`	`{`
`1136`	`1138`	warnScript(Warnings, keyLine.Line, "unknown_key_" + typeString.Text, $"Unexpected submapping key `{keyName.Replace('`', '\'')}` (unrecognized - check `!lang {typeString.Text} script containers` for format rules)!");
`1137`	`1139`	`}`
`1138`	`1140`	`else`
`1139`	`1141`	`{`
`1140`		`- checkSubMaps(keyPairMap, typeString.Text != "data" && !keyName.StartsWith("definemap") && keyName != "data");`
	`1142`	`+ checkSubMaps(keyPairMap, typeString.Text != "data" && !keyName.StartsWith("definemap") && !MatchesSet(keyName, AlwaysDataKeys));`
`1141`	`1143`	`}`
`1142`	`1144`	`}`
`1143`	`1145`	`}`
`@@ -1906,7 +1908,11 @@ void procAsScript(List<object> list)`
`1906`	`1908`	`}`
`1907`	`1909`	`if (valueAtKey is List<object> listAtKey)`
`1908`	`1910`	`{`
`1909`		`- if (MatchesSet(keyName, script.KnownType.ScriptKeys) \|\| MatchesSet(keyName, AlwaysScriptKeys))`
	`1911`	`+ if (MatchesSet(keyName, AlwaysDataKeys))`
	`1912`	`+ {`
	`1913`	`+ // ignore`
	`1914`	`+ }`
	`1915`	`+ else if (MatchesSet(keyName, script.KnownType.ScriptKeys) \|\| MatchesSet(keyName, AlwaysScriptKeys))`
`1910`	`1916`	`{`
`1911`	`1917`	`procAsScript(listAtKey);`
`1912`	`1918`	`}`