vue/require-prop-comment

Require a JSDoc comment on each declared prop.

Applies to: Vue SFC templates and blocks, with script context where the rule requires it.

Bad

The size prop has no JSDoc comment.

<script setup lang="ts">
const { size } = defineProps<{ size: string }>();
</script>
<template>
  <p>{{ size }}</p>
</template>

Good

The size prop documents its meaning with a JSDoc comment.

<script setup lang="ts">
const { size } = defineProps<{
  /** The rendered size. */
  size: string;
}>();
</script>
<template>
  <p>{{ size }}</p>
</template>

Configuration (Vite+)

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

export default defineConfig({}).withVue({
  linter: {
    "preset": "incremental",
    "rules": {
      "vue/require-prop-comment": "warn"
    }
  },
});

Then run vp run lint.

Related

• Vue rules
• All rules
• Source code