Module linting

Module linting 

Source
Expand description

Frameworks and rules that locate errors in text.

See the Linter trait and the documentation for authoring a rule for more information.

Structs§

APart
Addicting
AdjectiveDoubleDegree
AdjectiveOfA
Detect sequences of words of the form “adjective of a”.
AllIntentsAndPurposes
AmInTheMorning
AmountsFor
AnA
AnotherThingComing
Both another thing coming and another think coming are correct, but another think coming is more common.
AnotherThinkComing
Both another thing coming and another think coming are correct, but another think coming is the original.
AskNoPreposition
AvoidCurses
BackInTheDay
BestOfAllTime
BoringWords
Cant
CapitalizePersonalPronouns
A linter that makes sure you capitalize “I” and its contractions.
ChockFull
CommaFixes
A linter that fixes common comma errors: No space after. Inappropriate space before. Asian commas instead of English commas. This linter only Asian commas anywhere, and wrong spacing of commas between words. Commas between numbers are used differently in different contexts and these are not checked: Lists of numbers: 1, 2, 3 Thousands separators: 1,000,000 Decimal points used mistakenly by Europeans: 3,14159
CompoundNouns
Confident
CorrectNumberSuffix
Detect incorrect number suffix (e.g. “2st”).
CriteriaPhenomena
Linter that checks if ‘criteria’ or ‘phenomena’ is used as singular.
CurrencyPlacement
Dashes
DespiteOf
DiscourseMarkers
DotInitialisms
DoubleModal
EllipsisLength
A linter that checks that an ellipsis doesn’t contain too many periods (or too few).
Everyday
ExpandMemoryShorthands
ExpandTimeShorthands
FeelFell
FewUnitsOfTimeAgo
FillerWords
ForNoun
FriendOfMe
HavePronoun
HaveTakeALook
Hedging
A linter that detects hedging language.
Hereby
HopHope
HowTo
HyphenateNumberDay
IAmAgreement
InOnTheCards
InflectedVerbAfterTo
InitialismLinter
A struct that can be composed to expand initialisms, respecting the capitalization of each item.
InterestedIn
ItLooksLikeThat
ItsContraction
ItsPossessive
LeftRightHand
LessWorse
LetsConfusion
Likewise
Lint
An error found in text.
LintGroup
A struct for collecting the output of a number of individual Linters. Each child can be toggled via the public, mutable Self::config object.
LintGroupConfig
The configuration for a LintGroup. Each child linter can be enabled, disabled, or set to a curated value.
LongSentences
Detect and warn that the sentence is too long.
LookingForwardTo
MapPhraseLinter
MapPhraseSetLinter
MassPlurals
MergeWords
MissingPreposition
MissingTo
MixedBag
ModalOf
Months
MostNumber
MultipleSequentialPronouns
Linter that checks if multiple pronouns are being used right after each other. This is a common mistake to make during the revision process.
NailOnTheHead
NoFrenchSpaces
NoMatchFor
NoOxfordComma
Nobody
NounCountability
NounVerbConfusion
NumberSuffixCapitalization
Detect incorrect capitalization for number suffixes (e.g. “2ND”).
OfCourse
OnFloor
OneAndTheSame
OpenTheLight
OughtToBe
Detects the eggcorn out to be when the intended phrase is ought to be.
OutOfDate
OxfordComma
Oxymorons
A linter that flags oxymoronic phrases.
PhrasalVerbAsCompoundNoun
Detect phrasal verbs written as compound nouns.
PiqueInterest
PossessiveNoun
PossessiveYour
ProgressiveNeedsBe
PronounContraction
PronounInflectionBe
QuantifierNeedsOf
Flags phrases like a couple months → should be a couple **of** months.
QuiteQuiet
QuoteSpacing
RedundantAdditiveAdverbs
Regionalisms
RepeatedWords
SaveToSafe
SemicolonApostrophe
SentenceCapitalization
ShootOneselfInTheFoot
SimplePastToPastParticiple
Corrects simple past tense verbs to past participle after auxiliary verbs like “have” or “be”.
SinceDuration
SomewhatSomething
SoughtAfter
Spaces
SpellCheck
SpelledNumbers
Linter that checks to make sure small integers (< 10) are spelled out.
TakeSerious
Linter that corrects “take X serious” to “take X seriously”.
ThatThan
ThatWhich
TheHowWhy
Suggests removing the when followed by how/why/who/when/what, skipping cases like how to and who's who.
TheMy
ThenThan
Corrects the misuse of then to than.
ThingThink
Corrects the typo “thing” for “think”.
ThoughThought
ThrowRubbish
ToTwoToo
Touristic
UnclosedQuotes
UpdatePlaceNames
UseGenitive
VeryUnique
WasAloud
WayTooAdjective
Whereas
WidelyAccepted
WinPrize
WordPressDotcom
Make sure you properly capitalize WordPress.com.
WouldNeverHave

Enums§

LintKind
The general category a Lint falls into. There’s no reason not to add a new item here if you are adding a new rule that doesn’t fit the existing categories.
Suggestion
A suggested edit that could resolve a Lint.

Traits§

ExprLinter
A trait that searches for tokens that fulfil Exprs in a Document.
HtmlDescriptionLinter
A blanket-implemented trait that renders the Markdown description field of a linter to HTML.
Linter
A stateless rule that searches documents for grammatical errors.