23

I am building an MVC4 web application with VS2012 professional with NuGet Package Manager version 2.2.31210. I have multiple projects in my solution, all sharing various packages I installed using NuGet. One of my projects is an MVC4 web application where I am using packages such as bootstrap, jquery UI, etc, all installed using NuGet.

When I clone a fresh copy of my entire solution from my repository and build my MVC4 project, the package restore feature seems to be working: it creates the packages directory under the solution direcotry and populates it will all the versions of the packages I expect to see. However, the content files do not get copied to the appropriate places in the MVC app directory. The weird thing is that it does create directories for the content, but does not copy the content files themselves.

For example, I am using the Twitter Bootstrap package which appears in the packages/Twitter.Bootstrap.2.2.2. In the MVC project a directory called bootstrap (containing css, img, and js directories) gets created in the Content directory. But, no css or js files are copied into those directories!

Does anyone have a clue what magic incantation I must utter to get the build to copy these content files from the NuGet packages directory?

AngCaruso
  • 570
  • 1
  • 4
  • 11
  • 1
    this seems to be tracked with this bug http://nuget.codeplex.com/workitem/1239 – Deepak Feb 20 '13 at 07:33
  • 13
    @Deepak This seems like a pretty major bug to me. I view the NuGet Package Restore feature as fundamentally broken if it does not copy files to the same locations they are copied upon initial installation of a package. – AngCaruso Feb 20 '13 at 14:54
  • It is by design as noted here [Common NuGet Misconceptions: Package Restore](https://jeffhandley.com/2013-12-10/nuget-package-restore-misconceptions). I've found link in the @FranciscoLopez answer repository – oleksa Mar 04 '20 at 09:52

5 Answers5

13

This is a very common issue we are all having. I've created an MSBuild Task NugetContentRestoreTask that will do this trick for you. Run the following command in the Package Manager Console:

Install Nuget Content Restore MSBuild Targets

    PM> Install-Package MSBuild.NugetContentRestore

The only thing left is to call it from your BeforeBuild Target with something like this:

Project File Targets

    <Target Name="BeforeBuild">
      <NugetContentRestoreTask SolutionDir="$(SolutionDir)" ProjectDir="$(ProjectDir)" />
    </Target>

You can take a look at the source repo and find it on nuget.org

Additional Content Folders

This nuget only includes the default folders scripts, images, fonts, and content, it is not a recursive directory includes. For additional content subfolders - you must assign the property AdditionalFolders.

    <Target Name="BeforeBuild">
        <NugetContentRestoreTask SolutionDir="$(SolutionDir)" ProjectDir="$(ProjectDir)" 
              AdditionalFolders="less;sass;common" />
    </Target>
Community
  • 1
  • 1
Francisco Lopez
  • 131
  • 1
  • 3
  • This is still relevant as nuget cli does not support a reliable way on a build agent to copy files - only seems to work with VS IDE tooling. [.NET Core still does not match support for `install.ps1` or `packages.config` behavior using `PackageReference`](https://github.com/dotnet/standard/issues/481). `Install.ps1` also seems to be [deprecated as there is no core support](https://github.com/NuGet/Home/issues/5963#issuecomment-391889708). – SliverNinja - MSFT Aug 17 '18 at 00:14
11

I have found a workaround, but it is ugly. By executing the following command in the NuGet Package Manager Console: Update-Package -Reinstall all the files are indeed copied to their proper places within the Mvc project Content and Scripts directories.

Unfortunately, this is risky because you are likely to end up with the wrong versions of certain packages. For example, in my case after the command finishes executing (which takes quite a while by the way), I end up with jQuery version 1.4.4. This is way old, and I assume it must be an explicit dependency of some other package that is being updated. So it appears that the order in which the packages actually get updated by NuGet is significant (it does not appear to parse the entire dependency tree for all packages and pick only the latest versions from the union of all dependencies, which seems like it would be the preferred behavior). Rather, as the command executes I see it replacing the jQuery package several times with different versions as it works its way through all the packages and their dependencies, only to end up with a very old version.

A similar approach is the execute the Update-Package -Reinstall command explicitly for each package that is causing my problem, but this is incredibly tedious and error prone.

The NuGet Package Restore feature should yield the same result as manually executing the Install-Package or Update-Package -Reinstall command for a package, but it does not.

AngCaruso
  • 570
  • 1
  • 4
  • 11
  • "Update-Package -Reinstall" fixed the issue for me (had issues with Microsoft.WindowsAzure.Storage / WindowsAzure.Storage - giving error for file CloudAnalyticsClient.cs) – Nick Niebling Sep 06 '16 at 13:59
  • You can also narrow only a project with `Update-Package -Reinstall -project YourProject -FileConflictAction OverwriteAll` Hope this helps. – John-Philip Feb 10 '17 at 09:33
4

I don't like to have the thirdparty JavaScript files under source control either. Thats why I've followed Jeff Handley advice in http://nuget.codeplex.com/workitem/2094 to create a solution my self. I didn't go the executable way, but created a nuget solution level package which does the trick.

http://www.nuget.org/packages/Baseclass.Contrib.Nuget.GitIgnoreContent/

It's tied to git, as it automatically updates the .gitignore file.

Short description:

Ignore nuget content files in git:

  • Generate entries in the .gitignore file to exclude nuget content files from the source repository

  • Restore nuget content files before building (Automatically in VS and manually with a powershell script

I've written a blog post describing how to use it. http://www.baseclass.ch/blog/Lists/Beitraege/Post.aspx?ID=9&mobile=0

Daniel Romero
  • 287
  • 2
  • 5
  • 1
    Daniel - getting this on Windows 10 ...Unable to find type [NuGet.VisualStudio.IRepositorySettings]. At D:\MOBILEDEV\ionic\Wenzaa\packages\Baseclass.Contrib.Nuget.GitIgnoreContent.0.0.2\tools\Baseclass.Contrib.Nuget.GitIgnoreContent.psm1:213 char:54 + ... $componentModel.GetService([NuGet.VisualStudio.IRepositorySettings]) + ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + CategoryInfo : InvalidOperation: (NuGet.VisualStudio.IRepositorySettings:TypeName) [], RuntimeException + FullyQualifiedErrorId : TypeNotFound – jessewolfe Dec 28 '16 at 09:11
  • Looks like package is not maintained anymore. Not working with VS2017 on Win10... – Emil Nov 27 '19 at 16:20
3

In Visual Studio 2015 Update 1, they now support contentFiles. The caveat with this is that it only works in projects that use project.json.

In reference to the problem that you are having, there is a good blog post that explains why you see this behaviour: NuGet Package Restore Common Misconceptions.

Connie Yau
  • 670
  • 5
  • 12
  • `project.json` is now deprecated - [`PackageReference` is now the preferred approach to managing `contentFiles`](https://learn.microsoft.com/en-us/nuget/reference/nuspec#including-content-files) – SliverNinja - MSFT Aug 17 '18 at 05:00
0

For my projects it turned out that content files work with PackageReferences only:

  1. Existing project with nuget references via packages.config
  2. Installed NuGet package with content files
  3. Build project

  4. No content files in output directory

  5. Conversion of packages.config to PackageReferences
  6. Build project

  7. Content files have been copied to output directory

IDE is Visual Studio 2017. The project is an application project which means it is in the old csproj format.

Nicolas
  • 754
  • 8
  • 22