Vize

type/require-typed-emits

defineEmits に型定義を指定します。

悪い例 · 良い例

既定の重大度: warning
プリセット: happy-path, nuxt, ecosystem, opinionated
自動修正: なし。修正内容を確認してください
適用範囲: Vue SFC の script とテンプレートの型情報。例に示した構文が対象です。
オプション: ルール固有のオプションはありません。重大度とプリセットは設定できます。

型を使う検査には Corsa と TypeScript プロジェクトが必要です。typeAware だけでは opt-in ルールは有効になりません。

設定(Vite+)

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

export default defineConfig({
  lint: {
    vize: {
      "preset": "incremental",
      "rules": {
        "type/require-typed-emits": "warn"
      },
      "typeAware": true
    },
  },
});
vp run lint

悪い

配列だけの defineEmits(["save"]) はイベント名を宣言するだけで、型付きの payload 契約がありません。

<script setup lang="ts">
defineEmits(["save"]);
</script>

良い

defineEmits<{ save: [] }>() で空の payload タプルを持つ型付きの save イベントを宣言し、payload の引数を受け取らないことを明示します。

<script setup lang="ts">
defineEmits<{ save: [] }>();
</script>

良い例は上記の設定でこのルールの検出を避ける例です。他のルールでは検出される場合があります。

実装 · 全ルール