`dotnet package list` command should restore first #47873

Nigusu-Allehu · 2025-03-25T16:56:50Z

#47400 had to many conflicts.
Fixes: NuGet/Home#13406

Description

This PR

Adds implicit restore to dotnet package list command or dotnet list package (Switch verb and noun for package/reference add/remove/list Fixes #9650 #45384)

ScreenShots

package list --project [project]
--format json
restore error
restore error: --format json

src/Cli/dotnet/commands/Package/list/ListPackageReferencesCommand.cs

jeffkl · 2025-03-26T16:10:30Z

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

+
+    private int RunRestore(string projectOrSolution, ReportOutputFormat formatOption)
+    {
+        MSBuildForwardingApp restoringCommand = new MSBuildForwardingApp(argsToForward: ["-target:restore", projectOrSolution, "-noConsoleLogger"]);


Since the implicit restore isn't logging anything, what if its takes more than a few seconds? I think the user might think something is wrong. We could pass console logger parameters to produce some output

-consoleLoggerParameters:Verbosity=Minimal;NoSummary

We should try to align with test and run here and use the same logger configuration - ideally this would use terminal logger by default like every other command in the CLI.

I'm not so sure, the output of this command is the information about the packages that a project is referencing. Its not running tests (which are potentially long running) and its not building a project and its dependencies.

The only reason we need to run restore first is because the project.assets.json file provides all of the information and we want to make sure its up-to-date. The only reason I propose we have any output at all about restore is in the case that it takes a while, I don't want users to think that dotnet list package is hung.

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

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

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

Nigusu-Allehu · 2025-04-07T23:38:25Z

review request: @dotnet/nuget-team any suggestions/comments? The more time this takes the more conflicts keep coming up

jebriede · 2025-04-08T17:46:25Z

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

+            : restoreExitCode;
+    }
+
+    private int RunRestore(string projectOrSolution, ReportOutputFormat formatOption, bool interactive)


Nit: This method does a lot of things to prepare the command to run. Consider adding private helper methods to set up the options and generate the json output and call them from this method.

jebriede · 2025-04-08T17:49:37Z

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

+  <data name="Error_restore" xml:space="preserve">
+    <value>Restore failed. Run `dotnet restore` for more details on the issue.</value>


Question: Is this wording consistent with other output or was this wording vetted?

On that note, why can't we output the error from dotnet restore without them having to run dotnet restore explicitly?

Question: Is this wording consistent with other output or was this wording vetted?

This the first adoption of implicit restore for nuget commands. Others like dotnet nuget why will probably follow suit as well.

On that note, why can't we output the error from dotnet restore without them having to run dotnet restore explicitly?

When the command includes --format json, we avoid printing any additional output to ensure the JSON remains valid. To enforce this, I passed -noConsoleLogger to MSBuild. Since this operation runs in a separate process, capturing and displaying errors becomes tricky. If we were running the restore in-process, however, we could have easily captured the errors and logged them ourselves.

I actually think this is a perfectly valid response, but I'll bang this drum on baronfel's behalf:
Output should go to stdout. Errors (and other incidental output) should go to stderr. That way you can have beautiful, clean output in stdout and still have access to all the information you'd want in stderr.

I'm assuming NuGet doesn't do that historically, so you're sending errors to stdout as well just because that's how it currently works?

Though if you're going to get an error anyway, does the user really still care that the output of --format json is preserved?

That is good point! Tracking here now NuGet/Home#14239

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

marcpopMSFT · 2025-04-08T20:32:52Z

@Nigusu-Allehu there are a bunch of conflicts to resolve fyi.

dotnet-policy-service · 2025-04-15T17:17:29Z

@Nigusu-Allehu: Added needs-breaking-change-doc-created label because this PR has the breaking-change label.

When you commit this breaking change:

Create and link to this PR and the issue a matching issue in the dotnet/docs repo using the breaking change documentation template, then remove this needs-breaking-change-doc-created label.
Ask a committer to mail the .NET SDK Breaking Change Notification email list.

You can refer to the .NET SDK breaking change guidelines

Nigusu-Allehu · 2025-05-13T18:42:31Z

breaking change doc: dotnet/docs#46103

ghost added Area-Infrastructure untriaged Request triage from a team member labels Mar 25, 2025

Nigusu-Allehu self-assigned this Mar 25, 2025

Nigusu-Allehu marked this pull request as ready for review March 25, 2025 17:08

Nigusu-Allehu requested a review from a team as a code owner March 25, 2025 17:08

Nigusu-Allehu requested review from jebriede and jeffkl March 25, 2025 17:37

zivkan reviewed Mar 25, 2025

View reviewed changes

src/Cli/dotnet/commands/Package/list/ListPackageReferencesCommand.cs Outdated Show resolved Hide resolved

Nigusu-Allehu requested a review from zivkan March 25, 2025 22:02

This was referenced Mar 26, 2025

slow macOS - "##[error]The job running on agent Azure Pipelines 9 ran longer than the maximum time of 60 minutes." dotnet/dnceng#1883

Open

The Operation will be canceled. The next steps may not contain expected logs. dotnet/dnceng#3008

Open

Nigusu-Allehu force-pushed the dev-nyenework-dlp-implicit-restore branch from 5ff051a to a8235d6 Compare March 26, 2025 15:04

jeffkl reviewed Mar 26, 2025

View reviewed changes

This was referenced Mar 26, 2025

The active test run was aborted. Reason: Test host process crashed dotnet/dnceng#451

Open

dotnet-watch tests failing #40006

Open

[dotnet watch] Cannot open project Lib.fsproj because extension fsproj is not associated with a language #46378

Open

Forgind reviewed Mar 27, 2025

View reviewed changes

Nigusu-Allehu requested a review from jeffkl March 28, 2025 20:08

zivkan reviewed Mar 28, 2025

View reviewed changes

src/Cli/dotnet/Commands/Package/List/ListPackageReferencesCommand.cs Outdated Show resolved Hide resolved

Nigusu-Allehu requested review from zivkan and Forgind March 28, 2025 23:06

Forgind approved these changes Mar 31, 2025

View reviewed changes

jebriede approved these changes Apr 8, 2025

View reviewed changes

aortiz-msft approved these changes Apr 8, 2025

View reviewed changes

src/Cli/dotnet/Commands/Package/List/ListPackageReferencesCommand.cs Outdated Show resolved Hide resolved

src/Cli/dotnet/Commands/Package/List/ListPackageReferencesCommand.cs Outdated Show resolved Hide resolved

Nigusu-Allehu and others added 4 commits April 8, 2025 14:10

dotnet list package restores

2587f81

else

09e9376

undo

238d067

use string literals

5f114bf

Nigusu-Allehu and others added 6 commits April 8, 2025 14:10

log restore progress for --format console

68c2070

undo

82ccaef

undo

3aefb60

cleanup

e67eaa3

false interactive

452b93c

merge main

c5f737f

Nigusu-Allehu force-pushed the dev-nyenework-dlp-implicit-restore branch from a443cdd to c5f737f Compare April 8, 2025 21:37

Nigusu-Allehu and others added 3 commits April 8, 2025 15:25

resolve conflict

e2b69e2

resolve completetion

1a39768

comment

1b792dc

aortiz-msft approved these changes Apr 8, 2025

View reviewed changes

zivkan approved these changes Apr 9, 2025

View reviewed changes

Nigusu-Allehu merged commit 5a637f3 into main Apr 9, 2025
39 checks passed

Nigusu-Allehu deleted the dev-nyenework-dlp-implicit-restore branch April 9, 2025 15:15

Nigusu-Allehu mentioned this pull request Apr 9, 2025

dotnet package list should use Console.error for errors and incidental output, not Console.out NuGet/Home#14239

Open

aortiz-msft added the breaking-change Using this label will notify dotnet/compat and trigger a request to file a compat bug label Apr 15, 2025

dotnet-policy-service bot added the needs-breaking-change-doc-created label Apr 15, 2025

Nigusu-Allehu mentioned this pull request May 13, 2025

[Breaking change]: dotnet package list command behavior change dotnet/docs#46103

Open

3 tasks

Nigusu-Allehu removed the needs-breaking-change-doc-created label May 13, 2025

		<data name="Error_restore" xml:space="preserve">
		<value>Restore failed. Run `dotnet restore` for more details on the issue.</value>

dotnet package list command should restore first #47873

dotnet package list command should restore first #47873

Uh oh!

Conversation

Nigusu-Allehu commented Mar 25, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

ScreenShots

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Nigusu-Allehu commented Apr 7, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

marcpopMSFT commented Apr 8, 2025

Uh oh!

Uh oh!

dotnet-policy-service bot commented Apr 15, 2025 • edited by Nigusu-Allehu Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Nigusu-Allehu commented May 13, 2025

Uh oh!

Uh oh!

`dotnet package list` command should restore first #47873

`dotnet package list` command should restore first #47873

Nigusu-Allehu commented Mar 25, 2025 •

edited

Loading

Nigusu-Allehu commented Apr 7, 2025 •

edited

Loading

dotnet-policy-service bot commented Apr 15, 2025 •

edited by Nigusu-Allehu

Loading