StaticMemberEnum.Generator 1.0.0

Auto-implement `.KnownValues()` from a type with static members as enum values. Like listing the predefined colors on `System.Drawing.Color`.

Install-Package StaticMemberEnum.Generator -Version 1.0.0
dotnet add package StaticMemberEnum.Generator --version 1.0.0
<PackageReference Include="StaticMemberEnum.Generator" Version="1.0.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add StaticMemberEnum.Generator --version 1.0.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: StaticMemberEnum.Generator, 1.0.0"
#r directive can be used in F# Interactive, C# scripting and .NET Interactive. Copy this into the interactive tool or source code of the script to reference the package.
// Install StaticMemberEnum.Generator as a Cake Addin
#addin nuget:?package=StaticMemberEnum.Generator&version=1.0.0

// Install StaticMemberEnum.Generator as a Cake Tool
#tool nuget:?package=StaticMemberEnum.Generator&version=1.0.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.

Static Property Enum Generator

Why

Enums are great, but often data has a fixed set of known values AND should allows for unknown values.

This can be accomplished with static members on a type. For example System.Drawing.Color.
More examples and exploration is availabe here.

This comes with some disadvantages though, like not being able to list the known values without writing boilerplate for every type.

That's what this library solves. It uses the new C# 9 Source Generators to automattically add a .KnownValues()
including all static members that have the same type as the containing declaration.

Example. Given

namespace Some.Namespace{
	[StaticMemberEnum]
	partial class GolfClubTypes{
		private readonly string _id;
		public GolfClubTypes(string id) => _id = id;
		public static GolfClubTypes Driver = new GolfClubTypes("Driver");
		public static GolfClubTypes Iron = new GolfClubTypes("Iron");
		public static GolfClubTypes Wedge = new GolfClubTypes("Wedge");
		public static GolfClubTypes Hybrid = new GolfClubTypes("Hybrid");
		public static GolfClubTypes Wood = new GolfClubTypes("Wood");
	}
}

The library generates

namespace Some.Namespace{
	partial class GolfClubTypes{
		public static IEnumerable<GolfClubTypes> KnownValues(){
			return new []{Driver, Iron, Wedge, Hybrid, Woood};
		}
	}
}

So that you can call

IEnumerable<GolfClubTypes> clubs = GolfClubTypes.KnownValues();

A few potential gotchas

  • The member enum definition has to be partial because source generators behave about the same as adding new sources files.
  • This generator currently doesn't work on nested classes. It would require the whole hierarchy of classes to be partial. That seems smelly to me, so I decided not to support it. Let me know in the github issues if you have reasons I should change my mind.
  • Classes won't have value-based equality behavior by default, and structs don't define == by default. I recommend using records.

Static Property Enum Generator

Why

Enums are great, but often data has a fixed set of known values AND should allows for unknown values.

This can be accomplished with static members on a type. For example System.Drawing.Color.
More examples and exploration is availabe here.

This comes with some disadvantages though, like not being able to list the known values without writing boilerplate for every type.

That's what this library solves. It uses the new C# 9 Source Generators to automattically add a .KnownValues()
including all static members that have the same type as the containing declaration.

Example. Given

namespace Some.Namespace{
	[StaticMemberEnum]
	partial class GolfClubTypes{
		private readonly string _id;
		public GolfClubTypes(string id) => _id = id;
		public static GolfClubTypes Driver = new GolfClubTypes("Driver");
		public static GolfClubTypes Iron = new GolfClubTypes("Iron");
		public static GolfClubTypes Wedge = new GolfClubTypes("Wedge");
		public static GolfClubTypes Hybrid = new GolfClubTypes("Hybrid");
		public static GolfClubTypes Wood = new GolfClubTypes("Wood");
	}
}

The library generates

namespace Some.Namespace{
	partial class GolfClubTypes{
		public static IEnumerable<GolfClubTypes> KnownValues(){
			return new []{Driver, Iron, Wedge, Hybrid, Woood};
		}
	}
}

So that you can call

IEnumerable<GolfClubTypes> clubs = GolfClubTypes.KnownValues();

A few potential gotchas

  • The member enum definition has to be partial because source generators behave about the same as adding new sources files.
  • This generator currently doesn't work on nested classes. It would require the whole hierarchy of classes to be partial. That seems smelly to me, so I decided not to support it. Let me know in the github issues if you have reasons I should change my mind.
  • Classes won't have value-based equality behavior by default, and structs don't define == by default. I recommend using records.

  • .NETStandard 2.0

    • 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 History

Version Downloads Last updated
1.0.0 104 12/29/2020