type/related-getter-setter-pairs

Require paired getters and setters to use compatible types.

Applies to: Type information in Vue SFC scripts and templates, for the constructs shown below.

This rule reads type information from your TypeScript project (tsconfig.json), so the configuration sets typeAware: true. typeAware does not turn on opt-in rules by itself.

Bad

The getter returns string while the setter accepts number, so the pair is incompatible.

<script setup lang="ts">
interface Box {
  get size(): string;
  set size(value: number);
}
</script>

Good

The getter and the setter both use string.

<script setup lang="ts">
interface Box {
  get size(): string;
  set size(value: string);
}
</script>

Configuration (Vite+)

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

export default defineConfig({}).withVue({
  linter: {
    "preset": "incremental",
    "rules": {
      "type/related-getter-setter-pairs": "warn"
    },
    "typeAware": true
  },
});

Then run vp run lint.

Related

• Type and script rules
• All rules
• Source code