FSharp.Analyzers.SDK 0.24.0

.NET 6.0 This package targets .NET 6.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 FSharp.Analyzers.SDK --version 0.24.0                

                    
                

            
NuGet\Install-Package FSharp.Analyzers.SDK -Version 0.24.0
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="FSharp.Analyzers.SDK" Version="0.24.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
paket add FSharp.Analyzers.SDK --version 0.24.0                

                    
                

            
#r "nuget: FSharp.Analyzers.SDK, 0.24.0"
#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 FSharp.Analyzers.SDK as a Cake Addin
#addin nuget:?package=FSharp.Analyzers.SDK&version=0.24.0

// Install FSharp.Analyzers.SDK as a Cake Tool
#tool nuget:?package=FSharp.Analyzers.SDK&version=0.24.0

Ionide FSharp.Analyzers.SDK

Library used for building custom analyzers for FSAC / F# editors.

F# analyzers are live, real-time, project based plugins that enables to diagnose source code and surface custom errors, warnings and code fixes into editor. Read more about analyzers here - https://medium.com/lambda-factory/introducing-f-analyzers-772487889429

How to build

  1. Install the .NET SDK version specified in global.json
  2. dotnet tool restore
  3. Open and build in your favorite IDE, or use dotnet build

How to run sample

  1. dotnet build -c Release
  2. Run the console application:
dotnet run --project src\FSharp.Analyzers.Cli\FSharp.Analyzers.Cli.fsproj -- --project ./samples/OptionAnalyzer/OptionAnalyzer.fsproj --analyzers-path ./samples/OptionAnalyzer/bin/Release --verbosity d

You can also set up a run configuration of FSharp.Analyzers.Cli in your favorite IDE using similar arguments. This also allows you to debug FSharp.Analyzers.Cli.

Using Analyzers

Checkout our Getting Started guide for analyzer users!

Writing Analyzers

Checkout our Getting Started guide for analyzer authors!

How to contribute

Imposter syndrome disclaimer: I want your help. No really, I do.

There might be a little voice inside that tells you you're not ready; that you need to do one more tutorial, or learn another framework, or write a few more blog posts before you can help me with this project.

I assure you, that's not the case.

This project has some clear Contribution Guidelines and expectations that you can read here.

The contribution guidelines outline the process that you'll need to follow to get a patch merged. By making expectations and process explicit, I hope it will make it easier for you to contribute.

And you don't just have to write code. You can help out by writing documentation, tests, or even by giving feedback about this work. (And yes, that includes giving feedback about the contribution guidelines.)

Thank you for contributing!

The project is hosted on GitHub where you can report issues, fork the project and submit pull requests.

The library is available under MIT license, which allows modification and redistribution for both commercial and non-commercial purposes.

Product Compatible and additional computed target framework versions.
.NET net6.0 is compatible.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  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. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (7)

Showing the top 5 NuGet packages that depend on FSharp.Analyzers.SDK:

Package Downloads
NpgsqlFSharpAnalyzer

Advanced embedded static analysis and type-checking for SQL code from F#
BinaryDefense.FSharp.Analyzers.Hashing

Looks for insecure hashing functions
AzureTackleAnalyzer

AzureTackleAnalyzer
FSharp.CosmosDb.Analyzer

An F# analyzer that will help you work with CosmosDB.
FSharp.Analyzers.SDK.Testing

Test facilities for the FSharp.Analyzers.SDK

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
0.27.0 2,056 8/17/2024
0.26.1 123 8/5/2024
0.26.0 3,216 5/15/2024
0.25.0 2,781 2/14/2024
0.24.0 1,209 1/30/2024
0.23.0 1,050 1/5/2024
0.22.0 391 12/19/2023
0.21.0 314 11/23/2023
0.20.2 240 11/15/2023
0.20.1 190 11/14/2023
0.20.0 173 11/13/2023
0.19.0 327 11/7/2023
0.18.0 244 11/3/2023
0.17.1 148 10/30/2023
0.17.0 149 10/26/2023
0.16.0 1,075 10/16/2023
0.15.0 221 10/10/2023
0.14.1 971 9/26/2023
0.14.0 236 9/21/2023
0.13.0 201 9/7/2023
0.13.0-beta007 130 9/7/2023
0.12.0 635 5/20/2023
0.11.0 24,116 1/12/2022
0.10.1 2,449 6/23/2021
0.10.0 409 6/22/2021
0.9.0 1,687 5/28/2021
0.8.0 15,815 2/11/2021
0.7.0 1,999 1/20/2021
0.6.0 2,216 12/20/2020
0.5.0 10,393 7/11/2020
0.4.1 4,388 4/10/2020
0.4.0 9,522 3/8/2020
0.3.1 1,130 2/28/2020
0.3.0 4,288 2/17/2020
0.2.0 1,262 12/24/2019
0.1.0 560 12/17/2019
0.0.10 566 12/16/2019
0.0.9 602 11/21/2019
0.0.8 1,277 10/1/2019
0.0.7 676 8/28/2019
0.0.6 959 7/1/2019
0.0.5 1,312 5/27/2019
0.0.4 1,385 3/29/2019
0.0.3 995 2/26/2019
0.0.2 808 2/8/2019
0.0.1 2,014 9/14/2018

### Changed

* * [Add `RequireQualifiedAccess` to `Severity` type](https://github.com/ionide/FSharp.Analyzers.SDK/pull/199) (thanks @Smaug123!)
* * [Fail the tool when any analyzers fail to load](https://github.com/ionide/FSharp.Analyzers.SDK/pull/198) (thanks @Smaug123!)