gen

README

About

The plugin's implementation.

Having internal in its path prevents imports from outside the project.

Code may move into a public package at the root of the repository if there is a use case.

Documentation

Index

• func Comment(format string, args ...interface{}) protogen.Comments
• func GenerateFile(fs flag.FlagSet, plugin *protogen.Plugin, proto *protogen.File, ...) error
• type Collection
  • func (left *Collection) Merge(right *Collection) *Collection
  • func (left *Collection) NestedDocumentTypeName(prefix string) string
  • func (left *Collection) ParentDocumentTypeName(prefix string) string
  • func (left *Collection) TypeName(prefix string) string
  • func (left *Collection) TypeNameIter(prefix string) string
  • func (left *Collection) TypeNameQuery(prefix string) string
• type Document
  • func (left *Document) Merge(right *Document) *Document
  • func (left *Document) TypeName(prefix string) string
• type Field
  • func NewField(msg *Message, proto *protogen.Field) (*Field, error)
  • func (f *Field) Annotate(symbol string, loc protogen.Location)
  • func (f *Field) FirestoreFieldName() string
  • func (f *Field) Gen()
  • func (f *Field) Name() string
  • func (f *Field) P(v ...interface{})
• type FieldType
  • func NewFieldType(field *Field) (*FieldType, error)
  • func (t *FieldType) String() string
• type File
  • func NewFile(plugin *protogen.Plugin, proto *protogen.File) (*File, error)
  • func (f *File) Annotate(symbol string, loc protogen.Location)
  • func (f *File) Enabled() bool
  • func (f *File) Gen()
  • func (f *File) P(v ...interface{})
• type Message
  • func NewMessage(file *File, proto *protogen.Message) (*Message, error)
  • func (m *Message) Annotate(symbol string, loc protogen.Location)
  • func (m *Message) CollectionConstantName() string
  • func (m *Message) CollectionName() string
  • func (m *Message) CollectionNameTitle() string
  • func (m *Message) CustomObjectName() string
  • func (m *Message) Gen()
  • func (m *Message) P(v ...interface{})
  • func (m *Message) ProtoName() string
• type Package
  • func (p *Package) CollectPath(add *Path)
  • func (p *Package) Gen()
  • func (p *Package) P(v ...interface{})
• type Packages
  • func NewPackages(plugin *protogen.Plugin) *Packages
  • func (p *Packages) Collect(file *File)
  • func (p *Packages) Gen() error
• type Path

Functions

func Comment

func Comment(format string, args ...interface{}) protogen.Comments

func GenerateFile

func GenerateFile(
	fs flag.FlagSet,
	plugin *protogen.Plugin,
	proto *protogen.File,
	packages *Packages,
) error

Types

type Collection

type Collection struct {
	Segment  string
	Title    string
	Document *Document
	Parent   *Document
	Message  *Message
}

func (*Collection) Merge

func (left *Collection) Merge(right *Collection) *Collection

func (*Collection) NestedDocumentTypeName

func (left *Collection) NestedDocumentTypeName(prefix string) string

func (*Collection) ParentDocumentTypeName

func (left *Collection) ParentDocumentTypeName(prefix string) string

func (*Collection) TypeName

func (left *Collection) TypeName(prefix string) string

func (*Collection) TypeNameIter

func (left *Collection) TypeNameIter(prefix string) string

func (*Collection) TypeNameQuery

func (left *Collection) TypeNameQuery(prefix string) string

type Document

type Document struct {
	Collections *orderedmap.OrderedMap[string, *Collection]
	Parent      *Collection
}

func (*Document) Merge

func (left *Document) Merge(right *Document) *Document

func (*Document) TypeName

func (left *Document) TypeName(prefix string) string

type Field

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

func NewField

func NewField(msg *Message, proto *protogen.Field) (*Field, error)

func (*Field) Annotate

func (f *Field) Annotate(symbol string, loc protogen.Location)

func (*Field) FirestoreFieldName

func (f *Field) FirestoreFieldName() string

func (*Field) Gen

func (f *Field) Gen()

func (*Field) Name

func (f *Field) Name() string

func (*Field) P

func (f *Field) P(v ...interface{})

type FieldType

type FieldType struct {
	Go        protogen.GoIdent
	Firestore protogen.GoIdent

	IsPointer  bool // TODO: unused?
	IsEnum     bool
	IsCustom   bool
	IsExternal bool
	IsList     bool
	// contains filtered or unexported fields
}

func NewFieldType

func NewFieldType(field *Field) (*FieldType, error)

func (*FieldType) String

func (t *FieldType) String() string

type File

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

File wraps the input .proto file and keeps information to generate code.

func NewFile

func NewFile(plugin *protogen.Plugin, proto *protogen.File) (*File, error)

func (*File) Annotate

func (f *File) Annotate(symbol string, loc protogen.Location)

func (*File) Enabled

func (f *File) Enabled() bool

func (*File) Gen

func (f *File) Gen()

func (*File) P

func (f *File) P(v ...interface{})

type Message

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

func NewMessage

func NewMessage(file *File, proto *protogen.Message) (*Message, error)

func (*Message) Annotate

func (m *Message) Annotate(symbol string, loc protogen.Location)

func (*Message) CollectionConstantName

func (m *Message) CollectionConstantName() string

func (*Message) CollectionName

func (m *Message) CollectionName() string

func (*Message) CollectionNameTitle

func (m *Message) CollectionNameTitle() string

func (*Message) CustomObjectName

func (m *Message) CustomObjectName() string

func (*Message) Gen

func (m *Message) Gen()

Gen generates GORM models and supporting APIs.

func (*Message) P

func (m *Message) P(v ...interface{})

func (*Message) ProtoName

func (m *Message) ProtoName() string

type Package

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

func (*Package) CollectPath

func (p *Package) CollectPath(add *Path)

func (*Package) Gen

func (p *Package) Gen()

func (*Package) P

func (p *Package) P(v ...interface{})

type Packages

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

func NewPackages

func NewPackages(plugin *protogen.Plugin) *Packages

func (*Packages) Collect

func (p *Packages) Collect(file *File)

func (*Packages) Gen

func (p *Packages) Gen() error

type Path

type Path struct {
	Collection *Collection
}