dotnet list package restores

Author: Nigusu-Allehu

src/Cli/dotnet/Commands/List/Package/ListPackageReferencesCommandParser.cs

@@ -34,6 +34,7 @@ private static CliCommand ConstructCommand()
         command.Options.Add(PackageListCommandParser.InteractiveOption);
         command.Options.Add(PackageListCommandParser.FormatOption);
         command.Options.Add(PackageListCommandParser.OutputVersionOption);
+        command.Options.Add(PackageListCommandParser.NoRestore);
 
         command.SetAction((parseResult) => new ListPackageReferencesCommand(parseResult).Execute());
 

src/Cli/dotnet/Commands/Package/List/ListPackageReferencesCommand.cs

@@ -6,6 +6,8 @@
 using Microsoft.DotNet.Cli.Extensions;
 using Microsoft.DotNet.Cli.Utils;
 using Microsoft.DotNet.Tools.NuGet;
+using System.Globalization;
+using Microsoft.DotNet.Tools.MSBuild;
 
 namespace Microsoft.DotNet.Tools.Package.List;
 
@@ -30,7 +32,57 @@ private static string GetAbsolutePath(string currentDirectory, string relativePa
 
     public override int Execute()
     {
-        return NuGetCommand.Run(TransformArgs());
+        string projectFile = GetProjectOrSolution();
+        bool noRestore = _parseResult.HasOption(PackageListCommandParser.NoRestore);
+        int restoreExitCode = 0;
+
+        if (!noRestore)
+        {
+            ReportOutputFormat formatOption = _parseResult.GetValue((CliOption<ReportOutputFormat>)PackageListCommandParser.FormatOption);
+            restoreExitCode = RunRestore(projectFile, formatOption);
+        }
+
+        return restoreExitCode == 0
+            ? NuGetCommand.Run(TransformArgs(projectFile))
+            : restoreExitCode;
+    }
+
+    private int RunRestore(string projectOrSolution, ReportOutputFormat formatOption)
+    {
+        MSBuildForwardingApp restoringCommand = new MSBuildForwardingApp(argsToForward: ["-target:restore", projectOrSolution, "-noConsoleLogger"]);
+
+        int exitCode = 0;
+
+        try
+        {
+            exitCode = restoringCommand.Execute();
+        }
+        catch (Exception)
+        {
+            exitCode = 1;
+        }
+
+        if (exitCode != 0)
+        {
+            if (formatOption == ReportOutputFormat.json)
+            {
+                string jsonError =
+    "{\r\n" +
+    "   \"version\": 1,\r\n" +
+    "   \"problems\": [\r\n" +
+    "      {\r\n" +
+    $"         \"text\": \"{String.Format(CultureInfo.CurrentCulture, LocalizableStrings.Error_restore)}\",\r\n" +
+    "         \"level\": \"error\"\r\n" +
+    "      }\r\n" +
+    "   ]\r\n" +
+    "}";
+                Console.WriteLine(jsonError);
+            }
+
+            Console.WriteLine(String.Format(CultureInfo.CurrentCulture, LocalizableStrings.Error_restore));
+        }
+
+        return exitCode;
     }
 
     internal static void EnforceOptionRules(ParseResult parseResult)
@@ -45,15 +97,15 @@ internal static void EnforceOptionRules(ParseResult parseResult)
         }
     }
 
-    private string[] TransformArgs()
+    private string[] TransformArgs(string projectOrSolution)
     {
         var args = new List<string>
         {
             "package",
             "list",
         };
 
-        args.Add(GetProjectOrSolution());
+        args.Add(projectOrSolution);
 
         args.AddRange(_parseResult.OptionValuesToBeForwarded(PackageListCommandParser.GetCommand()));
 

src/Cli/dotnet/Commands/Package/List/LocalizableStrings.resx

@@ -174,4 +174,11 @@
   <data name="CmdOutputVersionDescription" xml:space="preserve">
     <value>Specifies the version of machine-readable output. Requires the '--format json' option.</value>
   </data>
+  <data name="Error_restore" xml:space="preserve">
+    <value>Restore failed. Run `dotnet restore` for more details on the issue.</value>
+    <comment>Do not translate `dotnet restore`</comment>
+  </data>
+  <data name="CmdNoRestoreDescription" xml:space="preserve">
+    <value>Do not restore before running the command.</value>
+  </data>
 </root>

src/Cli/dotnet/Commands/Package/List/PackageListCommandParser.cs

@@ -74,6 +74,12 @@ internal static class PackageListCommandParser
 
     public static readonly CliOption InteractiveOption = CommonOptions.InteractiveOption().ForwardIfEnabled("--interactive");
 
+    public static readonly CliOption NoRestore = new CliOption<bool>("--no-restore")
+    {
+        Description = LocalizableStrings.CmdNoRestoreDescription,
+        Arity = ArgumentArity.Zero
+    };
+
     public static readonly CliOption VerbosityOption = new ForwardedOption<VerbosityOptions>("--verbosity", "-v")
     {
         Description = CommonLocalizableStrings.VerbosityOptionDescription,