typeAst

README

TypeAst can

• build a typeAst by reading a spec dir
• save to spec dir
• give you a type ast for more actions...

Documentation

Index

• Variables
• func IsScalar(typename string) bool
• type TypeAst
  • func (a *TypeAst) GetProtoTarget() (proto string)
  • func (a *TypeAst) Save(specDir string)
  • func (a *TypeAst) ToJson() (d []byte, err error)
  • func (a *TypeAst) ToJsonFlat() (d []byte, err error)
  • func (a *TypeAst) ToYaml() (d []byte, err error)
• type Typelist
  • func (l *Typelist) DeleteType(typename string)
  • func (l *Typelist) LoadInstalledTypeSpecsFromDir(specDir ...string)
  • func (l *Typelist) LoadTypeSpecsFromDir(specDir string)
  • func (l Typelist) ResolveFullQualifiedTypeName(typename string, pkg string) string
  • func (l *Typelist) ResolveProtoImportForType(typeName string, pkg string) (imp string, typeFound bool)
  • func (l *Typelist) SaveAllTypeSpecsToDir(specDir string)
  • func (l *Typelist) UpdateImports()

Variables

var Format = "json"

Functions

func IsScalar

func IsScalar(typename string) bool

Check for skalar types https://developers.google.com/protocol-buffers/docs/proto3#scalar

Types

type TypeAst

type TypeAst struct {
	SpecDir  string // the base path, like specDir or dependencies/x.y.com/specDir
	Path     string // relative path of spec file to SpecDir
	FileName string
	TypeSpec specSpec.Type
}

func (*TypeAst) GetProtoTarget

func (a *TypeAst) GetProtoTarget() (proto string)

func (*TypeAst) Save

func (a *TypeAst) Save(specDir string)

Stores the spec to disc

func (*TypeAst) ToJson

func (a *TypeAst) ToJson() (d []byte, err error)

func (*TypeAst) ToJsonFlat

func (a *TypeAst) ToJsonFlat() (d []byte, err error)

returns unindented json

func (*TypeAst) ToYaml

func (a *TypeAst) ToYaml() (d []byte, err error)

type Typelist

type Typelist struct {
	TypesByName          map[string]*TypeAst
	InstalledTypesByName map[string]*TypeAst
	AllAvailabeTypes     map[string]*TypeAst // installed and project types together
	SpecDir              string
}

func (*Typelist) DeleteType

func (l *Typelist) DeleteType(typename string)

Deletes the spec from disk and removes the element from List

func (*Typelist) LoadInstalledTypeSpecsFromDir

func (l *Typelist) LoadInstalledTypeSpecsFromDir(specDir ...string)

loads a spec directory and installed specs to the typelist

func (*Typelist) LoadTypeSpecsFromDir

func (l *Typelist) LoadTypeSpecsFromDir(specDir string)

loads a spec directory and installed specs to the typelist

func (Typelist) ResolveFullQualifiedTypeName

func (l Typelist) ResolveFullQualifiedTypeName(typename string, pkg string) string

full name from c++ style name

func (*Typelist) ResolveProtoImportForType

func (l *Typelist) ResolveProtoImportForType(typeName string, pkg string) (imp string, typeFound bool)

func (*Typelist) SaveAllTypeSpecsToDir

func (l *Typelist) SaveAllTypeSpecsToDir(specDir string)

stores the typelist to the spec directory

func (*Typelist) UpdateImports

func (l *Typelist) UpdateImports()

updates the imports on each type