Improve error message when installing tools targeting higher .NET versions (#51665)

Author: dsplaisted

src/Cli/dotnet/CliStrings.resx

@@ -416,6 +416,12 @@ setx PATH "%PATH%;{0}"
   <data name="MissingToolSettingsFile" xml:space="preserve">
     <value>Settings file 'DotnetToolSettings.xml' was not found in the package.</value>
   </data>
+  <data name="ToolRequiresHigherDotNetVersion" xml:space="preserve">
+    <value>Tool '{0}' requires a higher version of .NET than is currently installed. The tool targets {1}, but the current runtime is {2}.</value>
+  </data>
+  <data name="ToolRequiresHigherDotNetVersionSuggestion" xml:space="preserve">
+    <value>To use this tool, upgrade to .NET {0} or later, or use a version of the tool that is compatible with .NET {1}.</value>
+  </data>
   <data name="ToolPackageConflictPackageId" xml:space="preserve">
     <value>Tool '{0}' (version '{1}') is already installed.</value>
   </data>

src/Cli/dotnet/ToolPackage/ToolPackageInstance.cs

@@ -97,7 +97,7 @@ public ToolPackageInstance(PackageId id,
             ResolvedPackageVersion = Version;
         }
 
-        var toolConfiguration = DeserializeToolConfiguration(library, packageDirectory, _fileSystem);
+        var toolConfiguration = DeserializeToolConfiguration(library, packageDirectory, ResolvedPackageId, _fileSystem);
         Warnings = toolConfiguration.Warnings;
 
         var installPath = new VersionFolderPathResolver(PackageDirectory.Value).GetInstallPath(ResolvedPackageId.ToString(), ResolvedPackageVersion);
@@ -165,17 +165,58 @@ public static ToolConfiguration GetToolConfiguration(PackageId id,
     {
         var lockFile = new LockFileFormat().Read(assetsJsonParentDirectory.WithFile(AssetsFileName).Value);
         var lockFileTargetLibrary = FindLibraryInLockFile(lockFile);
-        return DeserializeToolConfiguration(lockFileTargetLibrary, packageDirectory, fileSystem);
+        return DeserializeToolConfiguration(lockFileTargetLibrary, packageDirectory, id, fileSystem);
 
     }
 
-    private static ToolConfiguration DeserializeToolConfiguration(LockFileTargetLibrary library, DirectoryPath packageDirectory, IFileSystem fileSystem)
+    private static ToolConfiguration DeserializeToolConfiguration(LockFileTargetLibrary library, DirectoryPath packageDirectory, PackageId packageId, IFileSystem fileSystem)
     {
         try
         {
             var dotnetToolSettings = FindItemInTargetLibrary(library, ToolSettingsFileName);
             if (dotnetToolSettings == null)
             {
+                // Check if this is because of framework incompatibility
+                // Load available frameworks from the package to provide better error messages
+                var installPath = new VersionFolderPathResolver(packageDirectory.Value).GetInstallPath(library.Name, library.Version);
+                var toolsPackagePath = Path.Combine(installPath, "tools");
+                
+                if (fileSystem.Directory.Exists(toolsPackagePath))
+                {
+                    var availableFrameworks = fileSystem.Directory.EnumerateDirectories(toolsPackagePath)
+                        .Select(path => NuGetFramework.ParseFolder(Path.GetFileName(path)))
+                        .Where(f => f.Framework == FrameworkConstants.FrameworkIdentifiers.NetCoreApp)
+                        .ToList();
+
+                    if (availableFrameworks.Count > 0)
+                    {
+                        var currentFramework = new NuGetFramework(FrameworkConstants.FrameworkIdentifiers.NetCoreApp, new Version(Environment.Version.Major, Environment.Version.Minor));
+
+                        // Find the minimum framework version required by the tool
+                        var minRequiredFramework = availableFrameworks.MinBy(f => f.Version);
+
+                        // If all available frameworks require a higher version than current runtime
+                        if (minRequiredFramework != null && minRequiredFramework.Version > currentFramework.Version)
+                        {
+                            var requiredVersionString = $".NET {minRequiredFramework.Version.Major}.{minRequiredFramework.Version.Minor}";
+                            var currentVersionString = $".NET {currentFramework.Version.Major}.{currentFramework.Version.Minor}";
+
+                            var errorMessage = string.Format(
+                                CliStrings.ToolRequiresHigherDotNetVersion,
+                                packageId,
+                                requiredVersionString,
+                                currentVersionString);
+
+                            var suggestion = string.Format(
+                                CliStrings.ToolRequiresHigherDotNetVersionSuggestion,
+                                minRequiredFramework.Version.Major,
+                                currentFramework.Version.Major);
+
+                            throw new GracefulException($"{errorMessage} {suggestion}", isUserError: false);
+                        }
+                    }
+                }
+
                 throw new ToolConfigurationException(
                     CliStrings.MissingToolSettingsFile);
             }