UnoptimizedAssemblyDetector 0.1.1

Requires NuGet 4.0 or higher.

dotnet add package UnoptimizedAssemblyDetector --version 0.1.1

NuGet\Install-Package UnoptimizedAssemblyDetector -Version 0.1.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="UnoptimizedAssemblyDetector" Version="0.1.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 UnoptimizedAssemblyDetector --version 0.1.1

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

#r "nuget: UnoptimizedAssemblyDetector, 0.1.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 UnoptimizedAssemblyDetector as a Cake Addin
#addin nuget:?package=UnoptimizedAssemblyDetector&version=0.1.1

// Install UnoptimizedAssemblyDetector as a Cake Tool
#tool nuget:?package=UnoptimizedAssemblyDetector&version=0.1.1

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

Unoptimized Assembly Detector

NuGet package that detects when assemblies compiled without the -optimized flag are added to a project and warns you about it.

How does it work?

This project hooks into the build process and detects if any referenced assembly was compiled in Debug mode.

UnoptimizedAssemblyDetector in action

Add to your project:

<ItemGroup>
  <PackageReference Include="UnoptimizedAssemblyDetector" Version="0.1.1" PrivateAssets="All" />
</ItemGroup>

Motivation

It's surprising to many that dotnet publish and dotnet pack compile assemblies in debug mode. This means that unless you've specified -c release, you're building .NET assemblies without the -optimize compiler flag.

With this package, you can get warned if one of your dependencies is being built in Debug mode and published to nuget.org. It can warn any referened assembly, not only added through NuGet.

Now that you know about it, you can communicate to the author of the dependency. Wait until a fix is shipped, you can ignore the warning for said package, roll back to an older version or chose another dependency.

Acknowledgements

Sentry for the craft release tool used in this project.
Icon made by Freepik from www.flaticon.com.
Some of the blog posts that helped:
- Implementing and Debugging Custom MSBuild Tasks by Matthias Koch.
- Shipping a cross-platform MSBuild task in a NuGet package by Nate MacMaster.
- Alexey Golub for the links and rants.

There are no supported framework assets in this package.

Learn more about Target Frameworks and .NET Standard.

.NETFramework 4.6.1
- System.Reflection.Metadata (>= 5.0.0)
.NETStandard 2.0
- System.Reflection.Metadata (>= 5.0.0)

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories (3)

Showing the top 3 popular GitHub repositories that depend on UnoptimizedAssemblyDetector:

Repository	Stars
NetFabric/NetFabric.Hyperlinq High performance LINQ implementation with minimal heap allocations. Supports enumerables, async enumerables, arrays and Span<T>.	861
getsentry/sentry-dotnet Sentry SDK for .NET	562
dotnet/nuget-trends Check out NuGet packages adoption and what's trending on NuGet.	140

Version	Downloads	Last updated
0.1.1	61,809	5/25/2021
0.1.0	1,326	5/22/2021
0.0.5	420	5/21/2021
0.0.4	290	5/20/2021
0.0.3	328	5/20/2021
0.0.2	401	5/20/2021

Changes since version 0.1.0

- No documented changes.
Changes since version 0.0.5

- Description to nuget package
- Gif to readme showing how it works
Changes since version 0.0.4

- Fixed conflict with Microsoft.Build.Utilities.Core
- Added a logo to nuget package and acknowledgment to readme
- CI and release to nuget with craft CLI
Changes since version 0.0.3

- Works also on Visual Studio (.NET Framework msbuild)
- Initial release
-->
See full changelog at https://github.com/bruno-garcia/unoptimized-assembly-detector/blob/main/CHANGELOG.md