github

Documentation

Index

• Constants
• type FetchRepositoryParam
  • func (p FetchRepositoryParam) QueryWord() string
  • func (p FetchRepositoryParam) RepoOwner() string
• type GitHubRepository
  • func FetchFromGitHub(params []FetchRepositoryParam) []GitHubRepository
  • func ParseGitHubURL(url string) (GitHubRepository, error)
  • func (r GitHubRepository) IsActive(year int) bool
  • func (r GitHubRepository) RepoOwner() string
• type GitHubURL
  • func (g GitHubURL) Parse() (string, string, error)

Constants

const FORK_QUERY = "fork:true"

To find forked repositories by search https://docs.github.com/en/search-github/searching-on-github/searching-in-forks

const QUERY_SEPARATOR = " "

const SEARCH_REPOS_PER_ONCE = 20

const TOKEN_NAME = "GITHUB_TOKEN"

Types

type FetchRepositoryParam

type FetchRepositoryParam struct {
	PackageName string
	Repo        string
	Owner       string
	Searchable  bool
	Error       error
}

func (FetchRepositoryParam) QueryWord

func (p FetchRepositoryParam) QueryWord() string

func (FetchRepositoryParam) RepoOwner

func (p FetchRepositoryParam) RepoOwner() string

type GitHubRepository

type GitHubRepository struct {
	Name            string
	Owner           string
	Repo            string
	URL             string
	Archived        bool
	LastCommittedAt time.Time
	Error           error
}

func FetchFromGitHub

func FetchFromGitHub(params []FetchRepositoryParam) []GitHubRepository

func ParseGitHubURL

func ParseGitHubURL(url string) (GitHubRepository, error)

func (GitHubRepository) IsActive

func (r GitHubRepository) IsActive(year int) bool

func (GitHubRepository) RepoOwner

func (r GitHubRepository) RepoOwner() string

type GitHubURL

type GitHubURL struct {
	URL string
}

func (GitHubURL) Parse

func (g GitHubURL) Parse() (string, string, error)