Integrate analyzers via msbuild (#2968)

* integrate analyzers via msbuild magic * try wildcard for sarif upload, might need to change to directory * try another wildcard for sarif files * collect sarif files in dedicated directory to be able to upload them with github/codeql-action/upload-sarif * add back env vars * remove stale open statement * update analyzers tool and gr analyzers package * move setting of env vars * delete "Directory.Solution.props" * remove message * needs some UsingTask magic I don't know currently * fix build for now * cool kids project cracking * restore all fail-on-warnings * use analysisreports dir * use $(SolutionFileName) instead of hard coding name * Set environment variables in target. --------- Co-authored-by: nojaf <[email protected]>
fsprojects · Oct 26, 2023 · ee06697 · ee06697
1 parent c24ecd6
commit ee06697
Show file tree

Hide file tree

Showing 17 changed files with 99 additions and 59 deletions.
diff --git a/.config/dotnet-tools.json b/.config/dotnet-tools.json
@@ -21,7 +21,7 @@
       ]
     },
     "fsharp-analyzers": {
-      "version": "0.16.0",
+      "version": "0.17.0",
       "commands": [
         "fsharp-analyzers"
       ]

diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml
@@ -31,7 +31,7 @@ jobs:
       uses: github/codeql-action/upload-sarif@v2
       if: matrix.os == 'ubuntu-latest'
       with:
-        sarif_file: analysis.sarif
+        sarif_file: analysisreports
     - name: "Documentation"
       if: matrix.os == 'windows-latest' && github.ref == 'refs/heads/main'
       uses: peaceiris/actions-gh-pages@v3

diff --git a/.gitignore b/.gitignore
@@ -201,4 +201,4 @@ tests/.repositories/**
 
 # Analyzer files
 .analyzerpackages
-analysis.sarif
+*.sarif
diff --git a/Directory.Build.props b/Directory.Build.props
@@ -58,4 +58,10 @@ Some common use cases include:
         <PackageReference Include="Ionide.KeepAChangelog.Tasks" Version="0.1.8" PrivateAssets="all" />
         <PackageReference Include="DotNet.ReproducibleBuilds" Version="1.1.1" PrivateAssets="all" />
     </ItemGroup>
+   <ItemGroup>
+        <PackageReference Include="G-Research.FSharp.Analyzers" Version="0.1.6">
+        <PrivateAssets>all</PrivateAssets>
+        <IncludeAssets>build</IncludeAssets>
+        </PackageReference>
+   </ItemGroup>
 </Project>
diff --git a/Directory.Build.targets b/Directory.Build.targets
@@ -0,0 +1,22 @@
+<Project>
+
+    <Target
+        Name="AnalyzeProject" 
+        DependsOnTargets="Restore;ResolveAssemblyReferencesDesignTime;ResolveProjectReferencesDesignTime;ResolvePackageDependenciesDesignTime;FindReferenceAssembliesForReferences;_GenerateCompileDependencyCache;_ComputeNonExistentFileProperty;BeforeBuild;BeforeCompile;CoreCompile">
+
+        <Message Importance="normal" Text="fsc arguments: @(FscCommandLineArgs)" />
+        <Message Importance="High" Text="Analyzing $(MSBuildProjectFile)"/>
+        <PropertyGroup>
+            <DOTNET_ROLL_FORWARD_TO_PRERELEASE>1</DOTNET_ROLL_FORWARD_TO_PRERELEASE>
+            <DOTNET_ROLL_FORWARD>LatestMajor</DOTNET_ROLL_FORWARD>
+        </PropertyGroup>
+        <Exec
+            ContinueOnError="true"
+            Command="dotnet fsharp-analyzers --fsc-args &quot;@(FscCommandLineArgs)&quot; --analyzers-path &quot;$(PkgG-Research_FSharp_Analyzers)\analyzers\dotnet\fs&quot; --exclude-analyzer PartialAppAnalyzer --fail-on-warnings GRA-STRING-001 GRA-STRING-002 GRA-STRING-003 GRA-UNIONCASE-001 --verbose --report &quot;../../analysisreports/$(MSBuildProjectName)-analysis.sarif&quot;">
+            <Output TaskParameter="ExitCode" PropertyName="LastExitCode" />
+        </Exec>
+        <Error Condition="'$(LastExitCode)' == '-2'" Text="Problems were found $(MSBuildProjectFile)" />
+
+    </Target>
+
+</Project>
diff --git a/Directory.Solution.targets b/Directory.Solution.targets
@@ -0,0 +1,15 @@
+<Project>
+
+    <ItemGroup>
+        <ProjectsToAnalyze Include="src\**\*.fsproj" Exclude="src\Fantomas.FCS\Fantomas.FCS.fsproj"/>
+    </ItemGroup>
+
+    <Target Name="AnalyzeSolution">
+        <Exec Command="dotnet build -c Release $(SolutionFileName)" />
+        <MSBuild
+                Projects="@(ProjectsToAnalyze)"
+                Targets="AnalyzeProject"
+                Properties="DesignTimeBuild=True;Configuration=Release;ProvideCommandLineArgs=True;SkipCompilerExecution=True" />
+    </Target>
+
+</Project>
diff --git a/analyzers/analyzers.fsproj b/analyzers/analyzers.fsproj
diff --git a/analyzers/packages.lock.json b/analyzers/packages.lock.json
diff --git a/build.fsx b/build.fsx
@@ -6,7 +6,6 @@
 
 open System
 open System.IO
-open System.Text.RegularExpressions
 open Fun.Build
 open CliWrap
 open CliWrap.Buffered
@@ -58,31 +57,16 @@ let pushPackage nupkg =
         return result.ExitCode
     }
 
-let analyzersProjectPath = __SOURCE_DIRECTORY__ </> "analyzers/analyzers.fsproj"
-
-let analyzersVersion =
-    let s = File.ReadAllText(analyzersProjectPath)
-    let regex = Regex(@"\[\s*(\d+\.\d+\.\d+)\s*\]")
-    let matches = regex.Match(s)
-    matches.Groups[1].Value
-
-let analyzeProjects (projectPaths: string seq) =
-    let projects = String.concat " " projectPaths
-    let analyzerPath =
-        $"./.analyzerpackages/g-research.fsharp.analyzers/{analyzersVersion}"
-    let failOnWarnings =
-        "GRA-STRING-001 GRA-STRING-002 GRA-STRING-003 GRA-UNIONCASE-001"
-    let excludeAnalyzers = "PartialAppAnalyzer"
-    let report = "./analysis.sarif"
-    $"dotnet fsharp-analyzers --project %s{projects} --analyzers-path \"%s{analyzerPath}\" --verbose --fail-on-warnings %s{failOnWarnings} --report %s{report} --exclude-analyzer %s{excludeAnalyzers}"
+let analysisReportsDir = "analysisreports"
 
 pipeline "Build" {
     workingDir __SOURCE_DIRECTORY__
     stage "RestoreTools" { run "dotnet tool restore" }
     stage "Clean" {
         run (
             cleanFolders
-                [| "bin"
+                [| analysisReportsDir
+                   "bin"
                    "src/Fantomas.FCS/bin/Release"
                    "src/Fantomas.FCS/obj/Release"
                    "src/Fantomas.Core/bin/Release"
@@ -94,22 +78,10 @@ pipeline "Build" {
         )
     }
     stage "CheckFormat" { run "dotnet fantomas src docs build.fsx --check" }
-    stage "RestoreAnalyzers" { run $"dotnet restore %s{analyzersProjectPath}" }
     stage "Build" { run "dotnet build -c Release" }
     stage "Analyze" {
-        envVars
-            [| "DOTNET_ROLL_FORWARD_TO_PRERELEASE", "1"
-               "DOTNET_ROLL_FORWARD", "LatestMajor" |]
-        run (
-            analyzeProjects
-                [ "./src/Fantomas/Fantomas.fsproj"
-                  "./src/Fantomas.Benchmarks/Fantomas.Benchmarks.fsproj"
-                  "./src/Fantomas.Client/Fantomas.Client.fsproj"
-                  "./src/Fantomas.Client.Tests/Fantomas.Client.Tests.fsproj"
-                  "./src/Fantomas.Core/Fantomas.Core.fsproj"
-                  "./src/Fantomas.Core.Tests/Fantomas.Core.Tests.fsproj"
-                  "./src/Fantomas.Tests/Fantomas.Tests.fsproj" ]
-        )
+        run (fun _ -> async { System.IO.Directory.CreateDirectory(analysisReportsDir) |> ignore })
+        run "dotnet msbuild /t:AnalyzeSolution"
     }
     stage "UnitTests" { run "dotnet test -c Release" }
     stage "Pack" { run "dotnet pack --no-restore -c Release -o ./bin" }

diff --git a/src/Fantomas.Benchmarks/packages.lock.json b/src/Fantomas.Benchmarks/packages.lock.json
@@ -28,6 +28,12 @@
         "resolved": "6.0.4",
         "contentHash": "CYqAfmO7JvN38M+ACkstS8taVfl8C0mCkvSiBAshfKuu2Nut6+8MuFU7Wahu09wGIyFPlRz5ArFWxSOM5mhMSA=="
       },
+      "G-Research.FSharp.Analyzers": {
+        "type": "Direct",
+        "requested": "[0.1.6, )",
+        "resolved": "0.1.6",
+        "contentHash": "1WyLN4LsQVQUprNr5adpLcYA7Dbn1ohGQ3Pch4qoVflKWZRuFb81pDziFZN/KOqPHdlQUx2BLAE5LIKGD46o5g=="
+      },
       "BenchmarkDotNet.Annotations": {
         "type": "Transitive",
         "resolved": "0.13.2",

diff --git a/src/Fantomas.Client.Tests/packages.lock.json b/src/Fantomas.Client.Tests/packages.lock.json
@@ -14,6 +14,12 @@
         "resolved": "6.0.1",
         "contentHash": "VrFAiW8dEEekk+0aqlbvMNZzDvYXmgWZwAt68AUBqaWK8RnoEVUNglj66bZzhs4/U63q0EfXlhcEKnH1sTYLjw=="
       },
+      "G-Research.FSharp.Analyzers": {
+        "type": "Direct",
+        "requested": "[0.1.6, )",
+        "resolved": "0.1.6",
+        "contentHash": "1WyLN4LsQVQUprNr5adpLcYA7Dbn1ohGQ3Pch4qoVflKWZRuFb81pDziFZN/KOqPHdlQUx2BLAE5LIKGD46o5g=="
+      },
       "Microsoft.NET.Test.Sdk": {
         "type": "Direct",
         "requested": "[17.5.0, )",

diff --git a/src/Fantomas.Client/packages.lock.json b/src/Fantomas.Client/packages.lock.json
@@ -20,6 +20,12 @@
         "resolved": "5.0.1",
         "contentHash": "96YN8cgEVSpFhENBs+oXmxskFOQIjdW/pGCtyR+X8URYGbbQk0Fpu56uKHTOl7BEj6bSiZCuE8sjr9FdlXjoUQ=="
       },
+      "G-Research.FSharp.Analyzers": {
+        "type": "Direct",
+        "requested": "[0.1.6, )",
+        "resolved": "0.1.6",
+        "contentHash": "1WyLN4LsQVQUprNr5adpLcYA7Dbn1ohGQ3Pch4qoVflKWZRuFb81pDziFZN/KOqPHdlQUx2BLAE5LIKGD46o5g=="
+      },
       "Ionide.KeepAChangelog.Tasks": {
         "type": "Direct",
         "requested": "[0.1.8, )",

diff --git a/src/Fantomas.Core.Tests/packages.lock.json b/src/Fantomas.Core.Tests/packages.lock.json
@@ -28,6 +28,12 @@
           "NUnit": "[3.13.2, 3.14.0)"
         }
       },
+      "G-Research.FSharp.Analyzers": {
+        "type": "Direct",
+        "requested": "[0.1.6, )",
+        "resolved": "0.1.6",
+        "contentHash": "1WyLN4LsQVQUprNr5adpLcYA7Dbn1ohGQ3Pch4qoVflKWZRuFb81pDziFZN/KOqPHdlQUx2BLAE5LIKGD46o5g=="
+      },
       "Microsoft.NET.Test.Sdk": {
         "type": "Direct",
         "requested": "[17.5.0, )",

diff --git a/src/Fantomas.Core/packages.lock.json b/src/Fantomas.Core/packages.lock.json
@@ -20,6 +20,12 @@
         "resolved": "6.0.1",
         "contentHash": "VrFAiW8dEEekk+0aqlbvMNZzDvYXmgWZwAt68AUBqaWK8RnoEVUNglj66bZzhs4/U63q0EfXlhcEKnH1sTYLjw=="
       },
+      "G-Research.FSharp.Analyzers": {
+        "type": "Direct",
+        "requested": "[0.1.6, )",
+        "resolved": "0.1.6",
+        "contentHash": "1WyLN4LsQVQUprNr5adpLcYA7Dbn1ohGQ3Pch4qoVflKWZRuFb81pDziFZN/KOqPHdlQUx2BLAE5LIKGD46o5g=="
+      },
       "Ionide.KeepAChangelog.Tasks": {
         "type": "Direct",
         "requested": "[0.1.8, )",

diff --git a/src/Fantomas.FCS/packages.lock.json b/src/Fantomas.FCS/packages.lock.json
@@ -30,6 +30,12 @@
           "FsLexYacc.Runtime": "11.2.0"
         }
       },
+      "G-Research.FSharp.Analyzers": {
+        "type": "Direct",
+        "requested": "[0.1.6, )",
+        "resolved": "0.1.6",
+        "contentHash": "1WyLN4LsQVQUprNr5adpLcYA7Dbn1ohGQ3Pch4qoVflKWZRuFb81pDziFZN/KOqPHdlQUx2BLAE5LIKGD46o5g=="
+      },
       "Ionide.KeepAChangelog.Tasks": {
         "type": "Direct",
         "requested": "[0.1.8, )",

diff --git a/src/Fantomas.Tests/packages.lock.json b/src/Fantomas.Tests/packages.lock.json
@@ -28,6 +28,12 @@
           "NUnit": "[3.13.2, 3.14.0)"
         }
       },
+      "G-Research.FSharp.Analyzers": {
+        "type": "Direct",
+        "requested": "[0.1.6, )",
+        "resolved": "0.1.6",
+        "contentHash": "1WyLN4LsQVQUprNr5adpLcYA7Dbn1ohGQ3Pch4qoVflKWZRuFb81pDziFZN/KOqPHdlQUx2BLAE5LIKGD46o5g=="
+      },
       "Microsoft.NET.Test.Sdk": {
         "type": "Direct",
         "requested": "[17.5.0, )",

diff --git a/src/Fantomas/packages.lock.json b/src/Fantomas/packages.lock.json
@@ -36,6 +36,12 @@
         "resolved": "6.0.1",
         "contentHash": "VrFAiW8dEEekk+0aqlbvMNZzDvYXmgWZwAt68AUBqaWK8RnoEVUNglj66bZzhs4/U63q0EfXlhcEKnH1sTYLjw=="
       },
+      "G-Research.FSharp.Analyzers": {
+        "type": "Direct",
+        "requested": "[0.1.6, )",
+        "resolved": "0.1.6",
+        "contentHash": "1WyLN4LsQVQUprNr5adpLcYA7Dbn1ohGQ3Pch4qoVflKWZRuFb81pDziFZN/KOqPHdlQUx2BLAE5LIKGD46o5g=="
+      },
       "Ignore": {
         "type": "Direct",
         "requested": "[0.1.46, )",