Add details command by YuliiaKovalova · Pull Request #31743 · dotnet/sdk

YuliiaKovalova · 2023-04-12T12:19:54Z

Implements the item: dotnet/templating#6683

Add details command to display more information about a template package.

ghost · 2023-04-12T12:20:04Z

I couldn't figure out the best area label to add to this PR. If you have write-permissions please help me learn by adding exactly one area label.

YuliiaKovalova · 2023-04-12T12:23:07Z

@vlada-shubina, please take a look when you come back.

KalleOlaviNiemitalo · 2023-04-12T12:56:00Z

+  <data name="Command_Details_Description" xml:space="preserve">
+    <value>
+      Provides details for specified Nuget package.
+      The command checks if the package is installed locally, if it wasn't found, then it searches on the https://www.nuget.org/.</value>


Does this respect Package Source Mapping, or does this just always use https://www.nuget.org/?

@maridematte/ @YuliiaKovalova for details we should be able to use any configured NuGet source, right? This doesn't require non-NuGet-API metadata like search does.

Separately, @KalleOlaviNiemitalo I'm not sure if the NuGet API exposes PSM data or if it's all implementation details. @YuliiaKovalova can you check with that team?

YuliiaKovalova · 2023-05-03T12:57:30Z

Current output:

Feedback to it:
my initial impression is that all of the required content is there, but it feels like a wall of text - I wonder if we could make the output look/feel more modern with use of spacing, coloration, weight, etc. There's also a bit of duplicated content - logically there are 6 templates in the package, but from the user perspective there are only 2 templates (that each support 3 languages) - can we represent that by collapsing/grouping the templates and showing a list in the Languages portion instead?
also if we have URLs to things, we should make those clickable in the terminal
and for things we don't have urls for (I'm specifically thinking of the NuGet license data where you can specify an SPDX license key like MIT GPLv3, etc) we should provide a link to the matching SPDX license URL. for example, MIT should link to https://spdx.org/licenses/MIT
MIT License | Software Package Data Exchange (SPDX)
(we can do this because SPDX is a well-known format that NuGet is standardized on, see the full list here: https://spdx.org/licenses/)
SPDX License List | Software Package Data Exchange (SPDX)

KalleOlaviNiemitalo · 2023-05-03T14:34:09Z

for example, MIT should link to https://spdx.org/licenses/MIT

OK, I suppose that is better than https://licenses.nuget.org/MIT, as spdx.org also hosts licenses like GFDL-1.2-invariants-only, which is not allowed on nuget.org but might be referenced by NuGet packages hosted elsewhere.

baronfel · 2023-05-03T14:36:50Z

@KalleOlaviNiemitalo that's actually a great point - since NuGet.org is our source of truth here, we should use licenses.nuget.org instead of spdx. Have to bias towards consistency here.

KalleOlaviNiemitalo · 2023-05-03T14:43:48Z

For accessibility, the text from the image in #31743 (comment):

PS C:\ykovalova_sdk\yk_fork_8\sdk> dotnet new details NUnit3.DotNetNew.Template --version "1.0.0"
   NUnit3.DotNetNew.Template
      Details:  Project and item templates containing basic NUnit 3 Test Project.
      Authors:  Aleksei Kharlov
      Owners:  akharlov, rprouse
      License Metadata:
         License Url:  https://github.com/halex2005/dotnet-new-nunit/blob/master/LICENSE
      Repository Url:  https://github.com/halex2005/dotnet-new-nunit
      Templates:
         NUnit 3 Test Project
            Short Names:  nunit
            Author:  Aleksei Kharlov aka halex2005 (codeofclimber.ru)
            Tags:  Test/NUnit
            Languages:  F#
            Details:  A project that contains NUnit tests that can run on .NET Core on Windows, Linux and macOS
         NUnit 3 Test Item
            Short Names:  nunit-test
            Author:  Aleksei Kharlov aka halex2005 (codeofclimber.ru)
            Tags: Test/NUnit
            Languages:  F#
            Details:  A item that contains NUnit tests
         NUnit 3 Test Project
            Short Names:  nunit
            Author:  Aleksei Kharlov aka halex2005 (codeofclimber.ru)
            Tags:  Test/NUnit
            Languages:  C#
            Details:  A project that contains NUnit tests that can run on .NET Core on Windows, Linux and macOS
         NUnit 3 Test Item
            Short Names:  nunit-test
            Author:  Aleksei Kharlov aka halex2005 (codeofclimber.ru)
            Tags: Test/NUnit
            Languages:  C#
            Details:  A item that contains NUnit tests
         NUnit 3 Test Project
            Short Names:  nunit
            Author:  Aleksei Kharlov aka halex2005 (codeofclimber.ru)
            Tags:  Test/NUnit
            Languages:  VB
            Details:  A project that contains NUnit tests that can run on .NET Core on Windows, Linux and macOS
         NUnit 3 Test Item
            Short Names:  nunit-test
            Author:  Aleksei Kharlov aka halex2005 (codeofclimber.ru)
            Tags: Test/NUnit
            Languages:  VB
            Details:  A item that contains NUnit tests
PS C:\ykovalova_sdk\yk_fork_8\sdk>

KalleOlaviNiemitalo · 2023-05-03T14:50:00Z

https://github.com/NuGet/Home/wiki/Packaging-License-within-the-nupkg-(Technical-Spec)#approach-for-in-house-packages-%2D-unlicensed suggests UNLICENSED as the license expression for in-house packages that should not be posted to public feeds. Neither https://spdx.org/licenses/UNLICENSED nor https://licenses.nuget.org/UNLICENSED explains that meaning. I think dotnet details should recognize UNLICENSED and not translate it to a useless URL.

baronfel · 2023-05-03T14:51:48Z

Here is my sketched up feedback for the display output - note the # are comments on each line of output:

PS C:\ykovalova_sdk\yk_fork_8\sdk> dotnet new details NUnit3.DotNetNew.Template --version "1.0.0"
   NUnit3.DotNetNew.Template
      Details:  Project and item templates containing basic NUnit 3 Test Project.
      Authors:  Aleksei Kharlov
      Owners:  akharlov, rprouse # each of these should link to the owners page on nuget.org (e.g. https://www.nuget.org/profiles/akharlov)
      License Metadata: # depending on how the license is provided in the package, this should change
         License Url:  https://github.com/halex2005/dotnet-new-nunit/blob/master/LICENSE # clickable link
         License Expression: MIT # link to licenses.nuget.org/MIT per https://learn.microsoft.com/en-us/nuget/nuget-org/licenses.nuget.org#request
      Repository Url:  https://github.com/halex2005/dotnet-new-nunit # clickable link
      Templates:
         NUnit 3 Test Project
            Short Names:  nunit
            Author:  Aleksei Kharlov aka halex2005 (codeofclimber.ru)
            Tags:  Test/NUnit # tags should be split on '/' and each tag should be a clickable link to the NuGet.org query for that tag: https://www.nuget.org/packages?q=Tags%3A%22Test%22
            Languages:  C#, F#, VB # group the languages available for each template
            Details:  A project that contains NUnit tests that can run on .NET Core on Windows, Linux and macOS
         NUnit 3 Test Item
            Short Names:  nunit-test
            Author:  Aleksei Kharlov aka halex2005 (codeofclimber.ru)
            Tags: Test/NUnit
            Languages:  C#, F#, VB
            Details:  A item that contains NUnit tests

KalleOlaviNiemitalo · 2023-05-03T14:58:51Z

also if we have URLs to things, we should make those clickable in the terminal

Windows Terminal already recognizes URLs in the output and makes them clickable, without needing .NET SDK to mark them specially.
I don't know whether there are terminals that support hyperlinks but do not recognize URLs automatically. (There certainly are terminals that do not support hyperlinks at all.)
If you wanted to display some other text but make it a hyperlink to a URL (e.g. display a license expression and link to the license text), then you'd have to explicitly output OSC 8 to mark the hyperlink. https://github.com/Alhadis/OSC8-Adoption/

baronfel · 2023-05-03T15:09:56Z

@KalleOlaviNiemitalo yes, all feedback about clickable links is predicated on the terminal supporting control codes to signal that. This is a muscle that the CLI and MSBuild are learning this release cycle and we're fairly confident it in - though of course there should always be an explicit opt out.

KalleOlaviNiemitalo · 2023-05-03T15:20:44Z

If a package has an embedded license file, how will the command display that?

baronfel · 2023-05-03T15:22:18Z

Might just have to be a file:// URI to the nuspec and let it open with whatever file handler the users system has configured for nuspec files.

maridematte · 2023-05-21T23:05:05Z

The current display of details looks like this:

I added the table to not feel like a wall of text.

maridematte · 2023-05-21T23:15:20Z

This is the text from the above image:

NUnit3.DotNetNew.Template
   Details:  Project and item templates containing basic NUnit 3 Test Project.
   Authors:
      Aleksei Kharlov
   Owners:
      https://nuget.org/profiles/akharlov
      https://nuget.org/profiles/rprouse
   License Metadata:
      License Url: https://github.com/halex2005/dotnet-new-nunit/blob/master/LICENSE
      Repository Url: https://github.com/halex2005/dotnet-new-nunit

   Templates:
      Template Name         Short Name  Type     Tags        Language
      --------------------  ----------  -------  ----------  --------
      NUnit 3 Test Project  nunit       project  Test/NUnit  C#,F#,VB
      NUnit 3 Test Item     nunit-test  item     Test/NUnit  C#,F#,VB

baronfel · 2023-05-22T14:45:14Z

I like this a lot @maridematte. Will we be able to make those URLs clickable? That's the only major usability feature I see missing. Happy to see this getting close!

maridematte · 2023-05-23T12:24:19Z

The urls are clickable currently, if you're using windows terminal you can press ctrl + left click to navigate to the url.

…va/add_details_command

YuliiaKovalova · 2023-06-21T12:15:23Z

Looks good to me!

YuliiaKovalova · 2023-06-23T10:26:51Z

@maridematte, I would recommend adding in output 3 more fields: Version, Source Feed, and Prefix Reserved flag.

vlada-shubina · 2023-06-23T11:05:06Z

The current display of details looks like this:
I added the table to not feel like a wall of text.

this output misses:

version of the package
NuGet feed the information is taken from
indication if prefix is reserved

vlada-shubina · 2023-06-23T11:06:53Z

Tests: i would recommend to cover at least the following scenarios

the package is not installed
- the package is from NuGet.org (with / without version, with templates information)
- the package is from other feed (with / without version, without package information0
the package is installed
- the package is from NuGet.org
- the package is from other feed
- the package is installed from local *.nupkg
- the package is the folder

baronfel

There are a few notes about localization of user-facing strings and a couple layout notes that we spoke about offline as well. Overall I like the state of this a lot!

baronfel · 2023-06-27T15:24:11Z

+        private IEnumerable<PackageSource> LoadNuGetSources(IEnumerable<string>? additionalSources, bool includeNuGetFeed)
+        {
+            IEnumerable<PackageSource> defaultSources;
+            string currentDirectory = string.Empty;
+            try
+            {
+                currentDirectory = Directory.GetCurrentDirectory();
+                ISettings settings = global::NuGet.Configuration.Settings.LoadDefaultSettings(currentDirectory);
+                PackageSourceProvider packageSourceProvider = new PackageSourceProvider(settings);
+                defaultSources = packageSourceProvider.LoadPackageSources().Where(source => source.IsEnabled);
+                if (includeNuGetFeed)
+                {
+                    var nuGetFeed = new PackageSource(NugetOrgFeed);
+                    defaultSources = defaultSources.Append(nuGetFeed);
+                }
+            }


Future expansion: I think if string packageIdentity was added to this method, then we could pretty easily add support for PackageSourceMapping to this feature via something like this:

PackageSourceMapping packageSourceMapping = PackageSourceMapping.GetPackageSourceMapping(settings); IReadOnlyList<string> validPackageSources = packageSourceMapping.GetConfiguredPackageSources(packageIdentity); defaultSources = packageSourceProvider.LoadPackageSources().Where(source => source.IsEnabled && (validPackageSources?.Contains(source.Name) ?? true));

We should consider PSM support all-up for templating, though.

…ev/ykovalova/add_details_command

YuliiaKovalova · 2023-06-28T17:00:14Z

[celebrate] Yuliia Kovalova reacted to your message:

…

________________________________ From: Mariana Dematte ***@***.***> Sent: Wednesday, June 28, 2023 4:58:02 PM To: dotnet/sdk ***@***.***> Cc: Yuliia Kovalova ***@***.***>; Mention ***@***.***> Subject: Re: [dotnet/sdk] Add details command (PR #31743) Merged #31743<#31743> into main. — Reply to this email directly, view it on GitHub<#31743 (comment)>, or unsubscribe<https://github.com/notifications/unsubscribe-auth/AWYM53UASIZI3JPOVJV6WITXNRPBVANCNFSM6AAAAAAW3THVKA>. You are receiving this because you were mentioned.Message ID: ***@***.***>

YuliiaKovalova added 2 commits April 12, 2023 14:18

add detials command

d0f1b20

fix

32d63f6

ghost added the untriaged Request triage from a team member label Apr 12, 2023

remove comment

d040aa9

KalleOlaviNiemitalo reviewed Apr 12, 2023

View reviewed changes

Comment thread src/Cli/Microsoft.TemplateEngine.Cli/TemplatePackageCoordinator.cs Outdated

KalleOlaviNiemitalo reviewed Apr 12, 2023

View reviewed changes

Comment thread src/Cli/Microsoft.TemplateEngine.Cli/Commands/SymbolStrings.resx Outdated

fix templates search creteria

88d0216

YuliiaKovalova mentioned this pull request May 3, 2023

Developers get NuGet package details in dotnet new search results dotnet/templating#5861

Closed

3 tasks

maridematte added 4 commits May 5, 2023 14:21

merge main

dc6095d

Changed templates in package to display as a table

eb3af4d

Solved some PR comments

33ae638

Added some links to nuget site and changed formatting

0fcceec

Changed to handle added exception from template package

e196164

vlada-shubina reviewed Jun 16, 2023

View reviewed changes

Comment thread src/Cli/Microsoft.TemplateEngine.Cli/TemplatePackageCoordinator.cs Outdated

maridematte added 5 commits June 19, 2023 19:02

Added tests

2792aad

Solved Pr comments and adjusted some tests

49e08cf

Merge branch 'main' of https://github.com/dotnet/sdk into dev/ykovalo…

e07d9ea

…va/add_details_command

Updated test result

4296972

Updated a few more tests

97e13af

maridematte marked this pull request as ready for review June 20, 2023 13:20

maridematte requested a review from a team as a code owner June 20, 2023 13:20

This was referenced Jun 22, 2023

Dotnet new details command dotnet/docs#35919

Merged

Update documentation for .NET 8 release dotnet/templating#6465

Open

vlada-shubina reviewed Jun 23, 2023

View reviewed changes

Comment thread src/Tests/dotnet-new.Tests/DotnetNewDetailsTest.cs Outdated

maridematte added 4 commits June 23, 2023 12:15

Added a few more properties to display

1d492a3

Added more tests and solved PR comments

dc120f0

Adjusted some tests

b7404ea

Adjusting more tests for unix pathing

4fa02a2

baronfel approved these changes Jun 27, 2023

View reviewed changes

fix review comments - add more test cases

ee0a4e4

YuliiaKovalova force-pushed the dev/ykovalova/add_details_command branch from 2385aa9 to ee0a4e4 Compare June 27, 2023 20:28

YuliiaKovalova and others added 5 commits June 27, 2023 22:30

Merge remote-tracking branch 'origin/dev/ykovalova/main_merge' into d…

33a203e

…ev/ykovalova/add_details_command

reorder test output

e8c570a

Solved PR comments

ee4ab0d

Solving merge conflicts

5deb8fb

Missed a couple localizations

8cda2ac

maridematte merged commit 282088f into dotnet:main Jun 28, 2023

Youssef1313 mentioned this pull request Jan 25, 2024

[Bug] dotnet publish for maccatalyst does not produce a fat app unoplatform/uno.templates#487

Closed

Conversation

YuliiaKovalova commented Apr 12, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ghost commented Apr 12, 2023

Uh oh!

YuliiaKovalova commented Apr 12, 2023

Uh oh!

KalleOlaviNiemitalo Apr 12, 2023

Choose a reason for hiding this comment

Uh oh!

baronfel May 22, 2023

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

YuliiaKovalova commented May 3, 2023

Uh oh!

KalleOlaviNiemitalo commented May 3, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

baronfel commented May 3, 2023

Uh oh!

KalleOlaviNiemitalo commented May 3, 2023

Uh oh!

KalleOlaviNiemitalo commented May 3, 2023

Uh oh!

baronfel commented May 3, 2023

Uh oh!

KalleOlaviNiemitalo commented May 3, 2023

Uh oh!

baronfel commented May 3, 2023

Uh oh!

KalleOlaviNiemitalo commented May 3, 2023

Uh oh!

baronfel commented May 3, 2023

Uh oh!

maridematte commented May 21, 2023

Uh oh!

maridematte commented May 21, 2023

Uh oh!

baronfel commented May 22, 2023

Uh oh!

maridematte commented May 23, 2023

Uh oh!

Uh oh!

YuliiaKovalova commented Jun 21, 2023

Uh oh!

Uh oh!

YuliiaKovalova commented Jun 23, 2023

Uh oh!

vlada-shubina commented Jun 23, 2023

Uh oh!

vlada-shubina commented Jun 23, 2023

Uh oh!

baronfel left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

baronfel Jun 27, 2023

Choose a reason for hiding this comment

Uh oh!

Uh oh!

YuliiaKovalova commented Jun 28, 2023 via email

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

YuliiaKovalova commented Apr 12, 2023 •

edited

Loading

KalleOlaviNiemitalo commented May 3, 2023 •

edited

Loading