Give a different error to guide use to install via global tools (#9070)

Give a different error to guide use to install via global tools so, if several bundled DotnetTools cannot finish source build on time. The user can use global tools to get it.

The original plan that adding a different resolver is hard due to resolver can only find dll that will be used to spawn a process. However, the command constructor will give an error message when resolver find null. By adding a different error when the command name is part of the list, it can achieve the same goal.

Author: William Li

src/Microsoft.DotNet.Cli.Utils/Command.cs

@@ -21,6 +21,8 @@ public class Command : ICommand
 
         private bool _running = false;
 
+        private static string[] _knownCommandsAvailableAsDotNetTool = new[] { "dotnet-dev-certs", "dotnet-ef", "dotnet-sql-cache", "dotnet-user-secrets", "dotnet-watch" };
+
         private Command(CommandSpec commandSpec)
         {
             var psi = new ProcessStartInfo
@@ -102,7 +104,14 @@ public static Command Create(
 
             if (commandSpec == null)
             {
-                throw new CommandUnknownException(commandName);
+                if (_knownCommandsAvailableAsDotNetTool.Contains(commandName, StringComparer.OrdinalIgnoreCase))
+                {
+                    throw new CommandAvailableAsDotNetToolException(commandName);
+                }
+                else
+                {
+                    throw new CommandUnknownException(commandName);
+                }
             }
 
             var command = new Command(commandSpec);

src/Microsoft.DotNet.Cli.Utils/CommandAvailableAsDotNetToolException.cs

@@ -0,0 +1,29 @@
+// Copyright (c) .NET Foundation and contributors. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+
+using System;
+
+namespace Microsoft.DotNet.Cli.Utils
+{
+    public class CommandAvailableAsDotNetToolException : GracefulException
+    {
+        public CommandAvailableAsDotNetToolException(string commandName) : base(GetMessage(commandName))
+        {
+        }
+
+        public CommandAvailableAsDotNetToolException(string commandName, Exception innerException) : base(
+            GetMessage(commandName), innerException)
+        {
+        }
+
+        private static string GetMessage(string commandName)
+        {
+            var commandRemoveLeadningDotnet = commandName.Replace("dotnet-", string.Empty);
+            var packageName = "dotnet-" + commandRemoveLeadningDotnet.ToLower();
+
+            return string.Format(LocalizableStrings.CannotFindCommandAvailableAsTool,
+                commandRemoveLeadningDotnet,
+                packageName);
+        }
+    }
+}

src/Microsoft.DotNet.Cli.Utils/LocalizableStrings.resx

@@ -271,4 +271,9 @@
   <data name="EmbedAppNameInHostFileNameIsTooLong" xml:space="preserve">
     <value>Given file name '{0}' is longer than 1024 bytes</value>
   </data>
+  <data name="CannotFindCommandAvailableAsTool" xml:space="preserve">
+    <value>Cannot find command 'dotnet {0}', please run the following command to install
+
+dotnet tool install --global {1}</value>
+  </data>
 </root>

src/Microsoft.DotNet.Cli.Utils/xlf/LocalizableStrings.cs.xlf

@@ -259,6 +259,15 @@
         <target state="new">Given file name '{0}' is longer than 1024 bytes</target>
         <note />
       </trans-unit>
+      <trans-unit id="CannotFindCommandAvailableAsTool">
+        <source>Cannot find command 'dotnet {0}', please run the following command to install
+
+dotnet tool install --global {1}</source>
+        <target state="new">Cannot find command 'dotnet {0}', please run the following command to install
+
+dotnet tool install --global {1}</target>
+        <note />
+      </trans-unit>
     </body>
   </file>
 </xliff>

src/Microsoft.DotNet.Cli.Utils/xlf/LocalizableStrings.de.xlf

@@ -259,6 +259,15 @@
         <target state="new">Given file name '{0}' is longer than 1024 bytes</target>
         <note />
       </trans-unit>
+      <trans-unit id="CannotFindCommandAvailableAsTool">
+        <source>Cannot find command 'dotnet {0}', please run the following command to install
+
+dotnet tool install --global {1}</source>
+        <target state="new">Cannot find command 'dotnet {0}', please run the following command to install
+
+dotnet tool install --global {1}</target>
+        <note />
+      </trans-unit>
     </body>
   </file>
 </xliff>

src/Microsoft.DotNet.Cli.Utils/xlf/LocalizableStrings.es.xlf

@@ -259,6 +259,15 @@
         <target state="new">Given file name '{0}' is longer than 1024 bytes</target>
         <note />
       </trans-unit>
+      <trans-unit id="CannotFindCommandAvailableAsTool">
+        <source>Cannot find command 'dotnet {0}', please run the following command to install
+
+dotnet tool install --global {1}</source>
+        <target state="new">Cannot find command 'dotnet {0}', please run the following command to install
+
+dotnet tool install --global {1}</target>
+        <note />
+      </trans-unit>
     </body>
   </file>
 </xliff>

src/Microsoft.DotNet.Cli.Utils/xlf/LocalizableStrings.fr.xlf

@@ -259,6 +259,15 @@
         <target state="new">Given file name '{0}' is longer than 1024 bytes</target>
         <note />
       </trans-unit>
+      <trans-unit id="CannotFindCommandAvailableAsTool">
+        <source>Cannot find command 'dotnet {0}', please run the following command to install
+
+dotnet tool install --global {1}</source>
+        <target state="new">Cannot find command 'dotnet {0}', please run the following command to install
+
+dotnet tool install --global {1}</target>
+        <note />
+      </trans-unit>
     </body>
   </file>
 </xliff>

src/Microsoft.DotNet.Cli.Utils/xlf/LocalizableStrings.it.xlf

@@ -259,6 +259,15 @@
         <target state="new">Given file name '{0}' is longer than 1024 bytes</target>
         <note />
       </trans-unit>
+      <trans-unit id="CannotFindCommandAvailableAsTool">
+        <source>Cannot find command 'dotnet {0}', please run the following command to install
+
+dotnet tool install --global {1}</source>
+        <target state="new">Cannot find command 'dotnet {0}', please run the following command to install
+
+dotnet tool install --global {1}</target>
+        <note />
+      </trans-unit>
     </body>
   </file>
 </xliff>

src/Microsoft.DotNet.Cli.Utils/xlf/LocalizableStrings.ja.xlf

@@ -259,6 +259,15 @@
         <target state="new">Given file name '{0}' is longer than 1024 bytes</target>
         <note />
       </trans-unit>
+      <trans-unit id="CannotFindCommandAvailableAsTool">
+        <source>Cannot find command 'dotnet {0}', please run the following command to install
+
+dotnet tool install --global {1}</source>
+        <target state="new">Cannot find command 'dotnet {0}', please run the following command to install
+
+dotnet tool install --global {1}</target>
+        <note />
+      </trans-unit>
     </body>
   </file>
 </xliff>

src/Microsoft.DotNet.Cli.Utils/xlf/LocalizableStrings.ko.xlf

@@ -259,6 +259,15 @@
         <target state="new">Given file name '{0}' is longer than 1024 bytes</target>
         <note />
       </trans-unit>
+      <trans-unit id="CannotFindCommandAvailableAsTool">
+        <source>Cannot find command 'dotnet {0}', please run the following command to install
+
+dotnet tool install --global {1}</source>
+        <target state="new">Cannot find command 'dotnet {0}', please run the following command to install
+
+dotnet tool install --global {1}</target>
+        <note />
+      </trans-unit>
     </body>
   </file>
 </xliff>