microsoft / microsoft/DevSkim

Add support as Roslyn Analyzer

Open
#619 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
C#
Stars
1k
Forks
131
Avg merge
1m
Merged PRs (30d)
1

Description

Is your feature request related to a problem? Please describe.
The experience is clunky when using DevSkim. I either use the command line and output a SARIF file, then use a SARIF viewer, or use a Visual Studio or VS Code extension to integrate. This does not help me because I use JetBrains Rider.

Describe the solution you'd like
What would be great if the analyzers show up as Roslyn Code analyzer so it works when I just run dotnet build without all the extra steps.

Describe alternatives you've considered

  • Creating a VS Code workspace definition with the required extensions (not everyone uses workspaces or VS Code)
  • Creating some onboarding documentation that requires contributors to configure their IDE a certain way (we have mechanisms for that, but not for extensions specifically)
  • Creating a shell script that contributors can call to analyze (the experience is clunky)
  • Hooking MSBuild so that the tooling is run from dotnet tool during regular build (the experience is also clunky)

Additional context
https://github.com/rjmurillo/moq.analyzers/pull/83

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the referenced moq.analyzers pull request and the repository's existing analyzer and build integration points; the issue names no DevSkim files or tests. Define how DevSkim rules should appear as Roslyn analyzers and verify that running dotnet build reports them without the command-line or IDE-extension setup described in the issue.

Written by the indexing model from the issue text.

Assessment

Tech stack
csharp
Domain
security, tooling
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.