generation

Documentation

Overview

package generation provides the ability to generate resource, handler, and typescript permissions and metadata code from a resource file.

Index

• Constants
• func RemoveGeneratedFiles(directory string, method GeneratedFileDeleteMethod) error
• type FileWriter
  • func (f *FileWriter) GoFormatBytes(fileName string, data []byte) ([]byte, error)
  • func (f *FileWriter) WriteBytesToFile(file *os.File, data []byte) error
• type GeneratedFileDeleteMethod
• type Generator
  • func NewResourceGenerator(ctx context.Context, resourceSourcePath, migrationSourceURL string, ...) (Generator, error)
  • func NewTypescriptGenerator(ctx context.Context, resourceSourcePath, migrationSourceURL string, ...) (Generator, error)
• type HandlerType
  • func (h HandlerType) Method() string
• type InformationSchemaResult
• 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, businessPackageDir string) Option
  • func WithSpannerEmulatorVersion(version string) Option
• type OptionType
• type PatchType
• type ResourceOption
  • func GenerateHandlers(targetDir string) ResourceOption
  • func GenerateRoutes(targetDir, targetPackage, routePrefix string) ResourceOption
• type TSGenMode
• type TSOption
  • func WithTypescriptOverrides(overrides map[string]string) TSOption

Constants

const (
	// Adds permission.ts to generator output
	TSPerm tsGenMode = 1 << iota

	// Adds resource.ts to generator output
	TSMeta
)

Functions

func RemoveGeneratedFiles

func RemoveGeneratedFiles(directory string, method GeneratedFileDeleteMethod) error

Types

type FileWriter

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

func (*FileWriter) GoFormatBytes

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

func (*FileWriter) WriteBytesToFile

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

type GeneratedFileDeleteMethod

type GeneratedFileDeleteMethod int

const (
	// Used to remove files with the genPrefix value instead of reading the contents of the file.
	Prefix GeneratedFileDeleteMethod = iota
	// Used to remove files that contain the header comment "// Code generated by resourcegeneration. DO NOT EDIT."
	HeaderComment
)

type Generator

type Generator interface {
	Generate(ctx context.Context) error
	Close()
}

func NewResourceGenerator

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

func NewTypescriptGenerator

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

type HandlerType

type HandlerType string

const (
	AllHandlers  HandlerType = "allHandlers"
	ListHandler  HandlerType = "listHandler"
	ReadHandler  HandlerType = "readHandler"
	PatchHandler HandlerType = "patchHandler"
)

func (HandlerType) Method

func (h HandlerType) Method() string

type InformationSchemaResult

type InformationSchemaResult struct {
	TableName            string  `spanner:"TABLE_NAME"`
	ColumnName           string  `spanner:"COLUMN_NAME"`
	ConstraintName       *string `spanner:"CONSTRAINT_NAME"`
	IsPrimaryKey         bool    `spanner:"IS_PRIMARY_KEY"`
	IsForeignKey         bool    `spanner:"IS_FOREIGN_KEY"`
	ReferencedTable      *string `spanner:"REFERENCED_TABLE"`
	ReferencedColumn     *string `spanner:"REFERENCED_COLUMN"`
	SpannerType          string  `spanner:"SPANNER_TYPE"`
	IsNullable           bool    `spanner:"IS_NULLABLE"`
	IsView               bool    `spanner:"IS_VIEW"`
	ViewDefinition       *string `spanner:"VIEW_DEFINITION"`
	IsIndex              bool    `spanner:"IS_INDEX"`
	IsUniqueIndex        bool    `spanner:"IS_UNIQUE_INDEX"`
	GenerationExpression *string `spanner:"GENERATION_EXPRESSION"`
	OrdinalPosition      int64   `spanner:"ORDINAL_POSITION"`
	KeyOrdinalPosition   int64   `spanner:"KEY_ORDINAL_POSITION"`
	HasDefault           bool    `spanner:"HAS_DEFAULT"`
}

type Option

type Option func(any) error

func CaserInitialismOverrides

func CaserInitialismOverrides(overrides map[string]bool) Option

func WithConsolidatedHandlers

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

func WithPluralOverrides

func WithPluralOverrides(overrides map[string]string) Option

func WithRPC

func WithRPC(rpcPackageDir string, businessPackageDir string) Option

func WithSpannerEmulatorVersion

func WithSpannerEmulatorVersion(version string) Option

type OptionType

type OptionType string

type PatchType

type PatchType string

const (
	CreatePatch PatchType = "Create"
	UpdatePatch PatchType = "Update"
)

type ResourceOption

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

func GenerateHandlers

func GenerateHandlers(targetDir string) ResourceOption

ignoredHandlers maps the name of a resource and to handler types (list, read, patch) that you do not want generated for that resource

func GenerateRoutes

func GenerateRoutes(targetDir, targetPackage, routePrefix string) ResourceOption

type TSGenMode

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

type TSOption

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

func WithTypescriptOverrides

func WithTypescriptOverrides(overrides map[string]string) TSOption