docs

package

v0.30.20 Latest Latest Go to latest Published: Jun 4, 2026 License: Apache-2.0 Imports: 6 Imported by: 0

Details

View Source

const LinterID = "docs"

LinterID is the stable identifier used to reference this linter in configuration and diagnostics.

This section is empty.

This section is empty.

type Config struct {
	Path     string
	Settings LinterSettings
}

Config holds the path and settings required to construct a Linter.

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

Linter runs documentation rules against a package directory.

func NewLinter(cfg Config, res *diag.Collector) *Linter

NewLinter constructs a Linter from cfg, scoping its diagnostics to this linter and capping severity at the configured level.

func (l *Linter) Lint(ctx context.Context)

Lint executes all documentation rules against the configured package path.

type LinterSettings struct {
	lint.LinterSettings
	RulesSettings
}

LinterSettings combines the shared linter-level severity with the per-rule settings for this linter.

type RulesSettings struct {
	Readme            lint.RuleSettings
	Bilingual         lint.RuleSettings
	CyrillicInEnglish lint.RuleSettings
}

RulesSettings holds the severity configuration for each rule in the docs linter.

Path	Synopsis
rules