Vize

script/no-boolean-default

Proibir um valor padrão em uma prop Boolean.

Severidade padrão Predefinições Correção automática Opções
warning opinionated, nuxt 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

Tanto disabled quanto checked declaram um default em uma prop cujo único construtor é Boolean; a regra rejeita até mesmo um valor padrão false explícito.

<script lang="ts">
export default {
  props: {
    // Boolean props already default to false; an explicit default is confusing.
    disabled: { type: Boolean, default: true },
    checked: { type: Boolean, default: false }
  }
}
</script>

Correto

As props exclusivamente Boolean omitem default, usando o valor false implícito do Vue. A união [Boolean, String] e a prop Number ilustram que esta verificação se limita ao construtor único Boolean.

<script lang="ts">
export default {
  props: {
    // No explicit default: defaults to false.
    disabled: { type: Boolean },
    disabled2: Boolean,
    // Union type may legitimately need a default.
    value: { type: [Boolean, String], default: '' },
    // Non-Boolean prop.
    count: { type: Number, default: 0 }
  }
}
</script>

Configuração (Vite+)

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

export default defineConfig({}).withVue({
  linter: {
    "preset": "incremental",
    "rules": {
      "script/no-boolean-default": "warn"
    }
  },
});

Depois, execute vp run lint.

Páginas relacionadas