Vize

script/require-define-component

Exigir defineComponent() em exports padrão de SFCs TypeScript.

Severidade padrão Predefinições Correção automática Opções
error happy-path, ecosystem, nuxt, opinionated Não Nenhuma

Aplicável a: Scripts JS/TS em SFCs Vue; os exemplos mostram a forma relevante de Options API ou script setup.

Incorreto

A SFC TypeScript exporta diretamente um objeto da Options API, portanto suas opções não recebem os tipos contextuais fornecidos por defineComponent().

<script lang="ts">
export default {
  props: { count: Number },
  mounted() {
    console.log(this.count)
  }
}
</script>

Correto

Envolver o objeto com defineComponent() aplica a verificação TypeScript específica do Vue a props, emits, this e às demais opções.

<script lang="ts">
import { defineComponent } from 'vue'
export default defineComponent({
  props: { count: Number },
  mounted() {
    console.log(this.count)
  }
})
</script>

Configuração (Vite+)

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

export default defineConfig({}).withVue({
  linter: {
    "preset": "incremental",
    "rules": {
      "script/require-define-component": "error"
    }
  },
});

Depois, execute vp run lint.

Páginas relacionadas