Multiple locale support for winget workflows (#903)

microsoft · May 1, 2021 · 558f3f4 · 558f3f4
1 parent 9399b6a
commit 558f3f4
Show file tree

Hide file tree

Showing 43 changed files with 925 additions and 62 deletions.
diff --git a/.github/actions/spelling/allow.txt b/.github/actions/spelling/allow.txt
@@ -26,6 +26,8 @@ authz
 autocomplete
 auxdata
 azureedge
+bcp
+bcp47
 bcrypt
 binver
 Bitmask
@@ -50,6 +52,7 @@ cnt
 codepage
 COMMANDBARFLYOUT
 Commandline
+comparand
 conemu
 config
 Configurability
@@ -95,6 +98,7 @@ dll
 dllexport
 docx
 dotnet
+downlevel
 downloader
 dword
 DWORDLONG
@@ -203,6 +207,9 @@ json
 junit
 langutil
 lastwritetime
+LCID
+LCIDTo
+LEN
 Linux
 LLVM
 llvmorg
@@ -232,6 +239,7 @@ MINORVERSION
 mkdir
 monostate
 motw
+mrm
 msbuild
 msdata
 MSDN
@@ -373,6 +381,7 @@ simplesave
 simpletest
 sizeof
 sln
+SNAME
 snprintf
 sourced
 Specv
@@ -537,3 +546,4 @@ XTOKEN
 yaml
 yml
 yy
+zh
diff --git a/doc/Settings.md b/doc/Settings.md
@@ -67,6 +67,18 @@ The `scope` behavior affects the choice between installing a package for the cur
     },
 ```
 
+### Locale
+
+The `locale` behavior affects the choice of installer based on installer locale. The matching parameter is `--locale`, and uses bcp47 language tag.
+
+```json
+    "installBehavior": {
+        "preferences": {
+            "locale": [ "en-US", "fr-FR" ]
+        }
+    },
+```
+
 ## Telemetry
 
 The `telemetry` settings control whether winget writes ETW events that may be sent to Microsoft on a default installation of Windows.

diff --git a/schemas/JSON/settings/settings.schema.0.2.json b/schemas/JSON/settings/settings.schema.0.2.json
@@ -44,6 +44,17 @@
             "machine"
           ],
           "default": "user"
+        },
+        "locale": {
+          "description": "The locales of a package install",
+          "type": "array",
+          "items": {
+            "type": "string",
+            "pattern": "^([a-zA-Z]{2}|[iI]-[a-zA-Z]+|[xX]-[a-zA-Z]{1,8})(-[a-zA-Z]{1,8})*$",
+            "maxLength": 20
+          },
+          "minItems": 1,
+          "maxItems": 10
         }
       }
     },

diff --git a/src/AppInstallerCLICore/Argument.cpp b/src/AppInstallerCLICore/Argument.cpp
@@ -43,8 +43,8 @@ namespace AppInstaller::CLI
             return Argument{ "interactive", 'i', Args::Type::Interactive, Resource::String::InteractiveArgumentDescription, ArgumentType::Flag };
         case Args::Type::Silent:
             return Argument{ "silent", 'h', Args::Type::Silent, Resource::String::SilentArgumentDescription, ArgumentType::Flag };
-        case Args::Type::Language:
-            return Argument{ "lang", 'a', Args::Type::Language, Resource::String::LanguageArgumentDescription, ArgumentType::Standard, Argument::Visibility::Hidden };
+        case Args::Type::Locale:
+            return Argument{ "locale", NoAlias, Args::Type::Locale, Resource::String::LocaleArgumentDescription, ArgumentType::Standard };
         case Args::Type::Log:
             return Argument{ "log", 'o', Args::Type::Log, Resource::String::LogArgumentDescription, ArgumentType::Standard };
         case Args::Type::Override:

diff --git a/src/AppInstallerCLICore/Commands/InstallCommand.cpp b/src/AppInstallerCLICore/Commands/InstallCommand.cpp
@@ -34,7 +34,7 @@ namespace AppInstaller::CLI
             Argument::ForType(Args::Type::Exact),
             Argument::ForType(Args::Type::Interactive),
             Argument::ForType(Args::Type::Silent),
-            Argument::ForType(Args::Type::Language),
+            Argument::ForType(Args::Type::Locale),
             Argument::ForType(Args::Type::Log),
             Argument::ForType(Args::Type::Override),
             Argument::ForType(Args::Type::InstallLocation),
@@ -67,7 +67,7 @@ namespace AppInstaller::CLI
             context <<
                 Workflow::CompleteWithSingleSemanticsForValue(valueType);
             break;
-        case Args::Type::Language:
+        case Args::Type::Locale:
             // May well move to CompleteWithSingleSemanticsForValue,
             // but for now output nothing.
             context <<
@@ -107,6 +107,14 @@ namespace AppInstaller::CLI
                 throw CommandException(Resource::String::InvalidArgumentValueError, s_ArgumentName_Scope, { "user"_lis, "machine"_lis });
             }
         }
+
+        if (execArgs.Contains(Args::Type::Locale))
+        {
+            if (!Locale::IsWellFormedBcp47Tag(execArgs.GetArg(Args::Type::Locale)))
+            {
+                throw CommandException(Resource::String::InvalidArgumentValueErrorWithoutValidValues, Argument::ForType(Args::Type::Locale).Name(), {});
+            }
+        }
     }
 
     void InstallCommand::ExecuteInternal(Context& context) const

diff --git a/src/AppInstallerCLICore/Commands/UpgradeCommand.cpp b/src/AppInstallerCLICore/Commands/UpgradeCommand.cpp
@@ -37,7 +37,6 @@ namespace AppInstaller::CLI
             Argument::ForType(Args::Type::Exact),
             Argument::ForType(Args::Type::Interactive),
             Argument::ForType(Args::Type::Silent),
-            Argument::ForType(Args::Type::Language),
             Argument::ForType(Args::Type::Log),
             Argument::ForType(Args::Type::Override),
             Argument::ForType(Args::Type::InstallLocation),
@@ -88,12 +87,6 @@ namespace AppInstaller::CLI
             context <<
                 Workflow::CompleteWithSingleSemanticsForValueUsingExistingSource(valueType);
             break;
-        case Execution::Args::Type::Language:
-            // May well move to CompleteWithSingleSemanticsForValue,
-            // but for now output nothing.
-            context <<
-                Workflow::CompleteWithEmptySet;
-            break;
         }
     }
 

diff --git a/src/AppInstallerCLICore/ExecutionArgs.h b/src/AppInstallerCLICore/ExecutionArgs.h
@@ -33,7 +33,7 @@ namespace AppInstaller::CLI::Execution
             // Install behavior
             Interactive,
             Silent,
-            Language,
+            Locale,
             Log,
             Override, //Override args are (and the only args) directly passed to installer
             InstallLocation,

diff --git a/src/AppInstallerCLICore/ExecutionContextData.h b/src/AppInstallerCLICore/ExecutionContextData.h
@@ -50,7 +50,7 @@ namespace AppInstaller::CLI::Execution
         Max
     };
 
-    struct PackagesToInstall
+    struct PackageToInstall
     {
         std::shared_ptr<Repository::IPackageVersion> PackageVersion;
         PackageCollection::Package PackageRequest;
@@ -169,7 +169,7 @@ namespace AppInstaller::CLI::Execution
         template <>
         struct DataMapping<Data::PackagesToInstall>
         {
-            using value_t = std::vector<PackagesToInstall>;
+            using value_t = std::vector<PackageToInstall>;
         };
 
         template <>

diff --git a/src/AppInstallerCLICore/Resources.h b/src/AppInstallerCLICore/Resources.h
@@ -100,13 +100,14 @@ namespace AppInstaller::CLI::Resource
         WINGET_DEFINE_RESOURCE_STRINGID(InvalidAliasError);
         WINGET_DEFINE_RESOURCE_STRINGID(InvalidArgumentSpecifierError);
         WINGET_DEFINE_RESOURCE_STRINGID(InvalidArgumentValueError);
+        WINGET_DEFINE_RESOURCE_STRINGID(InvalidArgumentValueErrorWithoutValidValues);
         WINGET_DEFINE_RESOURCE_STRINGID(InvalidJsonFile);
         WINGET_DEFINE_RESOURCE_STRINGID(InvalidNameError);
-        WINGET_DEFINE_RESOURCE_STRINGID(LanguageArgumentDescription);
         WINGET_DEFINE_RESOURCE_STRINGID(LicenseAgreement);
         WINGET_DEFINE_RESOURCE_STRINGID(Links);
         WINGET_DEFINE_RESOURCE_STRINGID(ListCommandLongDescription);
         WINGET_DEFINE_RESOURCE_STRINGID(ListCommandShortDescription);
+        WINGET_DEFINE_RESOURCE_STRINGID(LocaleArgumentDescription);
         WINGET_DEFINE_RESOURCE_STRINGID(LocationArgumentDescription);
         WINGET_DEFINE_RESOURCE_STRINGID(LogArgumentDescription);
         WINGET_DEFINE_RESOURCE_STRINGID(Logs);

diff --git a/src/AppInstallerCLICore/Workflows/ImportExportFlow.cpp b/src/AppInstallerCLICore/Workflows/ImportExportFlow.cpp
@@ -239,7 +239,7 @@ namespace AppInstaller::CLI::Workflow
     void SearchPackagesForImport(Execution::Context& context)
     {
         const auto& sources = context.Get<Execution::Data::Sources>();
-        std::vector<Execution::PackagesToInstall> packagesToInstall = {};
+        std::vector<Execution::PackageToInstall> packagesToInstall = {};
         bool foundAll = true;
 
         // Look for the packages needed from each source independently.

diff --git a/src/AppInstallerCLICore/Workflows/InstallFlow.cpp b/src/AppInstallerCLICore/Workflows/InstallFlow.cpp
@@ -644,7 +644,7 @@ namespace AppInstaller::CLI::Workflow
                 toLog ? static_cast<std::string>(toLog->GetProperty(PackageVersionProperty::Name)) : "",
                 toLog ? static_cast<std::string>(toLog->GetProperty(PackageVersionProperty::Version)) : "",
                 toLog ? static_cast<std::string_view>(toLogMetadata[PackageVersionMetadata::Publisher]) : "",
-                toLog ? static_cast<std::string_view>(toLogMetadata[PackageVersionMetadata::Locale]) : ""
+                toLog ? static_cast<std::string_view>(toLogMetadata[PackageVersionMetadata::InstalledLocale]) : ""
             );
         }
     }