Closed
Description
Please describe what the rule should do:
The role of this rule would be to suggest props destructuring. It could also warns on its usage if necessary.
What category should the rule belong to?
[X] Enforces code style (layout)
[ ] Warns about a potential error (problem)
[ ] Suggests an alternate way of doing something (suggestion)
[ ] Other (please specify:)
Provide 2-3 code examples that this rule should warn about:
// vue/prefer-props-destructuring
const props = defineProps<>({...}) // 🚨
const {...} = defineProps<>({...}) // 👍
Additional context
Metadata
Metadata
Assignees
Labels
No labels
Activity
markbrockhoff commentedon Mar 31, 2025
I agree that a rule to enforce a default style for declaring props (especially with defaults) should be provided. At the moment there are two ways for defining default values on props:
I'd suggest creating a configurable rule allowing the project to decide which style to use for concistency. So either destructuring should be prefered or the opposite, where props should not be destructured and
withDefaults
be used.mrleblanc101 commentedon Apr 14, 2025
Since reactive props destructuring has been added in Vue 3.5, I think a rule for this is important for code consistency !
I see that @waynzh has worked pushed some commit about props destructuring on main
waynzh commentedon Apr 14, 2025
This is certainly a useful rule. It's pretty straightforward, given that a function already exists to identify usage of prop destructuring.
define-props-destructuring
rule #2736ZexTech commentedon Apr 30, 2025
esfahanweb commentedon May 5, 2025
ota-meshi commentedon May 5, 2025
Please do not comment on your problem on a closed issue.
Open a new issue and provide details about your problem and a reproduction repository.