rules

package
v0.1.102 Latest Latest
Warning

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

 Go to latest Published: Aug 20, 2026 License: Apache-2.0 Imports: 10 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	BilingualRuleName = "bilingual"
	RuSuffix          = ".ru.md"
	RuFallbackSuffix  = "_ru.md"
)
View Source 
const (
	CyrillicInEnglishRuleName = "cyrillic-in-english"
)
View Source 
const (
	MarkdownlintRuleName = "markdownlint"
)
View Source 
const (
	NoLangKeyRuleName = "no-lang-key"
)
View Source 
const (
	ReadmeRuleName = "readme"
)
View Source 
const (
	SizeRuleName = "size"
)

Variables

This section is empty.

Functions

This section is empty.

Types

type BilingualRule 

type BilingualRule struct {
	pkg.RuleMeta
	pkg.PathRule
	// contains filtered or unexported fields
}

func NewBilingualRule 

func NewBilingualRule() *BilingualRule

func (*BilingualRule) CheckBilingual 

func (r *BilingualRule) CheckBilingual(m pkg.Module, errorList *errors.LintRuleErrorsList)

type CyrillicInEnglishRule 

type CyrillicInEnglishRule struct {
	pkg.RuleMeta
	pkg.PathRule
}

func NewCyrillicInEnglishRule 

func NewCyrillicInEnglishRule() *CyrillicInEnglishRule

func (*CyrillicInEnglishRule) CheckFiles 

func (r *CyrillicInEnglishRule) CheckFiles(m pkg.Module, errorList *errors.LintRuleErrorsList)

type MarkdownRule added in v0.1.95 

type MarkdownRule struct {
	pkg.RuleMeta
	pkg.PathRule
}

func NewMarkdownRule added in v0.1.95 

func NewMarkdownRule() *MarkdownRule

func (*MarkdownRule) CheckFiles added in v0.1.95 

func (r *MarkdownRule) CheckFiles(m pkg.Module, errorList *errors.LintRuleErrorsList)

type NoLangKeyRule added in v0.1.73 

type NoLangKeyRule struct {
	pkg.RuleMeta
	pkg.PathRule
}

func NewNoLangKeyRule added in v0.1.73 

func NewNoLangKeyRule() *NoLangKeyRule

func (*NoLangKeyRule) CheckFiles added in v0.1.73 

func (r *NoLangKeyRule) CheckFiles(m pkg.Module, errorList *errors.LintRuleErrorsList)

type ReadmeRule 

type ReadmeRule struct {
	pkg.RuleMeta
	pkg.PathRule
}

func NewReadmeRule 

func NewReadmeRule() *ReadmeRule

func (*ReadmeRule) CheckReadme 

func (r *ReadmeRule) CheckReadme(m pkg.Module, errorList *errors.LintRuleErrorsList)

type SizeRule added in v0.1.100 

type SizeRule struct {
	pkg.RuleMeta
}

func NewSizeRule added in v0.1.100 

func NewSizeRule() *SizeRule

func (*SizeRule) CheckSize added in v0.1.100 

func (r *SizeRule) CheckSize(m pkg.Module, errorList *errors.LintRuleErrorsList)

CheckSize sums the size of the documentation files under the docs/ directory and reports an error when the total exceeds maxDocsSizeBytes. The docs/internal subtree is skipped on purpose: it holds content that is not rendered as documentation, so it must not count towards the limit. Every other subfolder is scanned recursively. Oversized docs bloat the module artifact and usually signal binary assets that don't belong there.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.