parser

README

github-codeowners

A Golang parser for Github's CODEOWNERS files

For more information about CODEOWNERS: https://help.github.com/articles/about-codeowners/

Related

• a similar project in Rust: https://github.com/softprops/codeowners

TODO

• Add a function that given a path, determines the owner(s) based on last matching pattern precedence

Documentation

Index

• type Mapping
  • func Parse(r io.Reader) ([]Mapping, error)
• type Owner
  • func (u Owner) IsEmailAddress() bool
  • func (u Owner) IsGithubOwner() bool
  • func (u Owner) IsGithubTeam() bool
  • func (u Owner) IsValid() bool

Types

type Mapping

type Mapping struct {
	Path   string
	Owners []Owner
}

Mapping is a Path to []Owner pair

func Parse

func Parse(r io.Reader) ([]Mapping, error)

type Owner

type Owner string

func (Owner) IsEmailAddress

func (u Owner) IsEmailAddress() bool

func (Owner) IsGithubOwner

func (u Owner) IsGithubOwner() bool

func (Owner) IsGithubTeam

func (u Owner) IsGithubTeam() bool

func (Owner) IsValid

func (u Owner) IsValid() bool