The information is accurate as of this writing, as far as I know.
- What's the Change?
- What Are the Advantages?
- Which Visual Studio Editions and Project Types Does It Work With?
- Is There a Converter?
- Manually Converting to PackageReference.
- Can I Convert With a Script?
What's the Change?
Today, a project's NuGet package information is stored in a project-level packages.config folder. The assemblies are stored in a separate packages folder, usually at the solution level. The project's .csproj file contains Reference elements that point to the assemblies.
Packages.config format folder layout and text samples
Argonautics |_packages |_ParseText.126.96.36.199 |_lib |_net45 |_ParseText.dll |_PersistText.dll |_Argonautics.sln |_PlainPlanning |_PlainPlanning.cproj <Reference Include="ParseText.dll, Version=188.8.131.52, Culture=neutral, processorArchitecture=MSIL"> <HintPath>..\packages\ParseText.184.108.40.206\lib\net45\ParseText.dll</HintPath> <Private>True</Private> </Reference> <Reference Include="PersistText.dll, Version=220.127.116.11, Culture=neutral, processorArchitecture=MSIL"> <HintPath>..\packages\ParseText.18.104.22.168\lib\net45\PersistText.dll</HintPath> <Private>True</Private> </Reference> |_packages.config <package id="ParseText" version="1.0.4" targetFramework="net45" />
The PackageReference format moves the package information out of packages.config into the .csproj file, and removes the assembly references. The packages folder is removed, as well, in favor of a user-profile folder found at
PackageReference format folder layout and text samples
Argonautics |_Argonautics.sln |_PlainPlanning |_PlainPlanning.cproj <PackageReference Include="ParseText"> <Version>1.0.4</Version> </PackageReference>
|_%userprofile%\.nuget\packages |_ParseText.22.214.171.124 |_lib |_net45 |_ParseText.dll |_PersistText.dll
When the project builds, Visual Studio finds the packages in the expected location and copies the assembly dependencies to the bin folder.
What Are the Advantages?
- Binaries that can be restored are very hard to accidentally include in source control.
- Only the package information is shown in References, which is usually what the developer wants to see.
- Package restore is faster because files aren't copied to a solution folder. Continuous Integration benefits, as well, by having just one well-known package location.
- Importantly, since the paths to assemblies aren't stored in the .csproj file, version control thrash due to differences between developer environments is eliminated. No more
update-package -restorebecause DLLs can't be found.
- The PackageReference elemnt allows more flexibity and direct use by MSBuild.
- For NuGet Package authors, the nuspec information is stored directly in the project file, not in a .nuspect file. Also, Build and Pack tasks are included in MSBuild.
Which Visual Studio Editions and Project Types Does It Work With?
PackageReference is availabe in Visual Studio 2017. As of this writing, per NuGet.org:
Also, some packages capabilities are not fully compatible with PackageReference.
Some examples of scenarios that will not be supported include content folders (we have introduced ContentFiles), XDT transforms, PowerShell scripts i.e. install.ps1 and uninstall.ps1 (only init.ps1 is supported) .
Obviously ASP.NET support is important, and projects may depend on packages that aren't compatible. However, its lack doesn't prevent migrating compatible projects.
Is There a Converter?
Yes, there is! It's currently available in the Visual Studio Preview edition. It has some known issues, but seems to work well. See the References for a link to instructions.
Manually Converting to PackageReference.
This works with ASP.NET, too, but is more likely to have problems because of content files (stylesheets, scripts, etc). Need to look into this further.
- Backup solution
- Open solution
- Open a project's packages.config
- Open the project's .csproj file
- In another text editor, create the PackageReference elements.
<package id="Newtonsoft.Json" version="10.0.3" targetFramework="net461" />
<ItemGroup> <PackageReference Include="[PackageId]" Version="[PackageVersion]" /> <PackageReference Include="Newtonsoft.Json" Version="10.0.3" /> </ItemGroup>
- Right-click References > Manage Nuget Packages
- Choose the Installed tab.
- Uninstall the packages for the project only.
There could be more cleanup in .csproj, such as deleting extraneous .target references*
- Copy the ItemGroup into the project file and save.
- Delete packages.config
- Open Package Manager Console, select the project, and run (for example)
Update-Package -ProjectName Sms.Web.Verifications -Reinstall
I reocmmend doing a file/folder diff from the previous version (easy if using version control). This will reveal problems that a build/run may not catch.
Can I Convert With a Script?
I haven't tried a script, yet, but I don't see why not.
- NuGet PackageReference format (package references in project files) | Microsoft Docs
- Migrate to PackageReference with 3 clicks
- NuGet is now fully integrated into MSBuild
- What is NuGet and what does it do? | Microsoft Docs <= This is the top of MS documentation
- Evolution of the NuGet PackageReference – .NET Development Addict
- Solution-wide Nuget package version handling with MsBuild 15+ | StrathWeb. A free flowing web tech monologue.
- Customize your build - Visual Studio | Microsoft Docs
- Release Notes | Microsoft Docs
- Migrate to PackageReference forgets to add PackageReferences! · Issue #7241 · NuGet/Home
- No "Migrate packages.config to PackageReference" · Issue #905 · NuGet/docs.microsoft.com-nuget
- By NuGet project team (https://github.com/NuGet/Media) [Apache License 2.0 (http://www.apache.org/licenses/LICENSE-2.0)], via Wikimedia Commons
- By Microsoft Corporation () [Public domain], via Wikimedia Commons