Add F# Analyzers (#603)

* Added fsharp analyzers in response to seeing Follow-up from "Minor code optimisation #567" #577 * Moved packages to proj file instead of props file * add analyzers CI workflow and define the report name at Directory.Build.Targets --------- Co-authored-by: 64J0 <[email protected]>
giraffe-fsharp · Jul 25, 2024 · 5385767 · 5385767
1 parent 73724ac
commit 5385767
Show file tree

Hide file tree

Showing 5 changed files with 65 additions and 1 deletion.
diff --git a/.config/dotnet-tools.json b/.config/dotnet-tools.json
@@ -7,6 +7,12 @@
       "commands": [
         "fantomas"
       ]
+    },
+    "fsharp-analyzers": {
+      "version": "0.26.0",
+      "commands": [
+        "fsharp-analyzers"
+      ]
     }
   }
 }
diff --git a/.github/workflows/build-and-test.yml b/.github/workflows/build-and-test.yml
@@ -38,4 +38,30 @@ jobs:
       - name: Build
         run: dotnet build -c Release --no-restore
       - name: Test
-        run: dotnet test -c Release
+        run: dotnet test -c Release
+
+  analyzers:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Setup .NET Core
+        uses: actions/setup-dotnet@v4
+        with:
+          dotnet-version: 8.x
+      - name: Restore tools
+        run: dotnet tool restore
+      - name: Build solution
+        run: dotnet build -c Release Giraffe.sln
+
+      - name: Run Analyzers
+        run: dotnet msbuild /t:AnalyzeFSharpProject src/Giraffe/Giraffe.fsproj
+        # This is important, you want to continue your Action even if you found problems.
+        # As you always want the report to upload
+        continue-on-error: true
+      # checkout code, build, run analyzers, ...
+      - name: Upload SARIF file
+        uses: github/codeql-action/upload-sarif@v2
+        with:
+          # You can also specify the path to a folder for `sarif_file`
+          sarif_file: ./src/Giraffe/analysis.sarif
diff --git a/Directory.Build.targets b/Directory.Build.targets
@@ -0,0 +1,9 @@
+<Project>
+    <PropertyGroup>
+        <FSharpAnalyzersOtherFlags>--analyzers-path &quot;$(PkgG-Research_FSharp_Analyzers)&quot;</FSharpAnalyzersOtherFlags>
+        <FSharpAnalyzersOtherFlags>$(FSharpAnalyzersOtherFlags) --analyzers-path &quot;$(PkgIonide_Analyzers)&quot;</FSharpAnalyzersOtherFlags>
+        <FSharpAnalyzersOtherFlags>$(FSharpAnalyzersOtherFlags) --configuration $(Configuration)</FSharpAnalyzersOtherFlags>
+        <FSharpAnalyzersOtherFlags>$(FSharpAnalyzersOtherFlags) --exclude-analyzers PartialAppAnalyzer</FSharpAnalyzersOtherFlags>
+        <FSharpAnalyzersOtherFlags>$(FSharpAnalyzersOtherFlags) --report &quot;analysis.sarif&quot;</FSharpAnalyzersOtherFlags>
+    </PropertyGroup>
+</Project>
diff --git a/Directory.Solution.targets b/Directory.Solution.targets
@@ -0,0 +1,9 @@
+<Project>
+    <ItemGroup>
+        <ProjectsToAnalyze Include="src/**/*.fsproj" />
+    </ItemGroup>
+
+    <Target Name="AnalyzeSolution">
+        <MSBuild Projects="@(ProjectsToAnalyze)" Targets="AnalyzeFSharpProject" />
+    </Target>
+</Project>
diff --git a/src/Giraffe/Giraffe.fsproj b/src/Giraffe/Giraffe.fsproj
@@ -49,6 +49,20 @@
   </ItemGroup>
 
   <ItemGroup>
+    <!-- Analyzers -->
+    <PackageReference Include="FSharp.Analyzers.Build" Version="0.3.0">
+    <IncludeAssets>build</IncludeAssets>
+    <PrivateAssets>all</PrivateAssets>
+    </PackageReference>
+    <PackageReference Include="G-Research.FSharp.Analyzers" Version="0.10.0">
+    <IncludeAssets>analyzers</IncludeAssets>
+    <PrivateAssets>all</PrivateAssets>
+    </PackageReference>
+    <PackageReference Include="Ionide.Analyzers" Version="0.11.0">
+    <IncludeAssets>analyzers</IncludeAssets>
+    <PrivateAssets>all</PrivateAssets>
+    </PackageReference>
+
     <PackageReference Include="FSharp.Core" Version="6.0.0" />
     <PackageReference Include="Microsoft.IO.RecyclableMemoryStream" Version="3.0.*" />
     <PackageReference Include="System.Text.Json" Version="8.0.*" />