LintKind

Enum LintKind 

Source
pub enum LintKind {
Show 20 variants Agreement, BoundaryError, Capitalization, Eggcorn, Enhancement, Formatting, Grammar, Malapropism, Miscellaneous, Nonstandard, Punctuation, Readability, Redundancy, Regionalism, Repetition, Spelling, Style, Typo, Usage, WordChoice,
}
Expand description

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.

Variants§

§

Agreement

§

BoundaryError

For errors where words are joined or split at the wrong boundaries (e.g., “each and everyone” vs. “each and every one”)

§

Capitalization

§

Eggcorn

For cases where a word or phrase is misused for a similar-sounding word or phrase, where the incorrect version makes logical sense (e.g., ‘egg corn’ for ‘acorn’, ‘on mass’ for ‘en masse’).

§

Enhancement

For suggesting improvements that enhance clarity or impact without fixing errors

§

Formatting

§

Grammar

§

Malapropism

For cases where a word is mistakenly used for a similar-sounding word with a different meaning (e.g., ‘eluded to’ instead of ‘alluded to’). Unlike eggcorns, these don’t create new meanings.

§

Miscellaneous

For any other lint that doesn’t fit neatly into the other categories

§

Nonstandard

§

Punctuation

For issues with punctuation, including hyphenation in compound adjectives (e.g., “face first” vs. “face-first” when used before a noun)

§

Readability

§

Redundancy

For cases where words duplicate meaning that’s already expressed (e.g., “basic fundamentals” → “fundamentals”, “free gift” → “gift”)

§

Regionalism

For variations that are standard in some regions or dialects but not others

§

Repetition

§

Spelling

When your brain doesn’t know the right spelling. This should only be used by linters doing spellcheck on individual words.

§

Style

For cases where multiple options are correct but one is preferred for style or clarity, such as expanding abbreviations in formal writing (e.g., ‘min’ → ‘minimum’)

§

Typo

When your brain knows the right spelling but your fingers made a mistake. (e.g., ‘can be seem’ → ‘can be seen’)

§

Usage

For conventional word usage and standard collocations (e.g., ‘by accident’ vs. ‘on accident’ in standard English)

§

WordChoice

For choosing between different words or phrases in a given context

Implementations§

Source§

impl LintKind

Source

pub const fn is_agreement(&self) -> bool

Returns true if self is of variant Agreement.

Source

pub const fn is_boundary_error(&self) -> bool

Returns true if self is of variant BoundaryError.

Source

pub const fn is_capitalization(&self) -> bool

Returns true if self is of variant Capitalization.

Source

pub const fn is_eggcorn(&self) -> bool

Returns true if self is of variant Eggcorn.

Source

pub const fn is_enhancement(&self) -> bool

Returns true if self is of variant Enhancement.

Source

pub const fn is_formatting(&self) -> bool

Returns true if self is of variant Formatting.

Source

pub const fn is_grammar(&self) -> bool

Returns true if self is of variant Grammar.

Source

pub const fn is_malapropism(&self) -> bool

Returns true if self is of variant Malapropism.

Source

pub const fn is_miscellaneous(&self) -> bool

Returns true if self is of variant Miscellaneous.

Source

pub const fn is_nonstandard(&self) -> bool

Returns true if self is of variant Nonstandard.

Source

pub const fn is_punctuation(&self) -> bool

Returns true if self is of variant Punctuation.

Source

pub const fn is_readability(&self) -> bool

Returns true if self is of variant Readability.

Source

pub const fn is_redundancy(&self) -> bool

Returns true if self is of variant Redundancy.

Source

pub const fn is_regionalism(&self) -> bool

Returns true if self is of variant Regionalism.

Source

pub const fn is_repetition(&self) -> bool

Returns true if self is of variant Repetition.

Source

pub const fn is_spelling(&self) -> bool

Returns true if self is of variant Spelling.

Source

pub const fn is_style(&self) -> bool

Returns true if self is of variant Style.

Source

pub const fn is_typo(&self) -> bool

Returns true if self is of variant Typo.

Source

pub const fn is_usage(&self) -> bool

Returns true if self is of variant Usage.

Source

pub const fn is_word_choice(&self) -> bool

Returns true if self is of variant WordChoice.

Source§

impl LintKind

Source

pub fn to_string_key(&self) -> String

Produce a string representation, which can be used as keys in a map or CSS variables.

Trait Implementations§

Source§

impl Clone for LintKind

Source§

fn clone(&self) -> LintKind

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for LintKind

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Default for LintKind

Source§

fn default() -> LintKind

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for LintKind

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Display for LintKind

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Hash for LintKind

Source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl PartialEq for LintKind

Source§

fn eq(&self, other: &LintKind) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Serialize for LintKind

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl Copy for LintKind

Source§

impl Eq for LintKind

Source§

impl StructuralPartialEq for LintKind

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> ErasedDestructor for T
where T: 'static,

Source§

impl<T> LSend for T
where T: ?Sized,