models

type Attribute struct {
	// Name of the attribute. e.g. "Foo" for "Foo string"
	Name string
	// See Type for more details.
	Type Type

	// List of the comments of the attribute.
	// Only upper comments are parsed. No inline comments.
	Comments []string

	// Tags of the attribute. e.g. `json:"foo,omitempty"`
	// The map key is the tag name, the map value is the tag value.
	// e.g. `json:"foo,omitempty"` => map[string]string{"json": "foo,omitempty"}
	Tags map[string]string
}

type Element struct {
	// See Type for more details.
	Type Type

	// List of the attributes of the struct. Empty if the parsed element is an interface.
	// See Attribute for more details.
	Attributes []Attribute

	// List of the methods of the struct or the interface.
	// See Method for more details.
	Methods []Method
}

type Method struct {
	// Name of the method. e.g. "Foo" for "Foo() string"s
	Name string
	// Maps of the parameters of the method. Empty if the method has no parameter.
	// The map key is the parameter name, the map value is the parameter type.
	// See Type for more details.
	Params map[string]Type
	// List of the return values of the method. Empty if the method has no return value.
	// See Type for more details.
	Returns []Type
	// IsPointerReceiver is true if the method is a pointer receiver.
	// Always false for interfaces.
	IsPointerReceiver bool
	// IsExported is true if the method is exported.
	IsExported bool

	// List of the comments of the method.
	// Only upper comments are parsed. No inline or in the method's body comments.
	Comments []string
}

type ParsedElement struct {
	// PackageName is the name of the package of the parsed element.
	// e.g. "package foo" => "foo"
	PackageName string
	// List of the imports of the package of the parsed element.
	// e.g. ["github.com/google/uuid", "time"]
	PackageImports []string

	// See Element for more details.
	// Note: this inlined, so you can access directly to the fields as if it was an
	// ParsedElement attribute. e.g. {{ .Type.Name }}
	Element
}

type Type struct {
	// Name of the type from outside its package
	// Example `uuid.UUID` or `time.Time`
	// Use this variable if you generate code outside the package of that type
	// Do not forget to add corresponding imports in your template
	Name string

	// Name of the type from inside its package
	// Example `UUID` or `Time`
	// Use this variable if you generate code inside the package of that type
	InternalName string
}