pkg

Documentation

Index

• func SetBasePath(path string, absolute bool)
• type Config
  • func NewConfig(commands cli.Commands) (*Config, error)
• type FailedLinks
• type File
  • func NewFile(filePath string, fileLinks Links, config *FileConfig) (*File, error)
  • func (f *File) ExtractHeaders() *File
  • func (f *File) ExtractLinks() *File
  • func (f *File) ExtractStats() *File
  • func (f *File) Run()
  • func (f *File) Summary() *File
  • func (f *File) ValidateLinks() *File
  • func (f *File) WriteStats() *File
• type FileConfig
  • func NewFileConfig(filePath string, config *Config) *FileConfig
• type FileStats
  • func NewFileStats(file *File) *FileStats
• type Files
  • func NewFiles(filePaths []string, config *Config) (Files, error)
  • func (f Files) Run(verbose bool)
  • func (f Files) Summary() bool
• type FilesStats
  • func NewFilesStats(files Files) FilesStats
• type Headers
• type Link
• type LinkConfig
  • func NewLinkConfig(link Link, file *File) *LinkConfig
• type LinkResult
• type LinkType
• type Links
  • func NewLinks(filePath string, config *Config) Links
  • func (l Links) AppendConfig(file *File) Links
  • func (l Links) CheckStatus() bool
  • func (l Links) Filter(condition func(link Link) bool) Links
  • func (l Links) RemoveWhiteLinks(externals, internals []string) Links
• type Parser
  • func (p *Parser) Anchors(body io.ReadCloser) (ids []string)
  • func (p *Parser) Headers(markdown string) []string
  • func (p *Parser) Links(markdown, dirPath string) Links
• type SuccessLinks
• type Validation
  • func (v *Validation) ExternalLinks(links Links) (Links, error)
  • func (v *Validation) HashInternalLinks(links Links, headers Headers) (Links, error)
  • func (v *Validation) InternalLink(links Links) (Links, error)
  • func (v *Validation) Links(links []Link, optionalHeaders ...Headers) []Link

Functions

func SetBasePath

func SetBasePath(path string, absolute bool)

Types

type Config

type Config struct {
	Files           []File   `yaml:"files"`
	WhiteListExt    []string `yaml:"white-list-external"`
	WhiteListInt    []string `yaml:"white-list-internal"`
	BlackList       []string `yaml:"black-list"`
	Timeout         int      `yaml:"timeout"`
	ReguestRepeats  int8     `yaml:"request-repeats"`
	AllowRedirect   bool     `yaml:"allow-redirect"`
	AllowCodeBlocks bool     `yaml:"allow-code-blocks"`
	IgnoreExternal  bool     `yaml:"ignore-external"`
	IgnoreInternal  bool     `yaml:"ignore-internal"`
}

func NewConfig

func NewConfig(commands cli.Commands) (*Config, error)

type FailedLinks

type FailedLinks struct {
	Count int
	Links []Link
}

type File

type File struct {
	RelPath string `yaml:"path"`
	AbsPath string
	DirPath string
	Content string
	Links   Links `yaml:"links"`
	Headers Headers
	Status  bool
	Config  *FileConfig `yaml:"config"`
	Stats   *FileStats
	// contains filtered or unexported fields
}

func NewFile

func NewFile(filePath string, fileLinks Links, config *FileConfig) (*File, error)

func (*File) ExtractHeaders

func (f *File) ExtractHeaders() *File

func (*File) ExtractLinks

func (f *File) ExtractLinks() *File

func (*File) ExtractStats

func (f *File) ExtractStats() *File

func (*File) Run

func (f *File) Run()

func (*File) Summary

func (f *File) Summary() *File

func (*File) ValidateLinks

func (f *File) ValidateLinks() *File

func (*File) WriteStats

func (f *File) WriteStats() *File

type FileConfig

type FileConfig struct {
	WhiteListExt    []string `yaml:"white-list-external"`
	WhiteListInt    []string `yaml:"white-list-internal"`
	Timeout         *int     `yaml:"timeout"`
	ReguestRepeats  *int8    `yaml:"request-repeats"`
	AllowRedirect   *bool    `yaml:"allow-redirect"`
	AllowCodeBlocks *bool    `yaml:"allow-code-blocks"`
	IgnoreExternal  *bool    `yaml:"ignore-external"`
	IgnoreInternal  *bool    `yaml:"ignore-internal"`
}

func NewFileConfig

func NewFileConfig(filePath string, config *Config) *FileConfig

type FileStats

type FileStats struct {
	SuccessLinks SuccessLinks
	FailedLinks  FailedLinks
}

func NewFileStats

func NewFileStats(file *File) *FileStats

type Files

type Files []*File

func NewFiles

func NewFiles(filePaths []string, config *Config) (Files, error)

func (Files) Run

func (f Files) Run(verbose bool)

func (Files) Summary

func (f Files) Summary() bool

type FilesStats

type FilesStats []*FileStats

func NewFilesStats

func NewFilesStats(files Files) FilesStats

type Headers

type Headers []string

type Link

type Link struct {
	RelPath string `yaml:"path"`
	AbsPath string
	Config  *LinkConfig `yaml:"config"`
	TypeOf  LinkType
	Result  LinkResult
}

type LinkConfig

type LinkConfig struct {
	Timeout        *int  `yaml:"timeout"`
	ReguestRepeats *int8 `yaml:"request-repeats"`
	AllowRedirect  *bool `yaml:"allow-redirect"`
}

func NewLinkConfig

func NewLinkConfig(link Link, file *File) *LinkConfig

type LinkResult

type LinkResult struct {
	Status  bool
	Message string
}

type LinkType

type LinkType string

const (
	ExternalLink     LinkType = "ExternalLink"
	InternalLink     LinkType = "InternalLink"
	HashInternalLink LinkType = "HashInternalLink"
)

type Links

type Links []Link

func NewLinks

func NewLinks(filePath string, config *Config) Links

func (Links) AppendConfig

func (l Links) AppendConfig(file *File) Links

func (Links) CheckStatus

func (l Links) CheckStatus() bool

func (Links) Filter

func (l Links) Filter(condition func(link Link) bool) Links

func (Links) RemoveWhiteLinks

func (l Links) RemoveWhiteLinks(externals, internals []string) Links

type Parser

type Parser struct{}

func (*Parser) Anchors

func (p *Parser) Anchors(body io.ReadCloser) (ids []string)

func (*Parser) Headers

func (p *Parser) Headers(markdown string) []string

func (*Parser) Links

func (p *Parser) Links(markdown, dirPath string) Links

type SuccessLinks

type SuccessLinks struct {
	Count int
	Links []Link
}

type Validation

type Validation struct {
}

func (*Validation) ExternalLinks

func (v *Validation) ExternalLinks(links Links) (Links, error)

func (*Validation) HashInternalLinks

func (v *Validation) HashInternalLinks(links Links, headers Headers) (Links, error)

func (*Validation) InternalLink

func (v *Validation) InternalLink(links Links) (Links, error)

func (*Validation) Links

func (v *Validation) Links(links []Link, optionalHeaders ...Headers) []Link