codegen

Documentation

Overview

Package codegen generates code for use with Encore apps.

Index

• Constants
• Variables
• func Client(lang Lang, appSlug string, md *meta.Data) (code []byte, err error)
• type ErrCode
• type IdentFormat
• type Lang
  • func Detect(path string) (lang Lang, ok bool)

Constants

const (
	// GoInitial is the originally released Go client generator
	GoInitial goGenVersion = iota

	// GoExperimental can be used to lock experimental or uncompleted features in the generated code
	// It should always be the last item in the enum
	GoExperimental
)

const (
	// TsInitial is the originally released typescript generator
	TsInitial tsGenVersion = iota

	// TsExperimental can be used to lock experimental or uncompleted features in the generated code
	// It should always be the last item in the enum
	TsExperimental
)

Variables

var ErrUnknownLang = errors.New("unknown language")

ErrUnknownLang is reported by Generate when the language is not known.

Functions

func Client

func Client(lang Lang, appSlug string, md *meta.Data) (code []byte, err error)

Client generates an API client based on the given app metadata.

Types

type ErrCode

type ErrCode struct {
	Name           string
	Comment        string
	HttpStatusCode int
}

type IdentFormat

type IdentFormat int

const (
	CamelCase          IdentFormat = iota // camelCase
	PascalCase                            // PascalCase
	SnakeCase                             // snake_case
	ScreamingSnakeCase                    // SCREAMING_SNAKE_CASE
	KebabCase                             // kebab-case
)

type Lang

type Lang string

Lang represents a programming language or dialect that we support generating code for.

const (
	LangUnknown    Lang = ""
	LangTypeScript Lang = "typescript"
	LangGo         Lang = "go"
)

These constants represent supported languages.

func Detect

func Detect(path string) (lang Lang, ok bool)

Detect attempts to detect the language from the given filename.