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.

Sign up for GitHub

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

Add --configFile, --format and --verbosity options to dotnet package search #12970

Merged
merged 14 commits into from
Jan 4, 2024
Merged

Add --configFile, --format and --verbosity options to dotnet package search #12970

Changes from 3 commits
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
772da0c
Add formating option to dotnet package search
Nigusu-Allehu Oct 26, 2023
0b41564
add default
Nigusu-Allehu Oct 26, 2023
583cce4
source name
Nigusu-Allehu Oct 26, 2023
57e3efb
Add --verbosity option
Nigusu-Allehu Oct 30, 2023
e103b5d
add configFile option
Nigusu-Allehu Nov 7, 2023
bb20091
Remove list format
Nigusu-Allehu Nov 10, 2023
daa69dd
Update proposed/2023/Add-dotnet-search.md
Nigusu-Allehu Nov 10, 2023
02c58d1
Clean up
Nigusu-Allehu Nov 10, 2023
a094b88
Merge branch 'dev-nyenework-nuget-formatting-option' of https://githu…
Nigusu-Allehu Nov 10, 2023
0bc3825
vulnerabilities than vulnerable
Nigusu-Allehu Nov 10, 2023
8caafd6
Clean up
Nigusu-Allehu Nov 16, 2023
0259e5c
Move to accepted folder
Nigusu-Allehu Nov 21, 2023
156bbd7
Show Owners
Nigusu-Allehu Nov 29, 2023
68f3aac
Merge branch 'dev' into dev-nyenework-nuget-formatting-option
Nigusu-Allehu Nov 30, 2023
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
82 changes: 70 additions & 12 deletions proposed/2023/Add-dotnet-search.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ The `package search [search terms] [options]` command will have the following op
|---------|:----------|
| `--source` | A source to search |
| `--exact-match` | Return exact matches only as a search result |
| `--format` | Format the output accordingly. Either Table, List, or Json. The default value is Table.|
| `--prerelease` | Allow prerelease packages to be shown. |
| `--interactive` | Allows the command to stop and wait for user input or action (for example to complete authentication).|
| `--take` | The number of results to return. The default value is 20.|
Expand All @@ -43,21 +44,78 @@ This option will specify a list of sources to search from. If a source is not sp
- This option will allow for users to be able to search and have only exact matches as an output.
- For example if a user uses `dotnet package search Newtonsoft.Json`

Source: nuget.org
| Package ID | Latest Version | Authors | Downloads |
|---------------------------------------------|----------------|---------|-----------------|
| Newtonsoft.Json | 13.0.3 | | 3,829,822,911 |
| Newtonsoft.Json.Bson | 1.0.2 | | 554,641,545 |
| Newtonsoft.Json.Schema | 3.0.15 | | 39,648,430 |
| Microsoft.AspNetCore.Mvc.NewtonsoftJson | 7.0.12 | | 317,067,823 |
...
Source: nuget.org
| Package ID | Latest Version | Authors | Downloads |
Nigusu-Allehu marked this conversation as resolved.
Show resolved Hide resolved
|---------------------------------------------|----------------|---------|-----------------|
| Newtonsoft.Json | 13.0.3 | | 3,829,822,911 |
Nigusu-Allehu marked this conversation as resolved.
Show resolved Hide resolved
| Newtonsoft.Json.Bson | 1.0.2 | | 554,641,545 |
| Newtonsoft.Json.Schema | 3.0.15 | | 39,648,430 |
| Microsoft.AspNetCore.Mvc.NewtonsoftJson | 7.0.12 | | 317,067,823 |
...

- Using ``dotnet package search Newtonsoft.Json --exact-match`` on the other side will have the following output

Source: nuget.org
| Package ID | Latest Version | Authors | Downloads |
|---------------------------------------------|----------------|---------|-----------------|
| Newtonsoft.Json | 13.0.3 | | 3,829,822,911 |
Source: nuget.org
| Package ID | Latest Version | Authors | Downloads |
|---------------------------------------------|----------------|---------|-----------------|
| Newtonsoft.Json | 13.0.3 | | 3,829,822,911 |

#### **Option `--format`**

This option will allow the specification of the output format. The option will take one of these three arguments: Table, List, or Json.

- `--format Table` the output will be in a tabular form as shown below
Nigusu-Allehu marked this conversation as resolved.
Show resolved Hide resolved

Source: nuget.org
| Package ID | Latest Version | Authors | Downloads |
|---------------------------------------------|----------------|---------|-----------------|
| Newtonsoft.Json | 13.0.3 | | 3,829,822,911 |
- `--format List` : each package will be listed line by line

>NuGet.CommandLine | 6.7.0 | Downloads: N/A
>NuGet.CommandLine.XPlat | 6.7.0 | Downloads: N/A
>NuGet.Commands | 6.7.0 | Downloads: N/A
>NuGet.exe | 3.4.3 | Downloads: N/A

- `--format Json` : A json output will be outputted. It will contain the following metdata.
Nigusu-Allehu marked this conversation as resolved.
Show resolved Hide resolved
- Source
- Author
- Package ID
- LatestVersion
Nigusu-Allehu marked this conversation as resolved.
Show resolved Hide resolved
- Downloads
- Description
- Vulnerabilities
- Deprecation
- Project URL

The output will take the following format

[
{
"source": "source Name1",
"packagesList": [
Nigusu-Allehu marked this conversation as resolved.
Show resolved Hide resolved
{
"author": "",
Nigusu-Allehu marked this conversation as resolved.
Show resolved Hide resolved
"deprecation": "",
"description": "",
"downloads": "",
Nigusu-Allehu marked this conversation as resolved.
Show resolved Hide resolved
"latestVersion": "",
"packageId": "",
"projectUrl": "",
"source": "",
"vulnerabilities": [
{
"advisoryUrl": "",
"severity": ""
}
]
}
]
},
{
"source": "source Name2",...
}
]

### Technical explanation

Expand Down