rules

package

v0.2.0 Latest Latest Go to latest Published: Feb 21, 2026 License: MIT Imports: 6 Imported by: 0

Details

This section is empty.

This section is empty.

func LookupRule(query string) (string, error)

LookupRule finds a rule by ID (e.g. "MDS001") or name (e.g. "line-length") and returns its full README content.

type RuleInfo struct {
	ID          string
	Name        string
	Status      string
	Description string
	Content     string
}

RuleInfo holds metadata extracted from a rule README's front matter.

func ListRules() ([]RuleInfo, error)

ListRules returns all embedded rules sorted by ID.

Path	Synopsis
blanklinearoundfencedcode
blanklinearoundheadings
blanklinearoundlists
catalog
concisenessscoring
crossfilereferenceintegrity
emptysectionbody
fencedcodelanguage
fencedcodestyle
firstlineheading
headingincrement
headingstyle
include
linelength
listindent
maxfilelength
nobareurls
noduplicateheadings
noemphasisasheading
nohardtabs
nomultipleblanks
notrailingpunctuation
notrailingspaces
paragraphreadability
paragraphstructure
requiredstructure
singletrailingnewline
tableformat
tablereadability
tokenbudget