Package validation in NuGet Package Explorer

Creating a symbol package can be challenging the first time, especially when you're trying to do it manually or in your own build script, without using the nuget.exe pack -symbols command. Fortunately NuGet Package Explorer 2.0 has a great new feature: package analysis. It runs various rules to verify package correctness and best practices. These rules can also be provided through plugins, so we wrote our own to provide validation rules for symbol packages.

NuGet Package Explorer with the SymbolSource plugin

Features

The current release contains a DLL and PDB viewer that displays binary and symbol hashes, and the list of source files that have been compiled in. There is also a number of validation rules that produce the following:

  • (warning) Assembly compiled without symbol support
  • (warning) Missing symbol file for assembly
  • (warning) Unnecessary symbol file for assembly
  • (warning) Orphan symbol file found
  • (error) Mismatched assembly and symbol hashes
  • (error) Missing source file

Download

SymbolSource.Integration.NuGet.PackageExplorer.dll

Install

You can use one of two ways to install a plugin in NuGet Package Explorer:

  • Go to Tools -> Plugin Manager -> Add and select the DLL.
  • Copy the DLL to %LOCALAPPDATA%\NuGet\PackageExplorerPlugins.

Both methods do the exact same thing.

Source

We are releasing this plugin and one of our internal libraries that it requires as open source. Have a look at GitHub if you're interested in how the plugin was implemented or if you would like to contribute to this project:

Posted by Marcin Mikołajczak (TripleEmcoder) on Wednesday, September 07, 2011

blog comments powered by Disqus