parsing

type PRParser struct {
	// Ctx is the server context
	Ctx context.Context

	// Gh is a GitHub API client
	GH *github.Client

	// RepoOwner is the owner of the PR's GitHub repository
	RepoOwner string

	// RepoName is the name of the PR's GitHub repository
	RepoName string

	// RepoRef is the Git reference to parse data at
	RepoRef string

	// PRNumber is the pull request's unique user facing number
	PRNumber int
}

type ParseError struct {
	// What indicates the object that failed to be parsed.
	// This field does not have to provide context about what is being parsed. Just
	// what part of the parsing process failed.
	What string

	// Why indicates why the object failed to be parsed
	Why string

	// FixInstructions for the user to remedy this error
	// Leave this field blank if there is nothing the user can do to fix the issue,
	// ex., internal server error
	FixInstructions string

	// InternalError is a non user presentable error which will be logged for
	// debug purposes. Can be nil if error is entirely caused by user's input.
	// If not nil will be treated as if the server messed up in some way and
	// the dev team will be notified.
	InternalError error
}

type RepoParser struct {
	// Ctx is the server's context
	Ctx context.Context

	// GH is a GitHub API client
	GH *github.Client

	// GHDevTeamName is the name of the GitHub team to ping when an internal error occurs
	GHDevTeamName string

	// SiteURL is the URL at which the website can be accessed
	SiteURL url.URL

	// RepoOwner is the owner of the repository
	RepoOwner string

	// RepoName is the name of the repository
	RepoName string

	// RepoRef is the Git reference to parse data at
	RepoRef string
}