NetEvolve.Arguments.Analyser 3.3.0

NetEvolve.Arguments.Analyser

A Roslyn analyzer and code-fix package that promotes usage of NetEvolve.Arguments throw-helper APIs, rewriting manual argument-validation if blocks on every target framework — including .NET Standard 2.0 and .NET Framework 4.7.2+, which predate the built-in CA1510/CA1511/CA1512/CA1513 analyzers.

Features

• 9 analyzer rules (NEA0001-NEA0009) - Covers null checks, string/collection validation, numeric ranges, Guid, and disposed-object checks
• Works everywhere - Unlike the built-in Roslyn rules, these analyzers fire regardless of target framework, since NetEvolve.Arguments polyfills the throw-helper APIs on frameworks that predate them
• No duplicate diagnostics - Rules that mirror a built-in CA rule (NEA0001, NEA0002, NEA0003, NEA0005) automatically stay silent once the compilation already exposes the real BCL member, so CA1510/CA1511/CA1512/CA1513 take over seamlessly
• One-click code fixes - Every diagnostic ships with a code fix that rewrites the offending if block in place, usable per-occurrence or via Fix All in Document/Project/Solution scope
• Recognizes common variants - Null checks match is null, ==, ReferenceEquals, negated forms, and null-coalescing throws (arg ?? throw ...)

Installation

NuGet Package Manager

Install-Package NetEvolve.Arguments.Analyser

.NET CLI

dotnet add package NetEvolve.Arguments.Analyser

PackageReference

<PackageReference Include="NetEvolve.Arguments.Analyser" PrivateAssets="all" />

Quick Start

using System;

public class UserService
{
    public void CreateUser(string username, int age)
    {
        // NEA0001 suggests replacing this with ArgumentNullException.ThrowIfNull(username)
        if (username is null)
        {
            throw new ArgumentNullException(nameof(username));
        }

        // NEA0003 suggests replacing this with ArgumentOutOfRangeException.ThrowIfNegative(age)
        if (age < 0)
        {
            throw new ArgumentOutOfRangeException(nameof(age));
        }
    }
}

Rules

Each rule has a dedicated documentation page with the full list of recognized shapes, examples, and suppression instructions.

Example: NEA0001 (null check)

// Before
if (argument is null) throw new ArgumentNullException(nameof(argument));

// After
ArgumentNullException.ThrowIfNull(argument);

Example: NEA0003 (range check)

// Before
if (age < 0) throw new ArgumentOutOfRangeException(nameof(age));

// After
ArgumentOutOfRangeException.ThrowIfNegative(age);

Example: NEA0007 (collection count)

// Before
if (items.Count > 100) throw new ArgumentException(nameof(items));

// After
ArgumentException.ThrowIfCountGreaterThan(items, 100);

Not covered

A few NetEvolve.Arguments throw-helpers don't have a dedicated rule, because their manual equivalents can be written in too many syntactically different ways to detect reliably without false negatives or false positives:

• ArgumentException.ThrowIfNullOrEmpty for collections (IEnumerable<T>/ICollection<T>/IReadOnlyCollection<T>/T[])
• ArgumentException.ThrowIfContainsDuplicates
• ArgumentOutOfRangeException.ThrowIfInPast/ThrowIfInFuture

See the open issues for tracking status.

Requirements

• .NET Standard 2.0 or higher for the analyzed project
• Visual Studio 2022 17.8+, Rider, or any IDE/CLI supporting Roslyn source analyzers

Related Packages

• NetEvolve.Arguments - The polyfill library this analyzer promotes usage of

Documentation

For complete solution documentation, architecture decisions, and contributing guidelines, visit the Arguments Repository.

Contributing

Contributions are welcome! Please read the Contributing Guidelines before submitting a pull request.

Support

• Issues: Report bugs or request features on GitHub Issues
• Documentation: Read the full documentation at https://github.com/dailydevops/arguments

License

This project is licensed under the MIT License - see the LICENSE file for details.