profile

Documentation

Index

• Variables
• type Profile
• type Storage
  • func NewStorage(fs billy.Filesystem) *Storage
  • func (s *Storage) Read() (map[string]Profile, error)
  • func (s *Storage) Save(profiles map[string]Profile) error

Variables

var ErrUnexpectedProfileKey = errors.New("unexpected key found in profile config")

ErrUnexpectedProfileKey is returned when an unexpected key is found in the profiles file

Types

type Profile

type Profile struct {
	// Name is the personal name committer.
	Name string
	// Email is the email of the commiter.
	Email string
}

Profile stores the details of the committer.

type Storage

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

Storage writes and reads Profiles to the given filesystem

func NewStorage

func NewStorage(fs billy.Filesystem) *Storage

NewStorage returns an instance of Storage configured to use the given filesystem

func (*Storage) Read

func (s *Storage) Read() (map[string]Profile, error)

Read the saved profiles from the filesystem

func (*Storage) Save

func (s *Storage) Save(profiles map[string]Profile) error

Save the given profiles to the filesystem