FSharp.Interop.Dlr.Analyzers 1.0.0-rc.2

FSharp.Interop.Dlr.Analyzers

Build-time checks for FSharp.Interop.Dlr. A dlr { } block needs [<ReflectedDefinition>] on the function or member that contains it (or on an enclosing module or type), and without it the first call raises; this analyzer reports that at build time, and in Ionide, with a fix that adds the attribute to the outermost binding containing the block, i.e. the function or member the compiler stores a definition for (a local function inside it is a closure and cannot carry the attribute). A block in module-level do code is reported without a fix: move it into a function.

DLR005 reports: an argument marker — Dlr.named, Dlr.namedOf, Dlr.argsOf, Dlr.typeArgs, Dlr.typeArgsOf, Dlr.out, Dlr.outAs, Dlr.ref — anywhere but as an argument of a call (a member call, Dlr.invoke, Dlr.call / Dlr.apply, Dlr.new'); Dlr.typeArgs / typeArgsOf not first, or on Dlr.call / Dlr.apply / Dlr.new' (a value or constructor call takes none); Dlr.namedOf or Dlr.argsOf twice in one call; a positional argument after Dlr.namedOf; Dlr.named on a record in a variable rather than the literal (names from data are Dlr.namedOf); Dlr.Static<T>.Overloads anywhere but as the target of a call; Dlr.call x read at a non-function type; Dlr.ref on anything but a let mutable; a call with Dlr.out whose result type does not fit (the return value then each out as a tuple, the outs alone, or the one out's value, the first agreeing with every type Dlr.outAs states); Dlr.out in Dlr.new' (its result is the T; a constructor's ref is Dlr.ref); Dlr.out / Dlr.ref in a call with Dlr.namedOf / Dlr.argsOf.

Setup

An FSharp.Analyzers.SDK analyzer runs in the fsharp-analyzers tool, and only in the tool of the exact SDK version it was built against: fsharp-analyzers 0.39.2, which needs .NET SDK 10 (8 and 9 are not supported). The build is in analyzers/dotnet/fs/net10.0.

The project being analyzed can target anything, net472 included; only the SDK you build with matters.

1. The tool, in a manifest so every clone and CI gets the same one:

   dotnet new tool-manifest            # if there is no .config/dotnet-tools.json yet
   dotnet tool install fsharp-analyzers --version 0.39.2
   

   (dotnet tool restore on a fresh clone.)

2. In the project:

   <PackageReference Include="FSharp.Analyzers.Build" Version="0.5.0" PrivateAssets="all" />
   <PackageReference Include="FSharp.Interop.Dlr.Analyzers" Version="*" GeneratePathProperty="true" PrivateAssets="all" />
   

   <PropertyGroup>
   
     <RunAnalyzers>true</RunAnalyzers>
     <FSharpAnalyzersOtherFlags>--analyzers-path "$(PkgFSharp_Interop_Dlr_Analyzers)/analyzers/dotnet/fs/net10.0"</FSharpAnalyzersOtherFlags>
   
     <FSharpAnalyzersContinueOnError>false</FSharpAnalyzersContinueOnError>
   </PropertyGroup>
   

   The net10.0 folder, not the package root: the tool looks for analyzers in the directory it is given.

3. Check it actually runs: a clean build prints nothing, so remove one [<ReflectedDefinition>] and build — you should see error DLR001: dlr { } needs [<ReflectedDefinition>] …. If not, the usual causes are the tool not restored (dotnet-fsharp-analyzers does not exist), RunAnalyzers missing, or GeneratePathProperty missing so the path is empty.

Ionide picks the analyzer up from the same path; Rider and Visual Studio do not run SDK analyzers, so there the check happens at build. -p:RunAnalyzers=false skips it.