vue/define-props-destructuring
enforce consistent style for props destructuring
- ❗ This rule has not been released yet.
📖 Rule Details
This rule enforces a consistent style for handling Vue 3 Composition API props, allowing you to choose between requiring destructuring or prohibiting it.
By default, the rule requires you to use destructuring syntax when using defineProps
instead of storing props in a variable and warns against combining withDefaults
with destructuring.
The rule applies to both JavaScript and TypeScript props:
🔧 Options
js
{
"vue/define-props-destructuring": ["error", {
"destructure": "always" | "never"
}]
}
destructure
- Sets the destructuring preference for props"always"
(default) - Requires destructuring when usingdefineProps
and warns against usingwithDefaults
with destructuring"never"
- Requires using a variable to store props and prohibits destructuring
"destructure": "never"