Documentation
¶
Index ¶
- type LinksConfig
- type Rule
- func (r *Rule) ApplySettings(settings map[string]any) error
- func (r *Rule) Category() string
- func (r *Rule) Check(f *lint.File) []lint.Diagnostic
- func (r *Rule) DefaultSettings() map[string]any
- func (r *Rule) ID() string
- func (r *Rule) Name() string
- func (r *Rule) SettingMergeMode(key string) rule.MergeMode
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type LinksConfig ¶ added in v0.21.0
type LinksConfig struct {
SiteRoot string // resolved against site root for absolute paths
ValidateImages bool // check *ast.Image targets (default on)
ValidateReferenceStyle bool // check reference-style link targets (default on)
}
LinksConfig holds the per-file link-validation knobs exposed via the links: sub-block. Mirrors the shared links: config block described in docs/research/links/README.md.
type Rule ¶
type Rule struct {
Include []string
Exclude []string
Strict bool
Placeholders []string // placeholder tokens to treat as opaque
Links LinksConfig
}
Rule checks Markdown links for missing target files and missing heading anchors in linked Markdown files.
func (*Rule) ApplySettings ¶
ApplySettings implements rule.Configurable.
func (*Rule) Check ¶
func (r *Rule) Check(f *lint.File) []lint.Diagnostic
Check implements rule.Rule.
func (*Rule) DefaultSettings ¶
DefaultSettings implements rule.Configurable.
Source Files
Click to show internal directories.
Click to hide internal directories.