generation

Documentation

Overview

Package generation provides tools for generating resource-driven API boilerplate in Go & TypeScript based on Go structures and a Spanner DB schema.

Index

• type FileWriter
  • func (f *FileWriter) GoFormatBytes(fileName string, data []byte) ([]byte, error)
  • func (f *FileWriter) WriteBytesToFile(file *os.File, data []byte) error
• type Generator
  • func NewResourceGenerator(ctx context.Context, resourceSourcePath, migrationSourceURL string, ...) (Generator, error)
  • func NewTypescriptGenerator(ctx context.Context, resourceSourcePath, migrationSourceURL, targetDir string, ...) (Generator, error)
• type HandlerType
• type Option
  • func CaserInitialismOverrides(overrides map[string]bool) Option
  • func WithConsolidatedHandlers(route string, consolidateAll bool, resources ...string) Option
  • func WithPluralOverrides(overrides map[string]string) Option
  • func WithRPC(rpcPackageDir string) Option
  • func WithSpannerEmulatorVersion(version string) Option
• type ResourceOption
  • func GenerateHandlers(targetDir string) ResourceOption
  • func GenerateRoutes(targetDir, targetPackage, routePrefix string) ResourceOption
• type TSOption
  • func GenerateEnums() TSOption
  • func GenerateMetadata() TSOption
  • func GeneratePermissions() TSOption
  • func WithTypescriptOverrides(overrides map[string]string) TSOption

Types

type FileWriter

type FileWriter struct {
	// contains filtered or unexported fields
}

FileWriter provides convenience methods to safely goformat & write bytes to file.

func (*FileWriter) GoFormatBytes

func (f *FileWriter) GoFormatBytes(fileName string, data []byte) ([]byte, error)

GoFormatBytes runs Go Format on bytes for a go source file. If the Go source data is not syntactically correct, GoFormatBytes will return an error. Safe to use concurrently.

func (*FileWriter) WriteBytesToFile

func (f *FileWriter) WriteBytesToFile(file *os.File, data []byte) error

WriteBytesToFile truncates a file and writes given bytes to it.

type Generator

type Generator interface {
	Generate() error
	Close() error
}

Generator provides methods for generating Go or Typescript for a resource-driven web application.

func NewResourceGenerator

func NewResourceGenerator(ctx context.Context, resourceSourcePath, migrationSourceURL string, localPackages []string, options ...ResourceOption) (Generator, error)

NewResourceGenerator constructs a new Generator for generating a resource-driven API.

func NewTypescriptGenerator

func NewTypescriptGenerator(ctx context.Context, resourceSourcePath, migrationSourceURL, targetDir string, rc *resource.Collection, options ...TSOption) (Generator, error)

NewTypescriptGenerator constructs a new Generator for generating Typescript for a resource-driven Angular app.

type HandlerType

type HandlerType string

HandlerType describes the possible handlers implemented in a resource-driven API.

const (
	// AllHandlers is create, update, read, delete, and list handlers.
	AllHandlers HandlerType = "allHandlers"
	// ListHandler is the list handler.
	ListHandler HandlerType = "listHandler"
	// ReadHandler is the read handler.
	ReadHandler HandlerType = "readHandler"
	// PatchHandler is the patch handler.
	PatchHandler HandlerType = "patchHandler"
)

type Option

type Option func(any) error

Option is a functional option for configuring a Generator

func CaserInitialismOverrides

func CaserInitialismOverrides(overrides map[string]bool) Option

CaserInitialismOverrides sets the initialism for any resources that are not covered by the default initialisms.

func WithConsolidatedHandlers

func WithConsolidatedHandlers(route string, consolidateAll bool, resources ...string) Option

WithConsolidatedHandlers enables generating a handler file for all or a list of resources.

func WithPluralOverrides

func WithPluralOverrides(overrides map[string]string) Option

WithPluralOverrides sets the pluralization for any resources that are not covered by the default pluralizations.

func WithRPC

func WithRPC(rpcPackageDir string) Option

WithRPC enables generating RPC method handlers.

func WithSpannerEmulatorVersion

func WithSpannerEmulatorVersion(version string) Option

WithSpannerEmulatorVersion sets the version of the Spanner image pulled from gcr.io

type ResourceOption

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

ResourceOption is a functional option for configuring a ResourceGenerator

func GenerateHandlers

func GenerateHandlers(targetDir string) ResourceOption

GenerateHandlers enables generating a handler file for each resource. To generate resource handlers in a single file use WithConsolidatedHandlers.

func GenerateRoutes

func GenerateRoutes(targetDir, targetPackage, routePrefix string) ResourceOption

GenerateRoutes enables generating a router file containing routes for all handlers and RPC methods.

type TSOption

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

TSOption is a functional option for configuring a TypescriptGenerator

func GenerateEnums

func GenerateEnums() TSOption

GenerateEnums enables generating constants for resources that have been tagged with `@enumerate` and have Id and Description values in the schema migrations directory.

func GenerateMetadata

func GenerateMetadata() TSOption

GenerateMetadata enables generating information necessary for Typescript configuration of resources.

func GeneratePermissions

func GeneratePermissions() TSOption

GeneratePermissions enables generating resource and resource-field level permission mappings, based on the routes registered in the app router. Requires `collect_resource_permissions` build tag.

func WithTypescriptOverrides

func WithTypescriptOverrides(overrides map[string]string) TSOption

WithTypescriptOverrides sets the Typescript type for a given Go type.