Vize

vue/require-prop-comment

Exige um comentário JSDoc em cada prop declarada.

Severidade padrão Predefinições Correção automática Opções
warning Nenhuma Não Nenhuma

Aplicável a: Templates e blocos de SFC Vue, com o contexto do script quando exigido pela regra.

Incorreto

A prop size não tem comentário JSDoc.

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

Correto

A prop size documenta seu significado com um comentário JSDoc.

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

Configuração (Vite+)

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

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

Depois, execute vp run lint.

Páginas relacionadas