useVueConsistentDefinePropsDeclaration (JavaScript)

Language JavaScript (and super languages)

Caution

This rule is part of the nursery group. This means that it is experimental and the behavior can change at any time.

Summary

• Rule available since: v2.3.11
• Diagnostic Category: lint/nursery/useVueConsistentDefinePropsDeclaration
• This rule doesn’t have a fix.
• The default severity of this rule is information.
• This rule belongs to the following domains:
  • vue
• Sources:
  • Same as vue/define-props-declaration

How to configure

biome.json

{
  "linter": {
    "rules": {
      "nursery": {
        "useVueConsistentDefinePropsDeclaration": "error"
      }
    }
  }
}

Description

Enforce consistent defineProps declaration style.

This rule enforces defineProps typing style which you should use type or runtime declaration.

Examples

Invalid

<script setup lang="ts">
const props = defineProps({
  kind: { type: String },
});
</script>

code-block.vue:2:15 lint/nursery/useVueConsistentDefinePropsDeclaration ━━━━━━━━━━━━━━━━━━━━━━━━━━━━

  ℹ This defineProps declaration uses runtime declaration.
  
    1 │ <script setup lang="ts">
  > 2 │ const props = defineProps({
      │               ^^^^^^^^^^^^^
  > 3 │   kind: { type: String },
  > 4 │ });
      │ ^^
    5 │ </script>
    6 │ 
  
  ℹ It should be defined using type declaration like defineProps<...>(). 
  
  ℹ This rule belongs to the nursery group, which means it is not yet stable and may change in the future. Visit https://biomejs.dev/linter/#nursery for more information.
  

Valid

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

Related links

• Disable a rule
• Configure the code fix
• Rule options
• Source Code (Edit this Page)
• Test Cases
• Try in the playground