Emik.Analyzers.Matches 1.2.0

There is a newer version of this package available.
See the version list below for details.
dotnet add package Emik.Analyzers.Matches --version 1.2.0                
NuGet\Install-Package Emik.Analyzers.Matches -Version 1.2.0                
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="Emik.Analyzers.Matches" Version="1.2.0" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Emik.Analyzers.Matches --version 1.2.0                
#r "nuget: Emik.Analyzers.Matches, 1.2.0"                
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install Emik.Analyzers.Matches as a Cake Addin
#addin nuget:?package=Emik.Analyzers.Matches&version=1.2.0

// Install Emik.Analyzers.Matches as a Cake Tool
#tool nuget:?package=Emik.Analyzers.Matches&version=1.2.0                

Emik.Analyzers.Matches

NuGet package License

Analyzer for compile-time parameter validation with the power of regex.

This project has a dependency to Emik.Morsels, if you are building this project, refer to its README first.



Example

[StringSyntax(StringSyntaxAttribute.Regex)]
const string ValidatorQuery = @"^\d{2}$";

[GeneratedRegex(ValidatorQuery)]
partial Regex Validator();

byte? Test([Emik.Match(ValidatorQuery)] string x)
{
    if (!Validator().IsMatch(out var capture)) // OK
        return null;

    if (!Validator().IsMatch(out _, out var captureThatDoesNotExist)) // Error
        return null;

    if (!new Regex(x).IsMatch(out _)) // Warning: Not a constant
        return null;

    return byte.Parse(capture);
}

string TestTyped(X x) => x.Value;

record X(string Value)
{
    public static implicit operator X([Match(@"^\w{3}$")] string value) => new(value);
}

Test("12"); // OK
Test("34"); // OK
TestTyped("foo"); // OK
TestTyped("bar"); // OK

Test("1"); // Error
Test("foobar"); // Error
TestTyped("12"); // Error
TestTyped("food"); // Error

Test(bool.FalseString); // Warning: Not a constant
TestTyped(bool.TrueString); // Warning: Not a constant

Lints

Id Title
EAM001 Argument fails regex test
EAM002 Non-constant argument may fail regex test
EAM003 Argument regex test took too long
EAM004 Capture group doesn't exist
EAM005 Missing out declaration for capture group
EAM006 Non-constant Regex may have wrong number of capture groups

Contribute

Issues and pull requests are welcome to help this repository be the best it can be.

License

This repository falls under the MPL-2 license.

There are no supported framework assets in this package.

Learn more about Target Frameworks and .NET Standard.

This package has no dependencies.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
1.2.2 410 11/2/2023
1.2.1 260 10/4/2023
1.2.0 210 5/21/2023
1.1.0 183 5/12/2023
1.0.0 212 4/20/2023