ardalis/GuardClauses

Analyzers that verify this is used in all public methods

Open

#165 opened on Dec 21, 2021

View on GitHubContributor guide
 (3 comments) (0 reactions) (0 assignees)C# (292 forks)github user discovery
hacktoberfesthelp wanted

Repository metrics

Stars
 (3,305 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

Awesome package. Love it.

We currently employ units tests to verify that guard clauses are used in all public methods, which is done by extending the AutoFixture idiom helper and then searching all packages in the solution.

Testing code quality via unit tests isn't ideal, and it would be nice not to have it as part of our test suite but instead utilize Roslyn, which I assume might be possible. (I might be wrong, though!)

Not sure if this would be too much of a stretch compared to this otherwise light package, but one might name a separate sub-project.

I'll try to work on it myself if I have time one day, but I am currently somewhat busy.

Contributor guide

Research direction
Implement a Roslyn analyzer that inspects all public methods of classes and reports diagnostics if a guard clause (e.g., Guard.Against.Null) is not the first statement. Use SyntaxTreeAnalysisContext to find method declarations and check for guard calls. Create a separate project for the analyzer and package it as a NuGet or a source generator. Test with unit tests using Microsoft.CodeAnalysis.CSharp.Testing.
Tech stack
csharp
Domain
developer experience
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Mostly clear
Prerequisites
C#.NETRoslyn analyzer basics
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
50