stale

package
v0.5.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 7, 2026 License: MIT Imports: 11 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func FormatLines

func FormatLines(findings []Finding) []string

FormatLines prints human findings plus a summary line.

Types

type Finding

type Finding struct {
	File    string `json:"file"`
	Section string `json:"section"`
	Reason  string `json:"reason"`
	Kind    string `json:"kind"`
}

Finding is one suspect claim in a documentation section.

func Check

func Check(docs []*parser.Document, opt Options) []Finding

Check walks every section in docs and returns sorted findings.

type Options

type Options struct {
	Root         string
	Days         int // status-heading dates older than this are stale; default 90
	CheckFlags   bool
	Remote       bool
	AllowDomains []string
	Timeout      time.Duration
	Now          time.Time

	LookPath func(file string) (string, error)
	HTTPHead func(url string) (status int, err error)
}

Options controls local and optional remote stale checks.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL