Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

dotnet package list command should restore first #47873

Merged
merged 13 commits into from
Apr 9, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions src/Cli/dotnet/Commands/CliCommandStrings.resx
Original file line number Diff line number Diff line change
Expand Up @@ -483,6 +483,13 @@ This is equivalent to deleting project.assets.json.</value>
<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>{Locked="dotnet restore"}</comment>
</data>
<data name="CmdNoRestoreDescription" xml:space="preserve">
<value>Do not restore before running the command.</value>
</data>
<data name="CmdPackage" xml:space="preserve">
<value>PACKAGE_NAME</value>
</data>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,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 PackageListCommand(parseResult).Execute());

Expand Down
72 changes: 69 additions & 3 deletions src/Cli/dotnet/Commands/Package/List/PackageListCommand.cs
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@
using Microsoft.DotNet.Cli.Commands.NuGet;
using Microsoft.DotNet.Cli.Extensions;
using Microsoft.DotNet.Cli.Utils;
using System.Globalization;
using Microsoft.DotNet.Cli.Commands.MSBuild;

namespace Microsoft.DotNet.Cli.Commands.Package.List;

Expand All @@ -25,7 +27,71 @@ 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);
bool interactive = _parseResult.GetValue((CliOption<bool>)PackageListCommandParser.InteractiveOption);
restoreExitCode = RunRestore(projectFile, formatOption, interactive);
}

return restoreExitCode == 0
? NuGetCommand.Run(TransformArgs(projectFile))
: restoreExitCode;
}

private int RunRestore(string projectOrSolution, ReportOutputFormat formatOption, bool interactive)
{
List<string> args = ["-target:Restore", projectOrSolution];

if (formatOption == ReportOutputFormat.json)
{
args.Add("-noConsoleLogger");
}
else
{
args.Add("-consoleLoggerParameters:NoSummary");
args.Add("-verbosity:minimal");
}

args.Add($"-interactive:{interactive.ToString().ToLower()}");

MSBuildForwardingApp restoringCommand = new MSBuildForwardingApp(argsToForward: args);

int exitCode = 0;

try
{
exitCode = restoringCommand.Execute();
}
catch (Exception)
{
exitCode = 1;
}

if (exitCode != 0)
{
if (formatOption == ReportOutputFormat.json)
{
string jsonError = $$"""
{
"version": 1,
"problems": [
{
"text": "{{String.Format(CultureInfo.CurrentCulture, CliCommandStrings.Error_restore)}}",
"level": "error"
}
]
}
""";
Console.WriteLine(jsonError);
}
}

return exitCode;
}

internal static void EnforceOptionRules(ParseResult parseResult)
Expand All @@ -40,13 +106,13 @@ internal static void EnforceOptionRules(ParseResult parseResult)
}
}

private string[] TransformArgs()
private string[] TransformArgs(string projectOrSolution)
{
var args = new List<string>
{
"package",
"list",
GetProjectOrSolution()
projectOrSolution
};

args.AddRange(_parseResult.OptionValuesToBeForwarded(PackageListCommandParser.GetCommand()));
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,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 = CliCommandStrings.CmdNoRestoreDescription,
Arity = ArgumentArity.Zero
};

public static readonly CliOption VerbosityOption = new ForwardedOption<VerbosityOptions>("--verbosity", "-v")
{
Description = CliStrings.VerbosityOptionDescription,
Expand Down Expand Up @@ -113,6 +119,7 @@ private static CliCommand ConstructCommand()
command.Options.Add(InteractiveOption);
command.Options.Add(FormatOption);
command.Options.Add(OutputVersionOption);
command.Options.Add(NoRestore);
command.Options.Add(PackageCommandParser.ProjectOption);

command.SetAction((parseResult) => new PackageListCommand(parseResult).Execute());
Expand Down
10 changes: 10 additions & 0 deletions src/Cli/dotnet/Commands/xlf/CliCommandStrings.cs.xlf

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

10 changes: 10 additions & 0 deletions src/Cli/dotnet/Commands/xlf/CliCommandStrings.de.xlf

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

10 changes: 10 additions & 0 deletions src/Cli/dotnet/Commands/xlf/CliCommandStrings.es.xlf

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

10 changes: 10 additions & 0 deletions src/Cli/dotnet/Commands/xlf/CliCommandStrings.fr.xlf

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

10 changes: 10 additions & 0 deletions src/Cli/dotnet/Commands/xlf/CliCommandStrings.it.xlf

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

10 changes: 10 additions & 0 deletions src/Cli/dotnet/Commands/xlf/CliCommandStrings.ja.xlf

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

10 changes: 10 additions & 0 deletions src/Cli/dotnet/Commands/xlf/CliCommandStrings.ko.xlf

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

10 changes: 10 additions & 0 deletions src/Cli/dotnet/Commands/xlf/CliCommandStrings.pl.xlf

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

10 changes: 10 additions & 0 deletions src/Cli/dotnet/Commands/xlf/CliCommandStrings.pt-BR.xlf

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading