From 1f87c7608c7c8246c59260326c4e076dd5d82760 Mon Sep 17 00:00:00 2001
From: Marc Durdin <marc@durdin.net>
Date: Tue, 2 Mar 2021 11:59:12 +1100
Subject: [PATCH] fix(developer): require language tag when compiling keyboard
 package

Fixes #2998.

Three parts to this:

* The package compiler will now give a warning if a keyboard in a
  package does not contain any language metadata.

* Removed old canonicalization check during compile which is now handled
  better in `TPackageInfoRefreshKeyboards`.

* Reduced non-canonical BCP 47 tag warnings in
  `TPackageInfoRefreshKeyboards` to "info" so they do not block the
  build.

Point 3 above is one part of the outcome of our BCP 47 discussion at:
https://docs.google.com/document/d/1N5CkTX7tlLlmUB9Mbd-LblY1ch1e642XxlTasC_WE_Q/edit#heading=h.fiy983iliay5
---
 .../global/delphi/general/CompilePackage.pas  | 33 +++----------------
 ...man.System.PackageInfoRefreshKeyboards.pas |  2 +-
 2 files changed, 5 insertions(+), 30 deletions(-)

diff --git a/windows/src/global/delphi/general/CompilePackage.pas b/windows/src/global/delphi/general/CompilePackage.pas
index 84f937b3ea..edf7532c7f 100644
--- a/windows/src/global/delphi/general/CompilePackage.pas
+++ b/windows/src/global/delphi/general/CompilePackage.pas
@@ -41,7 +41,6 @@ uses
   System.IniFiles,
   System.Zip,
 
-  BCP47Tag,
   OnlineConstants,
   VisualKeyboard,
   utilfiletypes,
@@ -452,41 +451,17 @@ begin
 end;
 
 const
-  SKKeyboardPackageLanguageNonCanonical = 'The keyboard %0:s has a non-canonical language ID "%1:s" (%2:s), should be "%3:s".';
+  SKKeyboardPackageLanguageNonCanonical = 'The keyboard %0:s has a non-canonical language tag "%1:s" (%2:s), should be "%3:s".';
+  SKKeyboardShouldHaveAtLeastOneLanguage = 'The keyboard %0:s has no language tags. It should have at least one language tag.';
 
 procedure TCompilePackage.CheckKeyboardLanguages;
 var
   k: TPackageKeyboard;
-  l: TPackageKeyboardLanguage;
-  NewID: string;
-  Tag, NewTag: TBCP47Tag;
 begin
   for k in pack.Keyboards do
   begin
-    for l in k.Languages do
-    begin
-      Tag := TBCP47Tag.Create(l.ID);
-      NewID := TCanonicalLanguageCodeUtils.FindBestTag(l.ID, False, False);
-      if NewID = '' then
-      begin
-        // We don't have enough data to validate this tag
-        Continue;
-      end;
-
-      NewTag := TBCP47Tag.Create(NewID);
-      try
-        if (Tag.Script = '') and (NewTag.Script <> '') then
-        begin
-          // Only give non-canonical warning if the script tag is missing but should
-          // be present.
-          NewTag.Region := Tag.Region; // We don't care about region, don't give unhelpful info to developer
-          WriteMessage(plsWarning, Format(SKKeyboardPackageLanguageNonCanonical, [k.ID, l.ID, l.Name, NewTag.Tag]));
-        end;
-      finally
-        NewTag.Free;
-        Tag.Free;
-      end;
-    end;
+    if k.Languages.Count = 0 then
+      WriteMessage(plsWarning, Format(SKKeyboardShouldHaveAtLeastOneLanguage, [k.ID]));
   end;
 end;
 
diff --git a/windows/src/global/delphi/packages/Keyman.System.PackageInfoRefreshKeyboards.pas b/windows/src/global/delphi/packages/Keyman.System.PackageInfoRefreshKeyboards.pas
index 87b8102ba2..fa1e1bd245 100644
--- a/windows/src/global/delphi/packages/Keyman.System.PackageInfoRefreshKeyboards.pas
+++ b/windows/src/global/delphi/packages/Keyman.System.PackageInfoRefreshKeyboards.pas
@@ -209,7 +209,7 @@ begin
         end
         else if not TCanonicalLanguageCodeUtils.IsCanonical(tag, msg, False, False) then
         begin
-          DoError(Format(SWarning_LanguageTagIsNotCanonical, [kbd.ID, lang.ID, msg]), plsWarning);
+          DoError(Format(SWarning_LanguageTagIsNotCanonical, [kbd.ID, lang.ID, msg]), plsInfo);
         end;
       finally
         Free;