authors

Documentation

Index

• Constants
• Variables
• func EnsureCoauthorsFileExists(path string) error
• func WriteCoauthorsContent(cc CoAuthorsFileContent) error
• func WriteCoauthorsContentToFilePath(path string, cc CoAuthorsFileContent) error
• type Author
  • func MustParseOne(s string) Author
  • func ParseOne(s string) (Author, error)
  • func (a Author) CoauthorTag() string
  • func (a Author) CoauthorTagBytes() []byte
  • func (a Author) InitialsFromName() string
  • func (a Author) String() string
• type AuthorList
  • func (m AuthorList) SortBy(less func(left, right *Author) bool)
  • func (m AuthorList) String() string
  • func (m AuthorList) WriteToTable(table *tablewriter.Table)
• type AuthorWithInitials
• type CoAuthorsFileContent
  • func ReadCoAuthorsContent() (CoAuthorsFileContent, error)
  • func ReadCoAuthorsContentFromBytes(b []byte) (CoAuthorsFileContent, error)
  • func ReadCoAuthorsContentFromFilePath(filePath string) (CoAuthorsFileContent, error)
  • func (f CoAuthorsFileContent) FindAndFormatAsList(initials ...string) []string
  • func (f CoAuthorsFileContent) FindInitialsFromCoAuthorStrings(ss ...string) []string
  • func (f CoAuthorsFileContent) LookupByInitials(initials ...string) []Author

Constants

const (
	EnvKeyCoauthorsPath = "GITMOB_COAUTHORS_PATH"
)

Variables

var (
	CoAuthorsFilePath string
)

Functions

func EnsureCoauthorsFileExists

func EnsureCoauthorsFileExists(path string) error

func WriteCoauthorsContent

func WriteCoauthorsContent(cc CoAuthorsFileContent) error

func WriteCoauthorsContentToFilePath

func WriteCoauthorsContentToFilePath(path string, cc CoAuthorsFileContent) error

Types

type Author

type Author struct {
	Name  string `json:"name"`
	Email string `json:"email"`
}

func MustParseOne

func MustParseOne(s string) Author

MustParseOne parses an author string into an Author and panics if parsing fails

func ParseOne

func ParseOne(s string) (Author, error)

ParseOne parses an author string into an Author

func (Author) CoauthorTag

func (a Author) CoauthorTag() string

func (Author) CoauthorTagBytes

func (a Author) CoauthorTagBytes() []byte

func (Author) InitialsFromName

func (a Author) InitialsFromName() string

func (Author) String

func (a Author) String() string

type AuthorList

type AuthorList struct {
	Members []*Author `json:"members"`
}

AuthorList is a helper type to support string format when printing a list of authors

func (AuthorList) SortBy

func (m AuthorList) SortBy(less func(left, right *Author) bool)

func (AuthorList) String

func (m AuthorList) String() string

String implements Stringer to format our list output as a string

func (AuthorList) WriteToTable

func (m AuthorList) WriteToTable(table *tablewriter.Table)

type AuthorWithInitials

type AuthorWithInitials struct {
	Initials string `json:"initials"`
	Name     string `json:"name"`
	Email    string `json:"email"`
}

type CoAuthorsFileContent

type CoAuthorsFileContent struct {
	CoAuthorsByInitial map[string]Author `json:"coauthors"`
}

func ReadCoAuthorsContent

func ReadCoAuthorsContent() (CoAuthorsFileContent, error)

func ReadCoAuthorsContentFromBytes

func ReadCoAuthorsContentFromBytes(b []byte) (CoAuthorsFileContent, error)

func ReadCoAuthorsContentFromFilePath

func ReadCoAuthorsContentFromFilePath(filePath string) (CoAuthorsFileContent, error)

func (CoAuthorsFileContent) FindAndFormatAsList

func (f CoAuthorsFileContent) FindAndFormatAsList(initials ...string) []string

func (CoAuthorsFileContent) FindInitialsFromCoAuthorStrings

func (f CoAuthorsFileContent) FindInitialsFromCoAuthorStrings(ss ...string) []string

func (CoAuthorsFileContent) LookupByInitials

func (f CoAuthorsFileContent) LookupByInitials(initials ...string) []Author