Skip to content

Commit d18e905

Browse files
CopilotmitchdennyMitch Denny
authored
Clean up version selection display in aspire new and aspire add commands (#12187)
* Initial plan * Update version display to show 'based on nuget.config' for implicit channel packages Co-authored-by: mitchdenny <[email protected]> * Add SourceDetails property to PackageChannel for better version source visibility Co-authored-by: mitchdenny <[email protected]> * Make SourceDetails computation internal to PackageChannel with resource string Co-authored-by: mitchdenny <[email protected]> * Add comprehensive tests for PackageChannel SourceDetails logic Co-authored-by: mitchdenny <[email protected]> * Tweaks. * Remove pointless tests. --------- Co-authored-by: copilot-swe-agent[bot] <[email protected]> Co-authored-by: mitchdenny <[email protected]> Co-authored-by: Mitch Denny <[email protected]>
1 parent 8314505 commit d18e905

20 files changed

+488
-8
lines changed

‎src/Aspire.Cli/Commands/AddCommand.cs‎

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -270,9 +270,7 @@ internal class AddCommandPrompter(IInteractionService interactionService) : IAdd
270270
// Helper to keep labels consistently formatted: "Version (source)"
271271
static string FormatVersionLabel((string FriendlyName, NuGetPackage Package, PackageChannel Channel) item)
272272
{
273-
var pkg = item.Package;
274-
var source = pkg.Source is not null && pkg.Source.Length > 0 ? pkg.Source : item.Channel.Name;
275-
return $"{pkg.Version} ({source})";
273+
return $"{item.Package.Version} ({item.Channel.SourceDetails})";
276274
}
277275

278276
async Task<(string FriendlyName, NuGetPackage Package, PackageChannel Channel)> PromptForChannelPackagesAsync(

‎src/Aspire.Cli/Commands/NewCommand.cs‎

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -158,10 +158,8 @@ internal class NewCommandPrompter(IInteractionService interactionService) : INew
158158
// Local helpers
159159
static string FormatPackageLabel((NuGetPackage Package, PackageChannel Channel) item)
160160
{
161-
// Keep it concise: "Id Version"
162-
var pkg = item.Package;
163-
var source = pkg.Source is not null && pkg.Source.Length > 0 ? pkg.Source : item.Channel.Name;
164-
return $"{pkg.Version} ({source})";
161+
// Keep it concise: "Version (source)"
162+
return $"{item.Package.Version} ({item.Channel.SourceDetails})";
165163
}
166164

167165
async Task<(NuGetPackage Package, PackageChannel Channel)> PromptForChannelPackagesAsync(

‎src/Aspire.Cli/Commands/UpdateCommand.cs‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,11 @@ protected override async Task<int> ExecuteAsync(ParseResult parseResult, Cancell
4646

4747
var channels = await _packagingService.GetChannelsAsync(cancellationToken);
4848

49-
var channel = await InteractionService.PromptForSelectionAsync(UpdateCommandStrings.SelectChannelPrompt, channels, (c) => c.Name, cancellationToken);
49+
var channel = await InteractionService.PromptForSelectionAsync(
50+
UpdateCommandStrings.SelectChannelPrompt,
51+
channels,
52+
(c) => $"{c.Name} ({c.SourceDetails})",
53+
cancellationToken);
5054

5155
await _projectUpdater.UpdateProjectAsync(projectFile!, channel, cancellationToken);
5256
}

‎src/Aspire.Cli/Packaging/PackageChannel.cs‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
// The .NET Foundation licenses this file to you under the MIT license.
33

44
using Aspire.Cli.NuGet;
5+
using Aspire.Cli.Resources;
56
using Semver;
67
using NuGetPackage = Aspire.Shared.NuGetPackageCli;
78

@@ -14,6 +15,28 @@ internal class PackageChannel(string name, PackageChannelQuality quality, Packag
1415
public PackageMapping[]? Mappings { get; } = mappings;
1516
public PackageChannelType Type { get; } = mappings is null ? PackageChannelType.Implicit : PackageChannelType.Explicit;
1617
public bool ConfigureGlobalPackagesFolder { get; } = configureGlobalPackagesFolder;
18+
19+
public string SourceDetails { get; } = ComputeSourceDetails(mappings);
20+
21+
private static string ComputeSourceDetails(PackageMapping[]? mappings)
22+
{
23+
if (mappings is null)
24+
{
25+
return PackagingStrings.BasedOnNuGetConfig;
26+
}
27+
28+
var aspireMapping = mappings.FirstOrDefault(m => m.PackageFilter.StartsWith("Aspire", StringComparison.OrdinalIgnoreCase));
29+
var allPackagesMapping = mappings.FirstOrDefault(m => m.PackageFilter == PackageMapping.AllPackages);
30+
31+
if (aspireMapping is not null)
32+
{
33+
return aspireMapping.Source;
34+
}
35+
else
36+
{
37+
return allPackagesMapping?.Source ?? PackagingStrings.BasedOnNuGetConfig;
38+
}
39+
}
1740

1841
public async Task<IEnumerable<NuGetPackage>> GetTemplatePackagesAsync(DirectoryInfo workingDirectory, CancellationToken cancellationToken)
1942
{

‎src/Aspire.Cli/Resources/PackagingStrings.Designer.cs‎

Lines changed: 68 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎src/Aspire.Cli/Resources/PackagingStrings.resx‎

Lines changed: 124 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,124 @@
1+
<?xml version="1.0" encoding="utf-8"?>
2+
<root>
3+
<!--
4+
Microsoft ResX Schema
5+
6+
Version 2.0
7+
8+
The primary goals of this format is to allow a simple XML format
9+
that is mostly human readable. The generation and parsing of the
10+
various data types are done through the TypeConverter classes
11+
associated with the data types.
12+
13+
Example:
14+
15+
... ado.net/XML headers & schema ...
16+
<resheader name="resmimetype">text/microsoft-resx</resheader>
17+
<resheader name="version">2.0</resheader>
18+
<resheader name="reader">System.Resources.ResXResourceReader, System.Windows.Forms, ...</resheader>
19+
<resheader name="writer">System.Resources.ResXResourceWriter, System.Windows.Forms, ...</resheader>
20+
<data name="Name1"><value>this is my long string</value><comment>this is a comment</comment></data>
21+
<data name="Color1" type="System.Drawing.Color, System.Drawing">Blue</data>
22+
<data name="Bitmap1" mimetype="application/x-microsoft.net.object.binary.base64">
23+
<value>[base64 mime encoded serialized .NET Framework object]</value>
24+
</data>
25+
<data name="Icon1" type="System.Drawing.Icon, System.Drawing" mimetype="application/x-microsoft.net.object.bytearray.base64">
26+
<value>[base64 mime encoded string representing a byte array form of the .NET Framework object]</value>
27+
<comment>This is a comment</comment>
28+
</data>
29+
30+
There are any number of "resheader" rows that contain simple
31+
name/value pairs.
32+
33+
Each data row contains a name, and value. The row also contains a
34+
type or mimetype. Type corresponds to a .NET class that support
35+
text/value conversion through the TypeConverter architecture.
36+
Classes that don't support this are serialized and stored with the
37+
mimetype set.
38+
39+
The mimetype is used for serialized objects, and tells the
40+
ResXResourceReader how to depersist the object. This is currently not
41+
extensible. For a given mimetype the value must be set accordingly:
42+
43+
Note - application/x-microsoft.net.object.binary.base64 is the format
44+
that the ResXResourceWriter will generate, however the reader can
45+
read any of the formats listed below.
46+
47+
mimetype: application/x-microsoft.net.object.binary.base64
48+
value : The object must be serialized with
49+
: System.Runtime.Serialization.Formatters.Binary.BinaryFormatter
50+
: and then encoded with base64 encoding.
51+
52+
mimetype: application/x-microsoft.net.object.soap.base64
53+
value : The object must be serialized with
54+
: System.Runtime.Serialization.Formatters.Soap.SoapFormatter
55+
: and then encoded with base64 encoding.
56+
57+
mimetype: application/x-microsoft.net.object.bytearray.base64
58+
value : The object must be serialized into a byte array
59+
: using a System.ComponentModel.TypeConverter
60+
: and then encoded with base64 encoding.
61+
-->
62+
<xsd:schema id="root" xmlns="" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:msdata="urn:schemas-microsoft-com:xml-msdata">
63+
<xsd:import namespace="http://www.w3.org/XML/1998/namespace" />
64+
<xsd:element name="root" msdata:IsDataSet="true">
65+
<xsd:complexType>
66+
<xsd:choice maxOccurs="unbounded">
67+
<xsd:element name="metadata">
68+
<xsd:complexType>
69+
<xsd:sequence>
70+
<xsd:element name="value" type="xsd:string" minOccurs="0" />
71+
</xsd:sequence>
72+
<xsd:attribute name="name" use="required" type="xsd:string" />
73+
<xsd:attribute name="type" type="xsd:string" />
74+
<xsd:attribute name="mimetype" type="xsd:string" />
75+
<xsd:attribute ref="xml:space" />
76+
</xsd:complexType>
77+
</xsd:element>
78+
<xsd:element name="assembly">
79+
<xsd:complexType>
80+
<xsd:attribute name="alias" type="xsd:string" />
81+
<xsd:attribute name="name" type="xsd:string" />
82+
</xsd:complexType>
83+
</xsd:element>
84+
<xsd:element name="data">
85+
<xsd:complexType>
86+
<xsd:sequence>
87+
<xsd:element name="value" type="xsd:string" minOccurs="0" msdata:Ordinal="1" />
88+
<xsd:element name="comment" type="xsd:string" minOccurs="0" msdata:Ordinal="2" />
89+
</xsd:sequence>
90+
<xsd:attribute name="name" type="xsd:string" use="required" msdata:Ordinal="1" />
91+
<xsd:attribute name="type" type="xsd:string" msdata:Ordinal="3" />
92+
<xsd:attribute name="mimetype" type="xsd:string" msdata:Ordinal="4" />
93+
<xsd:attribute ref="xml:space" msdata:Ordinal="5" />
94+
</xsd:complexType>
95+
</xsd:element>
96+
<xsd:element name="resheader">
97+
<xsd:complexType>
98+
<xsd:sequence>
99+
<xsd:element name="value" type="xsd:string" minOccurs="0" msdata:Ordinal="1" />
100+
</xsd:sequence>
101+
<xsd:attribute name="name" type="xsd:string" use="required" />
102+
</xsd:complexType>
103+
</xsd:element>
104+
</xsd:choice>
105+
</xsd:complexType>
106+
</xsd:element>
107+
</xsd:schema>
108+
<resheader name="resmimetype">
109+
<value>text/microsoft-resx</value>
110+
</resheader>
111+
<resheader name="version">
112+
<value>2.0</value>
113+
</resheader>
114+
<resheader name="reader">
115+
<value>System.Resources.ResXResourceReader, System.Windows.Forms, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089</value>
116+
</resheader>
117+
<resheader name="writer">
118+
<value>System.Resources.ResXResourceWriter, System.Windows.Forms, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089</value>
119+
</resheader>
120+
<data name="BasedOnNuGetConfig" xml:space="preserve">
121+
<value>based on NuGet.config</value>
122+
<comment>Source details text shown for packages from implicit channel or channels without Aspire* package source mappings</comment>
123+
</data>
124+
</root>

‎src/Aspire.Cli/Resources/xlf/PackagingStrings.cs.xlf‎

Lines changed: 12 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎src/Aspire.Cli/Resources/xlf/PackagingStrings.de.xlf‎

Lines changed: 12 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎src/Aspire.Cli/Resources/xlf/PackagingStrings.es.xlf‎

Lines changed: 12 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎src/Aspire.Cli/Resources/xlf/PackagingStrings.fr.xlf‎

Lines changed: 12 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)