linktransformer

Documentation

Index

• Variables
• func MustNewValidator(logger log.Logger, linksValidateConfig []byte, anchorDir string) mdformatter.LinkTransformer
• func NewChain(c ...mdformatter.LinkTransformer) mdformatter.LinkTransformer
• func NewLocalizer(logger log.Logger, address *regexp.Regexp, anchorDir string) mdformatter.LinkTransformer
• func NewValidator(ctx context.Context, logger log.Logger, linksValidateConfig []byte, ...) (mdformatter.LinkTransformer, error)
• type Config
  • func ParseConfig(c []byte) (Config, error)
  • func (v Config) GetValidatorForURL(URL string) Validator
• type GitHubPullsIssuesValidator
  • func (v GitHubPullsIssuesValidator) IsValid(k futureKey, r *validator) (bool, error)
• type GitHubResponse
• type IgnoreValidator
  • func (v IgnoreValidator) IsValid(k futureKey, r *validator) (bool, error)
• type LookupError
• type RoundTripValidator
  • func (v RoundTripValidator) IsValid(k futureKey, r *validator) (bool, error)
• type Validator
• type ValidatorConfig
• type ValidatorType

Variables

var (
	FileNotFoundErr = LookupError(errors.New("file not found"))
	IDNotFoundErr   = LookupError(errors.New("file exists, but does not have such id"))
)

Functions

func MustNewValidator

func MustNewValidator(logger log.Logger, linksValidateConfig []byte, anchorDir string) mdformatter.LinkTransformer

MustNewValidator returns mdformatter.LinkTransformer that crawls all links.

func NewChain

func NewChain(c ...mdformatter.LinkTransformer) mdformatter.LinkTransformer

func NewLocalizer

func NewLocalizer(logger log.Logger, address *regexp.Regexp, anchorDir string) mdformatter.LinkTransformer

NewLocalizer returns mdformatter.LinkTransformer that transforms links that matches address via given regexp to local markdown file path (if exists).

func NewValidator

func NewValidator(ctx context.Context, logger log.Logger, linksValidateConfig []byte, anchorDir string, reg *prometheus.Registry) (mdformatter.LinkTransformer, error)

NewValidator returns mdformatter.LinkTransformer that crawls all links. TODO(bwplotka): Add optimization and debug modes - this is the main source of latency and pain.

Types

type Config

type Config struct {
	Version int

	Validators []ValidatorConfig `yaml:"validators"`
	Timeout    string            `yaml:"timeout"`
	// contains filtered or unexported fields
}

func ParseConfig

func ParseConfig(c []byte) (Config, error)

func (Config) GetValidatorForURL

func (v Config) GetValidatorForURL(URL string) Validator

GetValidatorForURL returns correct Validator by matching URL.

type GitHubPullsIssuesValidator

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

func (GitHubPullsIssuesValidator) IsValid

func (v GitHubPullsIssuesValidator) IsValid(k futureKey, r *validator) (bool, error)

GitHubPullsIssuesValidator.IsValid skips visiting all github issue/PR links.

type GitHubResponse

type GitHubResponse struct {
	Number int `json:"number"`
}

type IgnoreValidator

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

func (IgnoreValidator) IsValid

func (v IgnoreValidator) IsValid(k futureKey, r *validator) (bool, error)

IgnoreValidator.IsValid returns true if matched so that link in not checked.

type LookupError

type LookupError error

type RoundTripValidator

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

func (RoundTripValidator) IsValid

func (v RoundTripValidator) IsValid(k futureKey, r *validator) (bool, error)

RoundTripValidator.IsValid returns true if url is checked by colly.

type Validator

type Validator interface {
	IsValid(k futureKey, r *validator) (bool, error)
}

type ValidatorConfig

type ValidatorConfig struct {
	// Regex for type of validator. For `githubPullsIssues` this is: (^http[s]?:\/\/)(www\.)?(github\.com\/){ORG_NAME}\/{REPO_NAME}(\/pull\/|\/issues\/).
	Regex string `yaml:"regex"`
	// By default type is `roundtrip`. Could be `githubPullsIssues` or `ignore`.
	Type ValidatorType `yaml:"type"`
	// GitHub repo token to avoid getting rate limited.
	Token string `yaml:"token"`
	// contains filtered or unexported fields
}

type ValidatorType

type ValidatorType string