Struct Rule003Spelling

pub struct Rule003Spelling { /* private fields */ }

Words are checked for correct spelling.

There are four ways to deal with words that are flagged, even though you’re spelling them as intended:

1. For proper nouns and jargon, you can add them to the Vocabulary.
2. For function, method, and variable names, you can format them as inline code. For example, instead of foo, write `foo`.
3. You can add a temporary configuration, which will take effect for either the next line or the rest of the file. This configuration adds the specified words to the vocabulary temporarily. Words added are case-sensitive.

   {/* supa-mdx-lint-configure Rule003Spelling +Supabase */}
   {/* supa-mdx-lint-configure-next-line Rule003Spelling +pgTAP */}

4. You can disable the rule by using one of the disable directives. This should be used as a last resort.

   {/* supa-mdx-lint-disable Rule003Spelling */}
   {/* supa-mdx-lint-disable-next-line Rule003Spelling */}

Examples

Valid

This is correctly spelled.

Invalid

This is incorrectyl spelled.

Vocabulary

Vocabulary can be added via the allow_list and prefixes arrays.

• allow_list: A list of words (or regex patterns to match words) that are considered correctly spelled.
• prefixes: A list of prefixes that are not standalone words, but that can be used in a prefix before a hyphen (e.g., pre, bi).

See an example from the Supabase repo.

Trait Implementations

impl Debug for Rule003Spelling

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

Formats the value using the given formatter.

impl Default for Rule003Spelling

fn default() -> Rule003Spelling

Returns the “default value” for a type.