entnum

README

entnum

Under development.

entnum is an ent extension that makes ent use better enums.

This extension has only been tested on SQL systems.

Before

// Color defines the type for the "color" enum field.
type Color string

// Status values.
const (
	ColorRed   Status = "red"
	ColorGreen Status = "green"
	ColorBlue  Status = "blue"
)

After

// Color defines the type for the "color" enum field.
type Color enum.Member[string]

// Color values.
var (
  color      = enum.NewBuilder[string, Color]()
  ColorRed   = color.Add(Color{"red"})
  ColorGreen = color.Add(Color{"green"})
  ColorBlue  = color.Add(Color{"blue"})
  Colors     = color.Enum()
)

Documentation

Index

• Variables
• func IsEnum(f gen.Field) bool
• type Extension
  • func New(opts ...Option) (*Extension, error)
  • func (e *Extension) Templates() []*gen.Template
• type Option

Variables

var (
	TemplateFuncs = template.FuncMap{
		"isEnum": IsEnum,
	}
)

Functions

func IsEnum

func IsEnum(f gen.Field) bool

Types

type Extension

type Extension struct {
	entc.DefaultExtension
}

func New

func New(opts ...Option) (*Extension, error)

New creates a new entnum.Extension to use with entc.

func (*Extension) Templates

func (e *Extension) Templates() []*gen.Template

type Option

type Option interface {
	// contains filtered or unexported methods
}

Option for future use.