vue/prefer-prop-type-boolean-first

Enforce Boolean comes first in component prop types.

Applies to: JS/TS scripts in Vue SFCs; examples show the relevant Options API or script setup form.

Changing constructor order can change runtime boolean casting. This opt-in check covers runtime defineProps and Options API prop type arrays; it does not reorder TypeScript union types.

Bad

String precedes Boolean, so a bare enabled attribute uses string-first casting rather than the boolean-first convention.

<script setup lang="ts">
defineProps({ enabled: [String, Boolean] });
</script>

Good

Place Boolean first to give the prop boolean-first casting while retaining its accepted string type.

<script setup lang="ts">
defineProps({ enabled: [Boolean, String] });
</script>

Configuration (Vite+)

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

export default defineConfig({}).withVue({
  linter: {
    "preset": "incremental",
    "rules": {
      "vue/prefer-prop-type-boolean-first": "warn"
    }
  },
});

Then run vp run lint.

Related

• Vue rules
• All rules
• Source code