utilities

Documentation

Index

• func DirectoryContainsFile(directoryPath, fileName string) (bool, error)
• func ExecuteTemplate(fileName string, data interface{}) ([]byte, error)
• func GitLatestTag(modPath string) (string, error)
• func GitUserName(modPath string) (string, error)
• func MakeRecommendation(note string)
• func ReadTemplate(fileName string) (*template.Template, error)
• type ModuleInfo
  • func ReadModule(path string) (*ModuleInfo, error)
  • func (Ω *ModuleInfo) AbsPathFromImportPath(impPath string) string
  • func (Ω *ModuleInfo) Domain() string
  • func (Ω *ModuleInfo) FilePath() string
  • func (Ω *ModuleInfo) Name() string
  • func (Ω *ModuleInfo) Packages() ([]Pkg, error)
  • func (Ω *ModuleInfo) RemotePath() string
  • func (Ω *ModuleInfo) SubDomain() string
• type Pkg

Functions

func DirectoryContainsFile

func DirectoryContainsFile(directoryPath, fileName string) (bool, error)

func ExecuteTemplate

func ExecuteTemplate(fileName string, data interface{}) ([]byte, error)

func GitLatestTag

func GitLatestTag(modPath string) (string, error)

func GitUserName

func GitUserName(modPath string) (string, error)

func MakeRecommendation

func MakeRecommendation(note string)

MakeRecommendation propagates notes to the user about ways to improve the project for Open Source publishing.

func ReadTemplate

func ReadTemplate(fileName string) (*template.Template, error)

Types

type ModuleInfo

type ModuleInfo struct {
	PackagePathFilters []string
	// contains filtered or unexported fields
}

func ReadModule

func ReadModule(path string) (*ModuleInfo, error)

func (*ModuleInfo) AbsPathFromImportPath

func (Ω *ModuleInfo) AbsPathFromImportPath(impPath string) string

func (*ModuleInfo) Domain

func (Ω *ModuleInfo) Domain() string

func (*ModuleInfo) FilePath

func (Ω *ModuleInfo) FilePath() string

func (*ModuleInfo) Name

func (Ω *ModuleInfo) Name() string

func (*ModuleInfo) Packages

func (Ω *ModuleInfo) Packages() ([]Pkg, error)

Packages examines a module recursively for packages. If not run in a `go test` environment, it will ignore directories with `_test` suffix.

func (*ModuleInfo) RemotePath

func (Ω *ModuleInfo) RemotePath() string

func (*ModuleInfo) SubDomain

func (Ω *ModuleInfo) SubDomain() string

type Pkg

type Pkg struct {
	AstPkg     *ast.Package
	AbsPath    string
	ImportPath string
}