Add nuget package status indicator proof-of-concept #8539
Conversation
adamint
added
the
Feature-Dependency-Node
| base.Initialize(); | ||
| #pragma warning restore RS0030 | ||
|
|
||
| _broadcastBlock = DataflowBlockSlim.CreateBroadcastBlock<IProjectVersionedValue<Dictionary<string, DiagnosticLevel>>>(nameFormat: $"{nameof(DependencyNugetUpdateBlock)} {1}"); |
There was a problem hiding this comment.
| _broadcastBlock = DataflowBlockSlim.CreateBroadcastBlock<IProjectVersionedValue<Dictionary<string, DiagnosticLevel>>>(nameFormat: $"{nameof(DependencyNugetUpdateBlock)} {1}"); | |
| _broadcastBlock = DataflowBlockSlim.CreateBroadcastBlock<IProjectVersionedValue<Dictionary<string, DiagnosticLevel>>>(nameFormat: $"{nameof(DependencyNugetUpdateBlock)} {{1}}"); |
| namespace Microsoft.VisualStudio.ProjectSystem.Tree.Dependencies; | ||
|
|
||
| [Export(typeof(IDependencyNugetUpdateBlock))] | ||
| internal class DependencyNugetUpdateBlock: ProjectValueDataSourceBase<Dictionary<string, DiagnosticLevel>>, IDependencyNugetUpdateBlock |
There was a problem hiding this comment.
| internal class DependencyNugetUpdateBlock: ProjectValueDataSourceBase<Dictionary<string, DiagnosticLevel>>, IDependencyNugetUpdateBlock | |
| internal class DependencyNuGetUpdateBlock : ProjectValueDataSourceBase<Dictionary<string, DiagnosticLevel>>, IDependencyNugetUpdateBlock |
| nameof(DiagnosticLevel.Warning) => DiagnosticLevel.Warning, | ||
| nameof(DiagnosticLevel.Error) => DiagnosticLevel.Error, | ||
| nameof(DiagnosticLevel.UpgradeAvailable) => DiagnosticLevel.UpgradeAvailable, | ||
| nameof(DiagnosticLevel.Deprecation) => DiagnosticLevel.Deprecation, | ||
| nameof(DiagnosticLevel.Vulnerability) => DiagnosticLevel.Vulnerability, |
There was a problem hiding this comment.
I'm not sure about replacing the string literals with nameof. The strings are defined in MSBuild data. The C# enum is not explicitly tied to that. In some cases we have XAML rules with generated classes that provide constants for these values, but that's not the case here.
Consider in future that someone renames an enum member. It's not obvious that such a change would break our binding to the MSBuild item metadata contract.
| switch (DiagnosticLevel) | ||
| { | ||
| case DiagnosticLevel.UpgradeAvailable: | ||
| return KnownMonikers.OfficeWord2013; | ||
| case DiagnosticLevel.Warning: | ||
| return IconSet.UnresolvedIcon; | ||
| case DiagnosticLevel.Deprecation: | ||
| return KnownMonikers.OfficeSharePoint2013; | ||
| case DiagnosticLevel.Error: | ||
| return IconSet.UnresolvedIcon; | ||
| case DiagnosticLevel.Vulnerability: | ||
| return KnownMonikers.OfficeExcel2013; | ||
| default: | ||
| throw new ArgumentOutOfRangeException(); | ||
| } |
There was a problem hiding this comment.
To be clear (I know this is a draft) but we should consider adding unresolved/deprecation/vulnerability icon members to IconSet. The Dependency class applies to all kinds of dependencies, not just packages. If another dependency type used one of these new diagnostic levels, we'd end up showing a NuGet package icon for it if we hard coded them here.
This comment is based on the assumption that we end up with package reference icons with new overlays for the three new states.
For non-package dependencies we would likely re-use the warning/error icons for those diagnostic levels, as we don't expect to display them and therefore wouldn't ask the design team to produce such icons for us.
Brief history detour: These icons used to separate the base icon from the overlay. However in 17.0 the design team wanted finer control over how the overlay appeared, and so baked a flattened form of each combination into its own icon.
There was a problem hiding this comment.
@drewnoakes so what exactly would be requested to be created of the design team? Just the overlays with no nuget package icon?
There was a problem hiding this comment.
For each new overlay, you'd need a version of it displayed on top of the NuGet icon. That is, baked into a single image for each overlay.
| namespace Microsoft.VisualStudio.ProjectSystem.Tree; | ||
|
|
||
| [ProjectSystemContract(ProjectSystemContractScope.UnconfiguredProject, ProjectSystemContractProvider.Private, Cardinality = ImportCardinality.ExactlyOne)] | ||
| internal interface IDependencyNugetUpdateBlock : IProjectValueDataSource<Dictionary<string, DiagnosticLevel>> |
There was a problem hiding this comment.
| internal interface IDependencyNugetUpdateBlock : IProjectValueDataSource<Dictionary<string, DiagnosticLevel>> | |
| internal interface IDependencyNuGetUpdateBlock : IProjectValueDataSource<Dictionary<string, DiagnosticLevel>> |
|
@adamint Howdy. The related issue to this was closed. Would it make sense to close this PR and reopen it if the related issue is reopened? |
This proof-of-concept obtains package vulnerability/updatable/deprecation info from the dotnet cli.
vulnerable = excel
deprecated = sharepoint
upgrade available = word
Issues:
Resolves #8136
Microsoft Reviewers: Open in CodeFlow