integration of analyzers (#1200)

ionide · Nov 26, 2023 · 3d96eda · 3d96eda
1 parent c482f7e
commit 3d96eda
Show file tree

Hide file tree

Showing 10 changed files with 516 additions and 6 deletions.
diff --git a/.config/dotnet-tools.json b/.config/dotnet-tools.json
@@ -19,6 +19,12 @@
       "commands": [
         "fantomas"
       ]
+    },
+    "fsharp-analyzers": {
+      "version": "0.20.2",
+      "commands": [
+        "fsharp-analyzers"
+      ]
     }
   }
 }
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -104,3 +104,23 @@ jobs:
       env:
         BuildNet7: ${{ matrix.build_net7 }}
         BuildNet8: ${{ matrix.build_net8 }}
+
+  analyze:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v3
+
+    - name: Setup .NET
+      uses: actions/setup-dotnet@v3
+
+    - name: Restore tools
+      run: dotnet tool restore
+
+    - name: Run analyzers
+      run: dotnet build -t:AnalyzeSolution -p:TargetFramework=net6.0
+
+    - name: Upload SARIF file
+      uses: github/codeql-action/upload-sarif@v2
+      with:
+        sarif_file: analysisreports
diff --git a/.gitignore b/.gitignore
@@ -45,3 +45,5 @@ test/FsAutoComplete.Tests.Lsp/TestResults/
 
 .tool-versions
 BenchmarkDotNet.Artifacts/
+
+*.sarif
diff --git a/Directory.Build.targets b/Directory.Build.targets
@@ -8,5 +8,10 @@
     </PropertyGroup>
 </Target>
 
+<PropertyGroup>
+    <SarifOutput Condition="$(SarifOutput) == ''">./</SarifOutput>
+    <CodeRoot Condition="$(CodeRoot) == ''">.</CodeRoot>
+    <FSharpAnalyzersOtherFlags>--analyzers-path &quot;$(PkgIonide_Analyzers)/analyzers/dotnet/fs&quot; --code-root $(CodeRoot) --report &quot;$(SarifOutput)/$(MSBuildProjectName)-$(TargetFramework).sarif&quot; --verbose</FSharpAnalyzersOtherFlags>
+</PropertyGroup>
 
 </Project>
diff --git a/Directory.Solution.targets b/Directory.Solution.targets
@@ -10,4 +10,20 @@
   <Target Name="CheckFormat">
     <Exec Command="dotnet fantomas --check @(FormatInputs, ' ') " />
   </Target>
+
+  <ItemGroup>
+    <ProjectsToAnalyze Include="src/**/*.fsproj" />
+  </ItemGroup>
+
+  <Target Name="AnalyzeSolution">
+    <PropertyGroup>
+      <CodeRoot>$(SolutionDir)</CodeRoot>
+      <SarifOutput>$(SolutionDir)/analysisreports</SarifOutput>
+    </PropertyGroup>
+    <MSBuild
+      Projects="@(ProjectsToAnalyze)"
+      Targets="AnalyzeFSharpProject"
+      Properties="CodeRoot=$(CodeRoot);SarifOutput=$(SarifOutput)" />
+  </Target>
+
 </Project>
diff --git a/paket.dependencies b/paket.dependencies
@@ -14,6 +14,8 @@ lowest_matching: true
 nuget BenchmarkDotNet 0.13.5
 nuget Fantomas.Client >= 0.9
 nuget FSharp.Compiler.Service >= 43.8.100
+nuget Ionide.Analyzers 0.4.0
+nuget FSharp.Analyzers.Build 0.2.0
 nuget Ionide.ProjInfo >= 0.62.0
 nuget Ionide.ProjInfo.FCS >= 0.62.0
 nuget Ionide.ProjInfo.ProjectSystem >= 0.62.0
@@ -57,6 +59,8 @@ nuget OpenTelemetry.Exporter.OpenTelemetryProtocol >= 1.3.2 # 1.4 bumps to 7.0 v
 nuget LinkDotNet.StringBuilder 1.18.0
 nuget CommunityToolkit.HighPerformance
 nuget System.Security.Cryptography.Pkcs 6.0.4
+nuget System.Net.Http 4.3.4 # pinned for security reasons
+nuget System.Text.RegularExpressions 4.3.1 # pinned for security reasons
 
 
 group Build

diff --git a/paket.lock b/paket.lock
diff --git a/src/FsAutoComplete.Core/paket.references b/src/FsAutoComplete.Core/paket.references
@@ -13,4 +13,6 @@ Ionide.KeepAChangelog.Tasks
 Microsoft.Extensions.Caching.Memory
 Microsoft.CodeAnalysis
 LinkDotNet.StringBuilder
-CommunityToolkit.HighPerformance
+CommunityToolkit.HighPerformance
+Ionide.Analyzers
+FSharp.Analyzers.Build
diff --git a/src/FsAutoComplete.Logging/paket.references b/src/FsAutoComplete.Logging/paket.references
@@ -2,3 +2,5 @@ FSharp.Core
 
 Microsoft.NETFramework.ReferenceAssemblies
 Ionide.KeepAChangelog.Tasks
+Ionide.Analyzers
+FSharp.Analyzers.Build
diff --git a/src/FsAutoComplete/paket.references b/src/FsAutoComplete/paket.references
@@ -20,4 +20,6 @@ Microsoft.Extensions.Caching.Memory
 OpenTelemetry.Exporter.OpenTelemetryProtocol
 Microsoft.CodeAnalysis
 LinkDotNet.StringBuilder
-CommunityToolkit.HighPerformance
+CommunityToolkit.HighPerformance
+Ionide.Analyzers
+FSharp.Analyzers.Build
Original file line number	Diff line number	Diff line change
Expand Up		@@ -45,3 +45,5 @@ test/FsAutoComplete.Tests.Lsp/TestResults/

		.tool-versions
		BenchmarkDotNet.Artifacts/

		*.sarif