Struct UnusedComponentPropsConfig 

pub struct UnusedComponentPropsConfig {
    pub ignore_pattern: Option<String>,
}

Options for the unused-component-props rule.

Lets a project exempt component props whose local destructure binding name matches a regex from unused-component-props, honoring the “accepted-but-intentionally-unused” leading-underscore convention (Svelte 5 $props(), React destructure) that mirrors TypeScript noUnusedParameters and ESLint @typescript-eslint/no-unused-vars varsIgnorePattern / argsIgnorePattern. Opt-in; an unset ignorePattern leaves the rule’s behavior unchanged.

Fields

ignore_pattern: Option<String>

Regex matched against each declared prop’s LOCAL destructure binding name (e.g. _stage in let { stage: _stage } = $props()), which falls back to the public prop name when there is no alias. A prop whose local name matches is treated as intentionally unused and never reported as unused-component-props. Matching is unanchored (substring), like ESLint’s RegExp.test, so anchor with ^_ to match a leading underscore. Compiled and validated at config load (an invalid regex fails load). Applies to Vue, Svelte, Astro, and React/Preact props.

Implementations

impl UnusedComponentPropsConfig

pub fn is_default(&self) -> bool

Trait Implementations

impl Clone for UnusedComponentPropsConfig

fn clone(&self) -> UnusedComponentPropsConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for UnusedComponentPropsConfig

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

Formats the value using the given formatter.

impl Default for UnusedComponentPropsConfig

fn default() -> UnusedComponentPropsConfig

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for UnusedComponentPropsConfig

where UnusedComponentPropsConfig: Default,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for UnusedComponentPropsConfig

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl Serialize for UnusedComponentPropsConfig

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

where __S: Serializer,

Serialize this value into the given Serde serializer.