5.8 KiB
Floating Versions in the Package Manager UI
- Status: In Review
- Author(s): Martin Ruiz
- Issue: 3788 PackageReference with a star in version is displayed under the updates tab/incorrectly represented in the installed tab
Problem Background
In PackageReference the user can specify a version range or a floating version, but the package manager UI has poor support for this, displaying an incorrect installed version.
If the user indicates a floating version for any package (eg 5.*) the PM UI will display the minimum version possible (5.0.0) as installed even though the resolved version could be different of the resolved version in the command dotnet list package.
Furthermore the user cannot specify a version range free hand.
Current behavior
Project File and Solution Explorer
Project Level PM UI
Installed Tab
In the installed tab we show a list of packages installed. In this list the resolved version is not the correct one when using floating versions.
Updates Tab
With the current behavior even if the user indicated a floating version, such as *, for the package version, the UI will tell the user that there is an update available which is misleading.
Solution level PM UI
Installed Tab
The Solution PM UI also has the list of packages installed but it's unclear for what project the resolved version is. Even tough when looking in the details of the package it is visible that the resolved version when using floating versions is wrong.
The requested and resolved versions are not correct because dotnet list package shows a different resolved version.
Updates Tab
Who are the customers
All customers that use the Package Manager UI to install or update packages.
Goals
-
Allow users see the correct version of the package resolved while using floating versions in the Package Manager UI in Project View.
-
Allow users to input floating versions to install in the Package Manager UI.
-
Allow users to distinguish between requested and resolved package versions in the Solution View.
Non-Goals
- Any multi targeting improvements overall.
- packages.config are not in the scope as they work different, version ranges doesn't work.
- No special support is being added for lock-files.
Solution
Installed Tab
Display the correct resolved version of each package in this tab will correct the displayed version in this tab and avoid the package being listed in the Updates Tab.
Floating Version Display in Project View
When searching for a package in the Browse Tab or Installed Tab the user is not able to select a floating or range version to install. We will implement a Combo Box that will autocomplete the available version of the package with the user input.
This feature will enable the option * and ranges to be selected while installing/updating a package. Also enables scenarios beyond floating version and improves the UX.
Floating Version
Range Version
ComboBox
- The versions will be displayed in NuGetVersion ordering.
- The version will be validated it when the user selects or hits enter.
Floating Version Display in Solution View
We will add a new column to show the requested version to match the behavior of dotnet list package command. Show correct highest resolved version in the solution in the package list view.
Future Work
Open Questions
Should we show available updates for packages that use custom version ranges or floating versions that don’t resolve to the latest version?
Example
Considerations
Should we allow people to install package versions within a custom range without overwriting the project file?
We will not allow users to install package versions within a custom range without overwriting the project file. The project file version is a statement of intent and the version resolved should be resolved the same regardless whether you are installing it through the Package Manager UI, the command line or hand editing.
Currently we don’t display any package related warning in the PM UI.
During the implementation we will ensure that the UI is properly accessible as suggested in (https://github.com/NuGet/NuGet.Client/blob/dev/docs/feature-guide.md#visual-studio-ui-considerations)
References
NuGet Build Integrated Project handling of floating versions and ranges in Visual Studio Client