PackageReference is missing copy files to output feature

[rainersigwald]

Moved from dotnet/msbuild#1880 on behalf of original poster @Ciantic.

I'm trying to use PhantomJS NuGET package, but it's not possible with PackageReference:

<PackageReference Include="PhantomJS" Version="2.1.1">
      <IncludeAssets>all</IncludeAssets>
</PackageReference>

It does not do anything. I'd expect it to copy the files inside PhantomJS package to the output directory so I could use the binary file inside the package.

I think PackageReference does not have support using packages such as PhantomJS which have no .NET code in it, just random files.

I suggest a feature to be able to copy files from a NuGET package to output directory

<PackageReference Include="PhantomJS" Version="2.1.1">
      <CopyToOutputDirectory>tools/*</CopyToOutputDirectory> <!-- new feature here -->
</PackageReference>

Note that the PhantomJS has folder called "tools" inside, that needs to be copied to output directory to make it usable in the app.

[Ciantic]

NuGET is reading the csproj file when I run dotnet build?

Let me clarify, when I run dotnet build I want it to copy the tools/* from PhantomJS referenced package to output directory so I can use it in the dotnet app.

I think NuGet is not in that process.

[rainersigwald]

The MSBuild engine runs logic from a variety of sources when you run dotnet build. The targets and tasks that handle the Restore target and extracting information from NuGet packages for consumption in the build are owned by the NuGet team, so this is the best place for reporting problems/asking for features related to the handling of NuGet packages.

[rrelyea]

NuGet packages that work with Packages.config, don't always work in transitive NuGet environments (projects using Project.json or PackageReferences).

In this case, it looks like Phantom.js has "content" and tools\install.ps1.

Packages that work in transitive NuGet environments must use "contentFiles" instead of "content" -- you can have both, if a package would like to work in both environments.
Also, install.ps1/uninstall.ps1 doesn't execute in transitive NuGet environments -- however, init.ps1 will work in both Packages.config and transitive environments.

[Ciantic]

I've opened also a StackOverflow question. I'd hate to put a 18MB phantomjs.exe to the repository of the app, but that seems like the only way right now with .NET Core.

I gather you are not opposed to adding a feature to PackageReference since this is not closed. I think it's not reasonable to assume that these old NuGet packages are going to get a change just for .NET core. I don't even want to run a install.ps1 (what ever it does) just copy the tools/phantomjs/phantomjs.exe to the output directory during build.

P.S. I've now tried to contact the PhantomJS NuGet Package author (@whyleee) and gave the suggestion to look at this thread how to fix the package.

[JasonRowe]

Is there a work around to get the new style csproj PackageReference to work with content files in a nuget package?

example nuspec that worked before package reference.

<package >
  <metadata>
 ...
  </metadata>
  <files>
	<file src="..\bin\any\*" target="Content/tools"/>
  </files>
</package>

In old csproj projects, when installing this nuget file all the files would show up in a tools folder in the project root. Now nothing happens.

The StackOverflow discussion on this issue mentions the work around is contentFiles. Using contentFiles will copy the files to the bin folder when using "dotnet build" but nothing like how it use to work. Is that the best I can do at this point?

<package >
  <metadata>
   ...
      <contentFiles>
      <files include="**" buildAction="None" copyToOutput="true" flatten="false" />
    </contentFiles>
  </metadata>
  <files>
	<file src="..\bin\{{config}}\*" target="contentFiles\any\any\tools\some_exe_and_stuff"/>
	<file src="..\bin\{{config}}\*" target="content\tools\some_exe_and_stuff"/>
  </files>
</package>

[sandersaares]

I was linked here from https://developercommunity.visualstudio.com/content/problem/89472/nuget-packages-with-ps1-content-files-are-not-bein.html as this issue is supposedly "identical". I would question that claim but the original got closed and there seems nothing I can do about it, so I will add my issue description here.

I have a NuGet package that delivers a set of PowerShell scripts (.ps1 files).

The intended usage is to deliver these files into the target project as a folder in the filesystem directly under the project the package is installed into (e.g. installing into C:\Foo\Foo.csproj should create C:\Foo\xxx\yyy.ps1).

When I use VS2017 in packages.config mode, it works fine.

When I use VS2017 in PackageReference mode, none of the files show up in either the filesystem or Solution Explorer.

I tried both using just "/content" paths and the new contentFiles feature. Neither option made anything show up in my project. I cannot distribute my scripts anymore. I am currently looking at using Paket, which is a 3rd party NuGet alternative that appears to be far more flexible and easily usable. It is a shame to see NuGet un-fixing the problems that NuGet once fixed!

[marcusien]

I'd be interested for a solution where content files would be copied in the project cause i got less files that I want to compile from a package with gulp, but gulp does not see the less files in the projects, so I don't have any css files generated