NuGetizer 1.2.1

dotnet add package NuGetizer --version 1.2.1
NuGet\Install-Package NuGetizer -Version 1.2.1
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="NuGetizer" Version="1.2.1">
  <PrivateAssets>all</PrivateAssets>
  <IncludeAssets>runtime; build; native; contentfiles; analyzers</IncludeAssets>
</PackageReference>
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add NuGetizer --version 1.2.1
#r "nuget: NuGetizer, 1.2.1"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install NuGetizer as a Cake Addin
#addin nuget:?package=NuGetizer&version=1.2.1

// Install NuGetizer as a Cake Tool
#tool nuget:?package=NuGetizer&version=1.2.1

NuGetizer is a drop-in replacement for the .NET SDK built-in Pack (a.k.a. "SDK Pack") which instantly supercharges your ability to customize and extend the packing process in a consistent and easy to understand process designed and centered around best practices in MSBuild design and extensibility.

Yes, this means you'll never need to write a .nuspec by hand ever again, no matter how complicated or advanced your packing scenarios are.

Comprehensive and intuitive heuristics built from experience building nuget packages for over a decade make getting started with NuGetizer seamless and easy, while still accomodating the most advanced scenarios through plain MSBuild extensibility. Out of the box, NuGetizer supports:

  • Drop-in replacement for the built-in .NET SDK Pack
  • Packing project references (including transitive references)
  • Straightforward support for smart libraries packing needs
  • Packing multi-targeted projects, including framework-specific resources and dependencies
  • Fast iterative development with complementary dotnet-nugetize command line tool
  • Comprehensive diagnostic analyzers to provide guidance on packing best practices
  • Consistent and predictable naming for package content inference behaviors:
    • Pack=[true|false] ⇒ Include/exclude from package (on any item, such as PackageReference, ProjectReference, None, Content, etc.)
    • PackFolder=[folder] ⇒ Name of known folders with special behavior, such as Lib, Build, Content, Tools, etc. (as a project property or item metadata)
    • PackagePath=[path] ⇒ Package-relative path (on any item, such as None, Content, etc.)
    • Pack[Item Type]=[true|false] ⇒ Set default pack behavior for all items of a given type via simple properties (such as PackNone, PackContent, PackBuildOutput, PackDependencies, PackFrameworkReferences, PackEmbeddedResource, PackResource etc.)
  • Packaging projects using .msbuildproj and Microsoft.Build.NoTargets SDK
  • SourceLink support to populate repository information in the package
  • Automatic readme.md inclusion in the package
  • Support for content includes in readme
  • Package validation enabled by default for release multi-targeting packages.

It's strongly recommended that you install the dotnet-nugetize tool to get the best experience with NuGetizer:

dotnet tool install -g dotnet-nugetize

Given the following project:

<Project Sdk="Microsoft.NET.Sdk">

  <PropertyGroup>
    <TargetFramework>netstandard2.0</TargetFramework>
    <GenerateDocumentationFile>true</GenerateDocumentationFile>

    <PackageId>Quickstart</PackageId>
    <Authors>NuGetizer</Authors>
    <Description>NuGetized quickstart</Description>

    <PublishRepositoryUrl>true</PublishRepositoryUrl>
  </PropertyGroup>

  <ItemGroup>
    <PackageReference Include="NuGetizer" />
    <PackageReference Include="Microsoft.SourceLink.GitHub" Version="1.1.1" 
                      PrivateAssets="all" />
    <PackageReference Include="Newtonsoft.Json" Version="13.0.1" />
  </ItemGroup>

  <ItemGroup>
    <None Include="none.txt" Pack="true" />
    <Content Include="content.txt" Pack="true" />
    <Compile Update="@(Compile)" Pack="true" />
  </ItemGroup>

</Project>

Running nugetize on the project directory will produce:

nugetize quickstart

A typical packaging .msbuildproj project for a smart multi-targeted library might look like the following:

<Project Sdk="Microsoft.Build.NoTargets/3.7.0">

  <PropertyGroup>
    <PackageId>Quickstart</PackageId>
    <TargetFramework>netstandard2.0</TargetFramework>
  </PropertyGroup>

  <ItemGroup>
    <PackageReference Include="NuGetizer" />
    <PackageReference Include="Microsoft.SourceLink.GitHub" Version="1.1.1" 
                      PrivateAssets="all" />
  </ItemGroup>

  <ItemGroup>
    <ProjectReference Include="..\Analyzer\Quickstart.CodeAnalysis.csproj" />
    <ProjectReference Include="..\Build\Quickstart.Tasks.csproj" />
    <ProjectReference Include="..\Lib\Quickstart.csproj" />
    <ProjectReference Include="..\Tools\Quickstart.csproj" />
  </ItemGroup>

</Project>

And produce the following nugetize tool output:

nugetize smart library

You can open this sample and run it directly in your browser in a GitHub Codespace

Learn more about NuGetizer and its capabilities from the project documentation site.

Sponsors

Clarius Org Kirill Osenkov MFB Technologies, Inc. Stephen Shaw Torutek DRIVE.NET, Inc. Daniel Gnägi Ashley Medway Keith Pickford Thomas Bolon Kori Francis Toni Wenzel Giorgi Dalakishvili Mike James Dan Siegel Reuben Swartz Jacob Foshee alternate text is missing from this package README image Eric Johnson Norman Mackay Certify The Web Rich Lee alternate text is missing from this package README image Ix Technologies B.V. David JENNI Jonathan Oleg Kyrylchuk Mariusz Kogut Charley Wu Jakob Tikjøb Andersen Seann Alexander Tino Hager Mark Seemann Angelo Belchior Blauhaus Technology (Pty) Ltd Ken Bonny Simon Cropp agileworks-eu alternate text is missing from this package README image Zheyu Shen

Sponsor this project  

Learn more about GitHub Sponsors

There are no supported framework assets in this package.

Learn more about Target Frameworks and .NET Standard.

This package has no dependencies.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories (13)

Showing the top 5 popular GitHub repositories that depend on NuGetizer:

Repository Stars
devlooped/moq
The most popular and friendly mocking framework for .NET
nissl-lab/npoi
a .NET library that can read/write Office formats without Microsoft Office installed. No COM+, no interop.
LitJSON/litjson
JSON library for the .Net framework
moq/labs
The most popular and friendly mocking framework for .NET
jsuarezruiz/TemplateUI
A set of Xamarin.Forms templated controls.
Version Downloads Last updated
1.2.1 23,144 11/30/2023
1.2.0 10,508 10/11/2023
1.1.1 8,651 8/28/2023
1.1.0 14,473 8/11/2023
0.9.2 10,343 2/11/2023
0.9.1 63,750 11/16/2022
0.9.0 37,798 9/3/2022
0.8.0 33,889 6/9/2022
0.7.5 43,836 10/13/2021
0.7.4 9,971 7/20/2021
0.7.3 372 7/19/2021
0.7.2 411 7/16/2021
0.7.1 5,145 6/17/2021
0.7.0 2,805 5/10/2021
0.6.2 25,413 3/30/2021
0.6.0 22,154 12/10/2020
0.5.0 1,762 11/25/2020
0.4.12 482 11/20/2020
0.4.11 770 11/4/2020
0.4.10 573 10/29/2020
0.4.9 2,241 10/26/2020
0.4.8 450 10/25/2020
0.4.7 837 10/21/2020
0.4.6 564 10/21/2020
0.4.5 1,045 10/8/2020
0.4.4 532 10/8/2020
0.4.3 491 10/4/2020