paragraphreadability

package

v0.23.0 Latest Latest Go to latest Published: May 21, 2026 License: MIT Imports: 8 Imported by: 0

Details

This section is empty.

This section is empty.

func ARI(text string) float64

ARI computes the Automated Readability Index. Formula: 4.71*(characters/words) + 0.5*(words/sentences) - 21.43 Characters = letters and digits only.

type IndexFunc func(text string) float64

IndexFunc computes a readability index from plain text. Higher values mean harder to read.

type Rule struct {
	MaxIndex     float64
	MinWords     int
	Index        IndexFunc
	Placeholders []string // placeholder tokens to treat as opaque
}

Rule checks that the paragraph readability index does not exceed a configured maximum. Uses the Automated Readability Index by default.

func (r *Rule) ApplySettings(s map[string]any) error

ApplySettings implements rule.Configurable.

func (r *Rule) Category() string

Category implements rule.Rule.

func (r *Rule) Check(f *lint.File) []lint.Diagnostic

Check implements rule.Rule.

func (r *Rule) DefaultSettings() map[string]any

DefaultSettings implements rule.Configurable.

func (r *Rule) ID() string

ID implements rule.Rule.

func (r *Rule) Name() string

Name implements rule.Rule.

func (r *Rule) SettingMergeMode(key string) rule.MergeMode

SettingMergeMode implements rule.ListMerger.