script/no-reserved-props
Proibir nomes reservados na declaração de props de um componente.
| Severidade padrão | Predefinições | Correção automática | Opções |
|---|---|---|---|
error |
essential, 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
ref e $foo na forma de objeto, além de key na forma de array, são nomes reservados de props. ref e key são controles do framework, e nomes com prefixo $ são rejeitados.
<script lang="ts">
export default {
props: {
ref: String, // reserved
$foo: Number // `$`-prefixed names are reserved
}
}
export default {
props: ['key'] // reserved (array form)
}
</script>
Correto
Os nomes comuns de props name e refValue evitam os nomes reservados tanto na grafia quanto no prefixo.
<script lang="ts">
export default {
props: {
name: String,
refValue: Number
}
}
</script>
Configuração (Vite+)
import { defineConfig } from "@vizejs/vite-plugin/vite-plus";
export default defineConfig({}).withVue({
linter: {
"preset": "incremental",
"rules": {
"script/no-reserved-props": "error"
}
},
});
Depois, execute vp run lint.