`script/define-props-destructuring`

Enforce consistent style for defineProps destructuring in <script setup>

Default severity: warning
Presets: none
Automatic fix: None; review the suggested change
Applies to: JS/TS scripts in Vue SFCs; examples show the relevant Options API or script setup form
Options: See typed options and defaults.

Configuration (Vite+)

import { defineConfig } from "@vizejs/vite-plugin/vite-plus";

export default defineConfig({
  lint: {
    vize: {
      "preset": "incremental",
      "rules": {
        "script/define-props-destructuring": "warn"
      }
    },
  },
});

vp run lint

Bad

defineProps is assigned to the single props binding rather than destructured, contrary to the default destructuring preference.

<script setup lang="ts">
const props = defineProps<{ foo: string }>()
</script>

Good

The object pattern binds foo and bar directly and gives the optional bar a default. This relies on Vue 3.5+ reactive props destructuring; the configurable never mode prefers the opposite form.

<script setup lang="ts">
const { foo, bar = 'default' } = defineProps<{ foo: string; bar?: string }>()
</script>

Good avoids this rule's finding under the configuration above; other rules may still report diagnostics.

Implementation · All rules