resharper-nuget

This plugin for ReSharper adds support for NuGet references to ReSharper. It supports ReSharper 8.x, 7.1 and 6.1.

DEPRECATED

Please note that this plugin is now deprecated. The functionality has been rolled into the main product as of ReSharper 9.1. This repo is left as a sample (albeit slightly out of date).

What does it do?

ReSharper has a Context Action on undefined types that looks at assemblies referenced in other projects for that type. If it finds a match, it will add a reference to the assembly, and import the namespace, fixing up the undefined error.

However, ReSharper always adds the assembly as a file reference, even if the assembly is part of a NuGet package. This means NuGet's referencing is bypassed, and the packages.config file isn't updated, dependencies aren't installed, and things don't work when it's time to update the package.

This plugin makes ReSharper invoke NuGet when adding a reference to an assembly in a NuGet package.

How do I get it?

If you wish to just install a copy of the plugins without building yourself:

• Download the latest zip file: resharper-nuget.1.2.zip
• Extract everything
• Run the appropriate batch file for your version of ReSharper, e.g. Install-NuGetSupport.7.1.bat for ReSharper 7.1, or Install-NuGetSupport.6.0.bat for ReSharper 6.0

How does it work?

From the end user's perspective, there is no noticeable user interface. When you use a type that lives in an assembly that is not part of the assemblies currently referenced, but is in an assembly referenced by other projects in the solution, ReSharper will mark the type as an error, and display the context action icon when the cursor is on the type name (the red light bulb). Pressing Alt-Enter displays the action "reference 'asm' and use 'Asm.Type'". This plugin hooks into that process. Selecting that action for an assembly referenced as part of a NuGet package will be installed by NuGet.

For example, if project Test1 adds a NuGet reference to the xUnit.net: extensions package, NuGet will also download the xUnit.net package, and extracts the files to the packages\xunit.1.9.1\lib\net20 and packages\xunit.extensions.1.9.1\lib\net20 folders. NuGet will then add a reference to xunit.extensions.dll and xunit.dll, and run any script files that are in the packages.

If you then add a new project to the solution, Test2, and before adding any references, try to use TheoryAttribute, ReSharper will mark that usage as an error. It also looks for any types called TheoryAttribte in any assembly that's known in the solution. It finds Xunit.Extensions.TheoryAttribute from xunit.extensions.dll being referenced by Test1, and offers a quick-fix red lightbulb for the usage of TheoryAttribute. When you hit alt-enter, you'll see a menu option that reads "reference 'xunit.extensions' and use 'Xunit.Extensions.TheoryAttribute'".

Without the plugin, ReSharper would now just add a reference to packages\xunit.extensions.1.9.1\lib\net20\xunit.extensions.dll file. With the plugin, ReSharper knows that this is a NuGet pacakge, and invokes NuGet to install xunit.extensions in the Test2 project. NuGet adds the references, updates the packages.config file, and also installs the dependency on the xunit package.

Building

To build the source, you need the ReSharper 7.1 SDK installed (ReSharper 6.1.1 support requires the ReSharper 6.1 SDK, which can be downloaded from the previous versions archive). Then just open the src\resharper-nuget.sln file and build.

Version

The current version is 1.2. It has been tested with Visual Studio 2012 and 2010, and supports ReSharper 7.1.1 and 6.1.1. See the ReleaseNotes wiki page for more details.

Contributing

Feel free to raise issues on GitHub, or fork the project and send a pull request.

Roadmap

Please see the Issues tab on JetBrains' GitHub page.