lint

Documentation

Index

• func IsUrl(str string) bool
• type LinkLint
• type LinkLintConfig
  • func New(configFile string) (*LinkLintConfig, error)
  • func NewFromContent(content []byte) (*LinkLintConfig, error)
  • func (llc *LinkLintConfig) Init(dir string) error
  • func (llc *LinkLintConfig) LintAll() bool
  • func (llc *LinkLintConfig) OnFail(message, link string)
  • func (llc *LinkLintConfig) OnPass(message, link string)
  • func (llc *LinkLintConfig) ReadFile(path string) error
  • func (llc *LinkLintConfig) ShowFailSummary()
  • func (llc *LinkLintConfig) ShowPassSummary()
  • func (llc *LinkLintConfig) ShowSummary()
• type Position

Functions

func IsUrl

func IsUrl(str string) bool

Types

type LinkLint

type LinkLint struct {
	Path     string
	Line     string
	Position Position
	Message  string
	Status   string
}

type LinkLintConfig

type LinkLintConfig struct {
	IncludeExts       []string              `yaml:"includeExts"`
	ExcludeLinks      []string              `yaml:"excludeLinks"`
	ExcludePaths      []string              `yaml:"excludePaths"`
	AcceptStatusCodes []int                 `yaml:"acceptStatusCodes"`
	LinkMap           map[string][]LinkLint // consists map as the key and file details as values
}

func New

func New(configFile string) (*LinkLintConfig, error)

func NewFromContent

func NewFromContent(content []byte) (*LinkLintConfig, error)

func (*LinkLintConfig) Init

func (llc *LinkLintConfig) Init(dir string) error

func (*LinkLintConfig) LintAll

func (llc *LinkLintConfig) LintAll() bool

func (*LinkLintConfig) OnFail

func (llc *LinkLintConfig) OnFail(message, link string)

func (*LinkLintConfig) OnPass

func (llc *LinkLintConfig) OnPass(message, link string)

func (*LinkLintConfig) ReadFile

func (llc *LinkLintConfig) ReadFile(path string) error

func (*LinkLintConfig) ShowFailSummary

func (llc *LinkLintConfig) ShowFailSummary()

func (*LinkLintConfig) ShowPassSummary

func (llc *LinkLintConfig) ShowPassSummary()

func (*LinkLintConfig) ShowSummary

func (llc *LinkLintConfig) ShowSummary()

type Position

type Position struct {
	Row, Col int
}