G-Research.FSharp.Analyzers 0.8.0

G-Research Fsharp Analyzers

A curated set of Ionide SDK analyzers for F#.

Usage

To run any analyzer you need to find a way to download the NuGet package locally. At the time of writing there is no standard way to do this, one way this can be done is by using the <PackageDownload>

<Project Sdk="Microsoft.Build.NoTargets/1.0.80"> 

  <PropertyGroup>
    <IsPackable>false</IsPackable>
    <RestorePackagesPath>./.analyzerpackages/</RestorePackagesPath> 
     
    <TargetFramework>net6.0</TargetFramework> 
    <DisableImplicitNuGetFallbackFolder>true</DisableImplicitNuGetFallbackFolder> 
    <AutomaticallyUseReferenceAssemblyPackages>false</AutomaticallyUseReferenceAssemblyPackages> 
  </PropertyGroup>

  <ItemGroup>
    <PackageDownload Include="G-Research.FSharp.Analyzers" Version="[0.1.4]" />
  </ItemGroup>

</Project>

Running dotnet restore will download this locally to ./.analyzerpackages.

Then you need to install the fsharp-analyzers tool.

Next you can run dotnet fsharp-analyzers --project YourProject.fsproj --analyzers-path ./.analyzerpackages/g-research.fsharp.analyzers/0.1.4/lib/net6.0

Please checkout the documentation over at FSharp.Analyzers.SDK.

Contributing

We welcome new contributors! We'll happily receive PRs for bug fixes or small changes. If you're contemplating something larger please get in touch first by opening a GitHub Issue describing the problem and how you propose to solve it.

Scaffold new analyzer

Run

dotnet fsi build.fsx -- -p NewAnalyzer

to scaffold a new analyzer.

License

Copyright © 2023 G-Research

Licensed under the Apache License, Version 2.0 (the "License"); you may not use these files except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.