Teach CheckTranslationReference about translations in Lua scripts

[RoosterDragon]

Using the glory of regex, we can scrape any Lua script files that a map includes and locate calls to the UserInterface.Translate method. We can then treat them in the same way as C# fields marked with a TranslationReferenceAttribute. This allows the lint check to validate the translation invoked in the .lua script has a matching entry in the translation .ftl files, with all the required arguments (if any).

We can also locate any calls to AddPrimaryObjective or AddSecondaryObjective defined by the utils.lua script, which also accept translation keys.

The are a couple of restrictions:

• When linting the map, we don't check for keys in the ftl file that are unused. This is because the linter doesn't load all the keys when checking maps.
• In order to validate translation arguments with the regex, we require the Lua script to pass the table of arguments inline at the callsite. If it does not, we raise a warning so the user can adjust the code.

---

Example by modifying allies-01:

OpenRA/mods/ra/maps/allies-01/allies01.lua

Line 28 in 5ddc7b1

Media.DisplayMessage(UserInterface.Translate("tanya-rules-of-engagement"), UserInterface.Translate("tanya"))

to be:

Media.DisplayMessage(UserInterface.Translate("tanya-rules-of-engagement-2"), UserInterface.Translate("tanya", { ["some-arg"] = 1 }))
local argsFromAVariable = { ["some-arg"] = 1 }
UserInterface.Translate("tanya", argsFromAVariable)

Run the utility with ra --check-yaml

gives the following logs:

Testing map: 01:   In the Thick of It
OpenRA.Utility(1,1): Warning: Script allies01.lua:30 calls UserInterface.Translate with key `tanya` and translate args passed as `argsFromAVariable`. Inline the args at the callsite for lint analysis.
OpenRA.Utility(1,1): Error: Missing variable `some-arg` for key `tanya` in ra|languages/lua/en.ftl
OpenRA.Utility(1,1): Warning: Missing key `tanya-rules-of-engagement-2` in `en` language in map translation files required by Script allies01.lua:28

We could look to later extend this to other Lua calls where a translation-key should be passed, but this seems like a nice starting point.

Recommend viewing the diff with whitespace changes hidden.

Assists with #10475

[RoosterDragon]

Updated to also check for AddPrimaryObjective and AddSecondaryObjective calls. This would've detected the issue from #21481, for example.

[Mailaender]

Works as promised.

[Mailaender]

Changelog