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

fix: CLI Help missing package description #44954

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

ajpinedam
Copy link

@ajpinedam ajpinedam commented Nov 19, 2024

closes #44877

This PR updates the CLI dotnet help command to include the missing information about the package command.

As part of this change, we also fixed the dotnet package --help so that the package description is displayed correctly.

@dotnet-issue-labeler dotnet-issue-labeler bot added Area-Infrastructure untriaged Request triage from a team member labels Nov 19, 2024
@KalleOlaviNiemitalo
Copy link

Please add it here, too:

CliCommand command = new DocumentedCommand("package", DocsLink);

so that dotnet package --help will output it below the "Description:" heading:

Description:

Usage:
  dotnet package [command] [options]

Options:
  -?, -h, --help  Show command line help.

Commands:
  search <SearchTerm>  Searches one or more package sources for packages that match a search term. If no sources are specified, all sources defined in the NuGet.Config are used.

Compare to:

var command = new DocumentedCommand("list", DocsLink, LocalizableStrings.NetListCommand);

@ajpinedam ajpinedam force-pushed the dev/ajpinedam/fix.cli.help.description branch from f0ff8d2 to d15dced Compare November 20, 2024 03:53
@ajpinedam
Copy link
Author

Run output

Dotnet SDK Quick Run
dotnet_sdk_quick_run
Dotnet SDK Help Fixed adding Package to the output
dotnet_sdk_help_fixed
Dotnet SDK Package Help fixed adding Description
dotnet_sdk_package_help_fixed

@ajpinedam ajpinedam marked this pull request as ready for review November 20, 2024 14:19
@ajpinedam ajpinedam force-pushed the dev/ajpinedam/fix.cli.help.description branch from d15dced to ce8d822 Compare November 21, 2024 04:36
Copy link
Member

@baronfel baronfel left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for sending this!

@ajpinedam ajpinedam force-pushed the dev/ajpinedam/fix.cli.help.description branch from ce8d822 to c8a01b8 Compare November 21, 2024 06:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Area-Infrastructure untriaged Request triage from a team member
Projects
None yet
Development

Successfully merging this pull request may close these issues.

dotnet CLI help command does not show package
3 participants