How do I declare a development dependency in project.json?

Question

In my project.json, I need to refer to a library that I'm using during development, but don't want included in the project output. This is common for things like static analyzers and other tools.

Before project.json, this was handled by a metadata tag in the package .nuspec file. But, this no longer works (as far as I know) for projects following the new JSON standard.

How do I declare a development-only dependency in the new standard?

Nate Barbettini · Accepted Answer · 2016-06-27T15:33:08.213

3

As of 1.0.0-rc1, the correct syntax is:

"dependencies": {
    "HelloShared": { 
        "version": "0.1-beta-*",
        "type": "build"
    }
},

This declares HelloShared as a build (development-only) dependency of the current project.

I found this example in dnx/samples/HelloWorld/project.json on Github.

edited Jun 27 '16 at 15:33

answered Mar 17 '16 at 21:09

Nate Barbettini

51,256
26
134
147

hey, is it possible to do it permamently for packages? Whenever I update HelloShared, type gets cleared – MistyK Jun 27 '16 at 12:06
@Zbigniew How are you updating the package? That doesn't sound right. – Nate Barbettini Jun 27 '16 at 15:31
Through visual studio – MistyK Jun 27 '16 at 17:00
Create a sample project and try to install Json, then add type: build, then change the json version. It will remove type: build – MistyK Jun 27 '16 at 17:05
@Zbigniew Try editing the version string in `project.json` instead of updating with the Nuget GUI. – Nate Barbettini Jun 27 '16 at 23:53
It's not a perfect solution because it's quite a big project. How is this possible that BASIC functionality is not implemented correctly? – MistyK Jun 28 '16 at 07:13
Anyway I just noticed that with project.json all dependencies are not included in a nuget packages. – MistyK Jun 28 '16 at 08:03
@Zbigniew The Visual Studio tooling is still in "preview" and has known bugs. It's not perfect. – Nate Barbettini Jun 28 '16 at 16:18

Danny van der Kraan · Answer 2 · 2017-05-29T07:59:15.967

0

Project.json has a publishOptions:exclude section.

edited May 29 '17 at 07:59

answered Mar 17 '16 at 21:52

Danny van der Kraan

5,344
6
31
41

Link is broken. – ket May 26 '17 at 16:21
Fixed the link, but I wouldn't use project.json anymore if I were you... Migrate to .csproj: https://learn.microsoft.com/en-us/dotnet/core/tools/project-json-to-csproj – Danny van der Kraan May 29 '17 at 08:00

How do I declare a development dependency in project.json?

2 Answers2