WoofWare.FSharpAnalyzers 0.1.2

.NET 8.0 This package targets .NET 8.0. The package is compatible with this framework or higher.
There is a newer version of this package available.
See the version list below for details. 
dotnet add package WoofWare.FSharpAnalyzers --version 0.1.2
                    


                    

                
NuGet\Install-Package WoofWare.FSharpAnalyzers -Version 0.1.2
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="WoofWare.FSharpAnalyzers" Version="0.1.2">
  <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. 
<PackageVersion Include="WoofWare.FSharpAnalyzers" Version="0.1.2" />
                    


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="WoofWare.FSharpAnalyzers">
  <PrivateAssets>all</PrivateAssets>
  <IncludeAssets>runtime; build; native; contentfiles; analyzers</IncludeAssets>
</PackageReference>
                    


                            Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package. 
paket add WoofWare.FSharpAnalyzers --version 0.1.2
                    


                    

                
#r "nuget: WoofWare.FSharpAnalyzers, 0.1.2"
#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. 
#:package WoofWare.FSharpAnalyzers@0.1.2
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package. 
#addin nuget:?package=WoofWare.FSharpAnalyzers&version=0.1.2
                    


                            Install as a Cake Addin
                        

                    

                
#tool nuget:?package=WoofWare.FSharpAnalyzers&version=0.1.2
                    


                            Install as a Cake Tool

WoofWare.FSharpAnalyzers

A set of F# source analyzers, using the Ionide analyzer SDK.

They are modelled on the G-Research analyzers, but are much more opinionated. They're intended for my personal use.

Analyzers

BlockingAnalyzer

Bans the use of blocking calls like Async.RunSynchronously.

You will have to have a blocking call in your main method; use the magic suppression string ANALYZER: synchronous blocking call allowed (optionally with a rationale appended) on the preceding line to suppress the analyzer on that line.

Rationale

Prevent sync-over-async.

ReferenceEqualsAnalyzer

Bans the use of Object.ReferenceEquals.

Use the magic suppression string ANALYZER: ReferenceEquals allowed (optionally with a rationale appended) on the preceding line to suppress the analyzer on that line.

Rationale

Object.ReferenceEquals has two significant problems:

  1. It silently does the wrong thing on value types. When you pass value types to Object.ReferenceEquals, they get boxed, and the function compares the boxed instances rather than the original values. This means Object.ReferenceEquals(42, 42) will always return false, which is rarely what you want.

  2. It lacks type safety. The function accepts any two objects, making it too easy to accidentally compare objects of completely different types (e.g., Object.ReferenceEquals("hello", 42)), which will always return false but compiles without warning.

Instead, use a type-safe wrapper that enforces reference type constraints and type consistency:

let referenceEquals<'a when 'a : not struct> (x : 'a) (y : 'a) : bool =
    obj.ReferenceEquals(x, y)

This prevents both issues: the not struct constraint prevents value types from being passed, and the type parameter 'a ensures both arguments are the same type.

Licence

WoofWare.FSharpAnalyzers is licensed to you under the MIT licence, a copy of which can be found at LICENCE.md.

Product Compatible and additional computed target framework versions.
.NET net8.0 is compatible.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed.  net9.0 was computed.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 was computed.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
0.2.9 212 11/25/2025
0.2.8 186 11/25/2025
0.2.7 180 11/24/2025
0.2.6 183 11/23/2025
0.2.5 216 11/23/2025
0.2.4 148 11/23/2025
0.2.3 397 11/20/2025
0.2.2 356 11/12/2025
0.2.1 215 10/20/2025
0.1.5 176 10/19/2025
0.1.4 175 10/19/2025
0.1.3 621 10/4/2025
0.1.2 128 10/3/2025
0.1.1 206 10/3/2025