README
¶
go
Go client code generator implementation.
Responsibility
Generates type-safe Go code from OpenFGA schemas, producing:
- Object type constants (
TypeUser,TypeRepository) - Relation constants (
RelCanRead,RelOwner) - Constructor functions (
User(id),Repository(id)) - Wildcard constructors (
AnyUser()foruser:*patterns)
Architecture Role
internal/clientgen (registry)
│
└── internal/clientgen/go
│
└── Implements Generator interface
Registered via init(), discovered by the CLI through the registry.
Output
Single file schema_gen.go containing all generated code. The file imports the melange runtime for type definitions.
Design Decisions
- Uses
melange.Objectandmelange.Relationtypes from runtime - Pascal-cased type names, prefixed with
TypeandRel - Supports relation filtering via prefix (e.g., only
can_*relations) - Validates schema for cycles before generating
Documentation
¶
Overview ¶
Package gogen implements the Go client code generator for melange.
This generator produces type-safe Go code from authorization schemas, including object type constants, relation constants, and constructor functions.
Generated code uses the melange runtime (github.com/pthm/melange/melange) for type definitions.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Generator ¶
type Generator struct{}
Generator implements clientgen.Generator for Go.
func (*Generator) DefaultConfig ¶
DefaultConfig returns default configuration for Go code generation.
func (*Generator) Generate ¶
func (g *Generator) Generate(types []schema.TypeDefinition, cfg *clientgen.Config) (map[string][]byte, error)
Generate produces Go client code from the given type definitions.
Returns a single file map entry with key "schema_gen.go".
Generated code includes:
- ObjectType constants (TypeUser, TypeRepository, etc.)
- Relation constants (RelCanRead, RelOwner, etc.)
- Constructor functions (User(id), Repository(id), etc.)
- Wildcard constructors (AnyUser(), AnyRepository(), etc.)
Source Files