Managing dependencies with .NET Core SDK 1.0

With the move of .NET Core projects from project.json to csproj and MSBuild, a significant investment also happened that resulted in unification of the project file and assets that allow tracking of dependencies. For .NET Core projects this is similar to what project.json did. There is no separate JSON or XML file that tracks NuGet dependencies. With this change, we've also introduced another type of reference into the csproj syntax called the <PackageReference>.

This document describes the new reference type. It also shows how to add a package dependency using this new reference type to your project.

The new <PackageReference> element

The <PackageReference> has the following basic structure:

<PackageReference Include="PACKAGE_ID" Version="PACKAGE_VERSION" />

If you are familiar with MSBuild, it will look familiar to the other reference types that already exist. The key is the Include statement which specifies the package id that you wish to add to the project. The <Version> child element specifies the version to get. The versions are specified as per NuGet version rules.

Note

If you are not familiar with the overall csproj syntax, see the MSBuild project reference documentation for more information.

Adding a dependency that is available only in a specific target is done using conditions like in the following example:

<PackageReference Include="PACKAGE_ID" Version="PACKAGE_VERSION" Condition="'$(TargetFramework)' == 'netcoreapp1.0'" />

The above means that the dependency will only be valid if the build is happening for that given target. The $(TargetFramework) in the condition is a MSBuild property that is being set in the project. For most common .NET Core applications, you will not need to do this.

Adding a dependency to your project

Adding a dependency to your project is straightforward. Here is an example of how to add Json.NET version 9.0.1 to your project. Of course, it is applicable to any other NuGet dependency.

When you open your project file, you will see two or more <ItemGroup> nodes. You will notice that one of the nodes already has <PackageReference> elements in it. You can add your new dependency to this node, or create a new one; it is completely up to you as the result will be the same.

In this example we will use the default template that is dropped by dotnet new console. This is a simple console application. When we open up the project, we first find the <ItemGroup> with already existing <PackageReference> in it. We then add the following to it:

<PackageReference Include="Newtonsoft.Json" Version="9.0.1" />

After this, we save the project and run the dotnet restore command to install the dependency.

Note

Starting with .NET Core 2.0, you don't have to run dotnet restore because it's run implicitly by all commands, such as dotnet build and dotnet run, that require a restore to occur. It's still a valid command in certain scenarios where doing an explicit restore makes sense, such as continuous integration builds in Visual Studio Team Services or in build systems that need to explicitly control the time at which the restore occurs.

The full project looks like this:

<Project Sdk="Microsoft.NET.Sdk">
  <PropertyGroup>
    <OutputType>Exe</OutputType>
    <TargetFramework>netcoreapp1.0</TargetFramework>
  </PropertyGroup>

  <ItemGroup>
    <PackageReference Include="Newtonsoft.Json" Version="9.0.1" />
  </ItemGroup>
</Project>

Removing a dependency from the project

Removing a dependency from the project file involves simply removing the <PackageReference> from the project file.