Function NewReadability

internal/check/readability.go:23–41

NewReadability creates a new `readability`-based rule.

(_ *core.Config, generic baseCheck, path string)

// NewReadability creates a new `readability`-based rule.
func NewReadability(_ *core.Config, generic baseCheck, path string) (Readability, error) {
	rule := Readability{}

	err := decodeRule(generic, &rule)
	if err != nil {
		return rule, readStructureError(err, path)
	}

	if core.AllStringsInSlice(rule.Metrics, readabilityMetrics) {
		// NOTE: This is the only extension point that doesn't support scoping.
		// The reason for this is that we need to split on sentences to
		// calculate readability, which means that specifying a scope smaller
		// than a paragraph or including non-block level content (i.e.,
		// headings, list items or table cells) doesn't make sense.
		rule.Definition.Scope = []string{"summary"}
	}

	return rule, nil
}

// Run calculates the readability level of the given text.
func (o Readability) Run(blk nlp.Block, _ *core.File, _ *core.Config) ([]core.Alert, error) {