package
2.30.0
Repository: https://github.com/errata-ai/vale.git
Documentation: pkg.go.dev

# Functions

NewCapitalization creates a new `capitalization`-based rule.
NewConditional creates a new `conditional`-based rule.
NewConsistency creates a new `consistency`-based rule.
NewExistence creates a new `Rule` that extends `Existence`.
NewManager creates a new Manager and loads the rule definitions (that is, extended checks) specified by configuration.
NewMetric creates a new `metric`-based rule.
NewOccurrence creates a new `occurrence`-based rule.
NewReadability creates a new `readability`-based rule.
NewRepetition creates a new `repetition`-based rule.
No description provided by the author
NewScript creates a new `script`-based rule.
No description provided by the author
NewSequence creates a new rule from the provided `baseCheck`.
NewSpelling creates a new `spelling`-based rule.
NewSubstitution creates a new `substitution`-based rule.

# Structs

Capitalization checks the case of a string.
Conditional ensures that the present of First ensures the present of Second.
Consistency ensures that the keys and values of Either don't both exist.
Definition holds the common attributes of rule definitions.
Existence checks for the present of Tokens.
FilterEnv is the environment passed to the `--filter` flag.
Manager controls the loading and validating of the check extension points.
Metric implements arbitrary, readability-like formulas.
NLPToken represents a token of text with NLP-related attributes.
Occurrence counts the number of times Token appears.
Readability checks the reading grade level of text.
Repetition looks for repeated uses of Tokens.
No description provided by the author
Script is Tango-based script.
A Selector represents a named section of text.
Sequence looks for a user-defined sequence of tokens.
Spelling checks text against a Hunspell dictionary.
Substitution switches the values of Swap for its keys.

# Interfaces

Rule represents in individual writing construct to enforce.