authors

Documentation

Index

• Constants
• Variables
• func EnsureCoauthorsFileExists(path string) 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 AuthorWithInitials
• type CoAuthorsFileContent
  • func ReadCoAuthorsContent() (CoAuthorsFileContent, error)
  • func ReadCoAuthorsContentFromBytes(b []byte) (CoAuthorsFileContent, error)
  • func ReadCoAuthorsContentFromFile(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

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 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 ReadCoAuthorsContentFromFile

func ReadCoAuthorsContentFromFile(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