fsprojects / fsprojects/FSharpLint
Adding SARIF result format support for FSharpLint
Nobody has claimed this yet.
- Dominant language
- F#
- Stars
- 327
- Forks
- 74
- PR merge metrics
- No merged PRs in 30d
Description
Hello! We are interested in adding support for output in the open-standard SARIF format to the FSharpLint. SARIF support is required to integrate it in GitHub code scanning. Doing so would make it available to every repo in GitHub and could result in increase in user base.
More about SARIF here:
What is SARIF?
Why SARIF?
If you agree, we will be happy to looking into necessary code changes and also creating a starter workflow to make it available as a GitHub code scanner.
I see the tool already has a --format flag so we are looking at adding sarif to that list. Let me know if have any instructions, thanks!
Thanks,
Shaopeng
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating the existing --format flag handling and the output-format implementations in FSharpLint, then review the linked SARIF documentation and GitHub code-scanning requirements. Add SARIF output alongside the existing formats and, if included in scope, a starter GitHub workflow; done means the generated result can be consumed by GitHub code scanning.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- fsharp, github-actions
- Domain
- ci-cd, cli, tooling
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100