WIP: Add Sarif output support to FSharpLint.Console #702
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Numpsy
commented
Mar 10, 2024
|
It might also be possible to make it generate a sarif report from the |
|
Rebased on top of the latest code (The Paket changes are gone now, so previous comments about that don't apply any more |
xperiandri
requested changes
Jul 6, 2025
Comment on lines
+3
to
+8
| open FSharpLint.Framework | ||
| open System.IO | ||
| open System | ||
| open Microsoft.CodeAnalysis.Sarif | ||
| open Microsoft.CodeAnalysis.Sarif.Writers | ||
| open FSharpLint.Console.Output |
There was a problem hiding this comment.
Suggested change
| open FSharpLint.Framework | |
| open System.IO | |
| open System | |
| open Microsoft.CodeAnalysis.Sarif | |
| open Microsoft.CodeAnalysis.Sarif.Writers | |
| open FSharpLint.Console.Output | |
| open System | |
| open System.IO | |
| open Microsoft.CodeAnalysis.Sarif | |
| open Microsoft.CodeAnalysis.Sarif.Writers | |
| open FSharpLint.Framework | |
| open FSharpLint.Console.Output |
Comment on lines
+23
to
+30
| let driver = ToolComponent() | ||
| driver.Name <- "FSharpLint.Console" | ||
| driver.InformationUri <- Uri("https://fsprojects.github.io/FSharpLint/") | ||
| driver.Version <- string<Version> (System.Reflection.Assembly.GetExecutingAssembly().GetName().Version) | ||
| let tool = Tool() | ||
| tool.Driver <- driver | ||
| let run = Run() | ||
| run.Tool <- tool |
There was a problem hiding this comment.
Suggested change
| let driver = ToolComponent() | |
| driver.Name <- "FSharpLint.Console" | |
| driver.InformationUri <- Uri("https://fsprojects.github.io/FSharpLint/") | |
| driver.Version <- string<Version> (System.Reflection.Assembly.GetExecutingAssembly().GetName().Version) | |
| let tool = Tool() | |
| tool.Driver <- driver | |
| let run = Run() | |
| run.Tool <- tool | |
| let driver = | |
| ToolComponent( | |
| Name = "FSharpLint.Console", | |
| InformationUri = Uri("https://fsprojects.github.io/FSharpLint/"), | |
| Version = string<Version> (System.Reflection.Assembly.GetExecutingAssembly().GetName().Version), | |
| ) | |
| let tool = Tool(Driver = driver) | |
| let run = Run(Tool = tool) |
Comment on lines
+46
to
+48
| let reportDescriptor = ReportingDescriptor() | ||
| reportDescriptor.Id <- analyzerResult.RuleIdentifier | ||
| reportDescriptor.Name <- analyzerResult.RuleName |
There was a problem hiding this comment.
Suggested change
| let reportDescriptor = ReportingDescriptor() | |
| reportDescriptor.Id <- analyzerResult.RuleIdentifier | |
| reportDescriptor.Name <- analyzerResult.RuleName | |
| let reportDescriptor = ReportingDescriptor( | |
| Id = analyzerResult.RuleIdentifier, | |
| Name = analyzerResult.RuleName | |
| ) |
Comment on lines
+61
to
+62
| let result = Result() | ||
| result.RuleId <- reportDescriptor.Id |
There was a problem hiding this comment.
Suggested change
| let result = Result() | |
| result.RuleId <- reportDescriptor.Id | |
| let result = Result(RuleId = reportDescriptor.Id) |
Comment on lines
+74
to
+76
| let msg = Message() | ||
| msg.Text <- analyzerResult.Details.Message | ||
| result.Message <- msg |
There was a problem hiding this comment.
Suggested change
| let msg = Message() | |
| msg.Text <- analyzerResult.Details.Message | |
| result.Message <- msg | |
| let msg = Message( | |
| Text = analyzerResult.Details.Message, | |
| Message = msg | |
| ) |
Comment on lines
+78
to
+91
| let physicalLocation = PhysicalLocation() | ||
|
|
||
| physicalLocation.ArtifactLocation <- | ||
| let al = ArtifactLocation() | ||
| al.Uri <- codeRoot.MakeRelativeUri(Uri(analyzerResult.Details.Range.FileName)) | ||
| al | ||
|
|
||
| physicalLocation.Region <- | ||
| let r = Region() | ||
| r.StartLine <- analyzerResult.Details.Range.StartLine | ||
| r.StartColumn <- analyzerResult.Details.Range.StartColumn + 1 | ||
| r.EndLine <- analyzerResult.Details.Range.EndLine | ||
| r.EndColumn <- analyzerResult.Details.Range.EndColumn + 1 | ||
| r |
There was a problem hiding this comment.
Suggested change
| let physicalLocation = PhysicalLocation() | |
| physicalLocation.ArtifactLocation <- | |
| let al = ArtifactLocation() | |
| al.Uri <- codeRoot.MakeRelativeUri(Uri(analyzerResult.Details.Range.FileName)) | |
| al | |
| physicalLocation.Region <- | |
| let r = Region() | |
| r.StartLine <- analyzerResult.Details.Range.StartLine | |
| r.StartColumn <- analyzerResult.Details.Range.StartColumn + 1 | |
| r.EndLine <- analyzerResult.Details.Range.EndLine | |
| r.EndColumn <- analyzerResult.Details.Range.EndColumn + 1 | |
| r | |
| let physicalLocation = PhysicalLocation( | |
| ArtifactLocation = ArtifactLocation(Uri = codeRoot.MakeRelativeUri(Uri(analyzerResult.Details.Range.FileName))), | |
| Region = Region( | |
| StartLine = analyzerResult.Details.Range.StartLine, | |
| StartColumn = (analyzerResult.Details.Range.StartColumn + 1), | |
| EndLine = analyzerResult.Details.Range.EndLine, | |
| EndColumn = (analyzerResult.Details.Range.EndColumn + 1), | |
| ) |
Comment on lines
+93
to
+94
| let location: Location = Location() | ||
| location.PhysicalLocation <- physicalLocation |
There was a problem hiding this comment.
Suggested change
| let location: Location = Location() | |
| location.PhysicalLocation <- physicalLocation | |
| let location: Location = Location(PhysicalLocation = physicalLocation) |
|
Rebased to fix conflicts, haven't got to the other comments yet. |
|
Resolves #554 |
xperiandri
force-pushed
the
users/rw/sarif
branch
from
95320fc to
02456e1
Compare
This is using the Microsoft Sarif.Sdk to write Sarif files.
xperiandri
force-pushed
the
users/rw/sarif
branch
from
02456e1 to
1a366ef
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
refs #554
I've recently been having a go at running some things at work through the FSharp.Analyzers.SDK analysis tools and pushing the generated Sarif report files into DevOps CI builds, and I thought it might be useful to see if I could get FSharpLint results pushed out in the same way - so, this is a first attempt at adding Sarif report generation into FSharpLint.Console.
Note: The Sarif writer code is currently a lightly modified version of the report code from https://github.com/ionide/FSharp.Analyzers.SDK just to try to get it working, so if the code style and such is wrong that's the reason.