packages

Documentation

Index

• Constants
• type Cache
  • func NewCache(init ...*packages.Package) *Cache
  • func (pc *Cache) GetPackage(absolutePath string) (*packages.Package, error)
  • func (pc *Cache) GetType(packagePath, name string) (*types.Named, error)
  • func (pc *Cache) GetTypeWithFullPath(fullPath string) (*types.Named, error)
• type CommentCache
  • func NewCommentCache(cache *Cache) *CommentCache
  • func (cc *CommentCache) GetPackageComments(pkgPath string) (Comments, error)
• type CommentMarkers
  • func NewCommentMarkers(c string) CommentMarkers
  • func NewCommentMarkersFromText(c string, prefix string) CommentMarkers
  • func (ct CommentMarkers) Print(prefix string) string
• type Comments
  • func LoadComments(p *packages.Package) Comments
  • func (c Comments) CommentOf(o types.Object) string
• type Imports
  • func NewImports(pkgPath, pkgName string) *Imports
  • func (m *Imports) UsePackage(pkgPath string) string
  • func (m *Imports) UseType(in string) string

Constants

const (
	CommentPrefix = "+typewriter"
)

const (
	LoadMode = packages.NeedName | packages.NeedFiles | packages.NeedImports | packages.NeedDeps | packages.NeedTypes | packages.NeedSyntax
)

Types

type Cache

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

func NewCache

func NewCache(init ...*packages.Package) *Cache

func (*Cache) GetPackage

func (pc *Cache) GetPackage(absolutePath string) (*packages.Package, error)

GetPackage accepts absolute local path or Go module path and returns a single package. It caches by Go module path in both cases.

func (*Cache) GetType

func (pc *Cache) GetType(packagePath, name string) (*types.Named, error)

GetType returns the type information of the type in given path. The expected format is "<package path>.<type name>".

func (*Cache) GetTypeWithFullPath

func (pc *Cache) GetTypeWithFullPath(fullPath string) (*types.Named, error)

GetTypeWithFullPath returns the type information of the type in given path. The expected format is "<package path>.<type name>".

type CommentCache

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

CommentCache serves as the cache for accessing comments in packages. Indexed by package path.

func NewCommentCache

func NewCommentCache(cache *Cache) *CommentCache

func (*CommentCache) GetPackageComments

func (cc *CommentCache) GetPackageComments(pkgPath string) (Comments, error)

type CommentMarkers

type CommentMarkers struct {
	// SectionContents holds the equality pairs and indexed by the string until
	// the last ":".
	// For example, the following two lines:
	// +typewriter:types:key1=val1
	// +typewriter:types:key2=val2
	// would be indexed as following:
	// {
	//    "types": {"key1":"val1", "key2":"val2"}
	// }
	SectionContents map[string]map[string]string

	// Comment is the original comment string.
	Comment string
}

func NewCommentMarkers

func NewCommentMarkers(c string) CommentMarkers

func NewCommentMarkersFromText

func NewCommentMarkersFromText(c string, prefix string) CommentMarkers

func (CommentMarkers) Print

func (ct CommentMarkers) Print(prefix string) string

type Comments

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

Comments lets you fetch comment of an object.

func LoadComments

func LoadComments(p *packages.Package) Comments

func (Comments) CommentOf

func (c Comments) CommentOf(o types.Object) string

type Imports

type Imports struct {
	PackagePath string
	PackageName string
	Imports     map[string]string
}

func NewImports

func NewImports(pkgPath, pkgName string) *Imports

func (*Imports) UsePackage

func (m *Imports) UsePackage(pkgPath string) string

UsePackage adds the package to the import map and returns the alias you can use in that Go file. The returned package name will have "." as suffix if it is from a different package than the current one.

func (*Imports) UseType

func (m *Imports) UseType(in string) string

UseType adds the package of given type to the import map and returns the alias you can use in that Go file.