Getting started writing an analyzer

dotnet new classlib -lang F# -f net10.0 -n OptionValueAnalyzer

dotnet add package FSharp.Analyzers.SDK

paket add FSharp.Analyzers.SDK

<PackageReference Update="FSharp.Core" Version="10.1.402" />

open FSharp.Analyzers.SDK

// This attribute is required and needs to match the correct context type!
[<CliAnalyzer>]
let optionValueAnalyzer: Analyzer<CliContext> =
    fun (context: CliContext) ->
        async {
            // inspect context to determine the error/warning messages
            // A potential implementation might traverse the untyped syntax tree
            // to find any references of `Option.Value`
            return
                [
                    {
                        Type = "Option.Value analyzer"
                        Message = "Option.Value shouldn't be used"
                        Code = "OV001"
                        Severity = Severity.Warning
                        Range = FSharp.Compiler.Text.Range.range0
                        Fixes = []
                    }
                ]
        }

[<EditorAnalyzer "BadCodeAnalyzer">]
let badCodeAnalyzer: Analyzer<EditorContext> =
    fun (context: EditorContext) ->
        async { // inspect context to determine the error/warning messages
            return []
        }

dotnet tool install --global fsharp-analyzers

fsharp-analyzers --project YourProject.fsproj --analyzers-path ./OptionAnalyzer/bin/Release --verbosity d

dotnet nuget push {NugetPackageFullPath} -s nuget.org -k {NugetApiKey}

dotnet publish --configuration Release --framework net10.0

// make ZipFile available
#r "System.IO.Compression.FileSystem.dll"
#r "nuget: Fake.Core.Target, 6.0.0"
#r "nuget: Fake.Core.ReleaseNotes, 6.0.0"
#r "nuget: Fake.IO.Zip, 6.0.0"

open System.IO
open System.IO.Compression
open Fake.Core
open Fake.IO
open Fake.IO.FileSystemOperators

let releaseNotes = ReleaseNotes.load "RELEASE_NOTES.md"

Target.create
    "PackAnalyzer"
    (fun _ ->
        let analyzerProject = "src" </> "BadCodeAnalyzer"

        let args =
            [
                "pack"
                "--configuration Release"
                sprintf "/p:PackageVersion=%s" releaseNotes.NugetVersion
                sprintf "/p:PackageReleaseNotes=\"%s\"" (String.concat "\n" releaseNotes.Notes)
                sprintf
                    "--output %s"
                    (__SOURCE_DIRECTORY__
                     </> "dist")
            ]

        // create initial nuget package
        let exitCode = Shell.Exec("dotnet", String.concat " " args, analyzerProject)

        if exitCode <> 0 then
            failwith "dotnet pack failed"
        else
            match
                Shell.Exec(
                    "dotnet",
                    "publish --configuration Release --framework net10.0",
                    analyzerProject
                )
            with
            | 0 ->
                let nupkg =
                    System.IO.Directory.GetFiles(
                        __SOURCE_DIRECTORY__
                        </> "dist"
                    )
                    |> Seq.head
                    |> Path.GetFullPath

                let nugetParent = DirectoryInfo(nupkg).Parent.FullName
                let nugetFileName = Path.GetFileNameWithoutExtension(nupkg)

                let publishPath =
                    analyzerProject
                    </> "bin"
                    </> "Release"
                    </> "net10.0"
                    </> "publish"
                // Unzip the nuget
                ZipFile.ExtractToDirectory(nupkg, nugetParent </> nugetFileName)
                // delete the initial nuget package
                File.Delete nupkg
                // remove stuff from ./lib/net10.0
                Shell.deleteDir (
                    nugetParent
                    </> nugetFileName
                    </> "lib"
                    </> "net10.0"
                )
                // move the output of publish folder into the ./lib/net10.0 directory
                Shell.copyDir
                    (nugetParent
                     </> nugetFileName
                     </> "lib"
                     </> "net10.0")
                    publishPath
                    (fun _ -> true)
                // re-create the nuget package
                ZipFile.CreateFromDirectory(nugetParent </> nugetFileName, nupkg)
                // delete intermediate directory
                Shell.deleteDir (nugetParent </> nugetFileName)
            | _ -> failwith "dotnet publish failed"
    )

<PropertyGroup>
    <PackageTags>F#, fsharp, analyzers, fsharp-analyzer</PackageTags>
    <!-- Ionide.KeepAChangelog.Tasks fills PackageReleaseNotes from CHANGELOG.md automatically -->
    <PackageReleaseNotes>https://github.com/you/your-analyzers/blob/main/CHANGELOG.md</PackageReleaseNotes>
</PropertyGroup>