requiredenum by Yaroslav

• NuGet / site data
• Details
  • Info
  • Author
  • Original Readme
  • About
• How to use
  • Example (source csproj, source files)
  • Generated Files
• Useful
  • Download Example (.NET C#)
  • Share requiredenum
  • Category "Enum" has the following generators:
  • See category

NuGet / site data

Details

Info

info

Name: requiredenum

RequiredEnum is an open-source analyzer that helps handle all enum values for switch.

Author: Yaroslav

NuGet: https://www.nuget.org/packages/requiredenum/

You can find more details at https://github.com/emptycoder/RequiredEnum

Source: https://github.com/emptycoder/RequiredEnum

Author

note

Yaroslav

Original Readme

note

RequiredEnum

RequiredEnum is an open-source analyzer that helps handle all enum values for switch.

Installation

NuGet: dotnet add package requiredenum

Usage

Just add 'Required' prefix for any name of enum in your project and you will get the error when one of cases weren't handle in a switch statement.

var test = (RequiredNumbers) Random.Shared.Next(0, Enum.GetNames(typeof(RequiredNumbers)).Length);
switch (test)
{
    case RequiredNumbers.Zero:
        break;
    case RequiredNumbers.One:
        break;
    default:
        throw new ArgumentOutOfRangeException();
}

internal enum RequiredNumbers
{
    Zero,
    One,
    Two
}

This code will throw the error ('Two' case wasn't handle) and it can't be compiled.

License

RequiredEnum distributed under MIT license.

About

note

Raise an error at compile time if not have switch handle case all enums values

How to use

Example (source csproj, source files)

CSharp Project

This is the CSharp Project that references requiredenum

<Project Sdk="Microsoft.NET.Sdk">

  <PropertyGroup>
    <OutputType>Exe</OutputType>
    <TargetFramework>net9.0</TargetFramework>
    <ImplicitUsings>enable</ImplicitUsings>
    <Nullable>enable</Nullable>
  </PropertyGroup>

  <PropertyGroup>
		<EmitCompilerGeneratedFiles>true</EmitCompilerGeneratedFiles>
		<CompilerGeneratedFilesOutputPath>$(BaseIntermediateOutputPath)\GX</CompilerGeneratedFilesOutputPath>
	</PropertyGroup>

  <ItemGroup>
    <PackageReference Include="RequiredEnum" Version="0.0.1">
      <PrivateAssets>all</PrivateAssets>
      <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
    </PackageReference>
  </ItemGroup>

  
</Project>

Program.cs

This is the use of requiredenum in Program.cs

// See https://aka.ms/new-console-template for more information
using EnumDemo;

Console.WriteLine("Hello, World!");
RequiredCarTypes myCar = RequiredCarTypes.Tesla;
switch(myCar)
{
    //comment any case to see the error in action
    case RequiredCarTypes.None:
        Console.WriteLine("No car");
        break;
    case RequiredCarTypes.Dacia:
        Console.WriteLine("Dacia");
        break;
    case RequiredCarTypes.Tesla:
        Console.WriteLine("Tesla");
        break;
    case RequiredCarTypes.BMW:
        Console.WriteLine("BMW");
        break;
    case RequiredCarTypes.Mercedes:
        Console.WriteLine("Mercedes");
        break;
    default:
        Console.WriteLine("Unknown car");
        break;
}

RequiredCarTypes.cs

This is the use of requiredenum in RequiredCarTypes.cs

namespace EnumDemo;
public enum RequiredCarTypes
{
    None,
    Dacia ,
    Tesla ,
    BMW ,
    Mercedes ,
}

Generated Files

Useful

Download Example (.NET C#)

tip

Download Example project requiredenum

Share requiredenum

• Share on Facebook
• Share in Twitter
• Share on Reddit
• Share on Linkedin

https://ignatandrei.github.io/RSCG_Examples/v2/docs/requiredenum

Category "Enum" has the following generators:

1 CredFetoEnum 2023-10-12

2 EnumClass 2023-08-08

3 EnumsEnhanced 2025-08-05

4 EnumUtilities 2024-04-05

5 Flaggen 2025-07-23

6 FusionReactor 2024-04-06

7 Genbox.FastEnum 2025-08-03

8 jos.enumeration 2025-07-20

9 NetEscapades.EnumGenerators 2023-04-16

10 PMart.Enumeration 2025-03-25

11 RapidEnum 2025-10-04

12 requiredenum 2025-08-14

See category

Enum