script/require-symbol-provide
Recommander Symbol comme clé d’injection pour provide/inject.
| Gravité par défaut | Préréglages | Correction automatique | Options |
|---|---|---|---|
warning |
Aucune | Non | Aucune |
Champ d’application : Scripts JS/TS des SFC Vue ; les exemples montrent la forme concernée de l’Options API ou de script setup.
Mauvais
provide et inject utilisent des clés sous forme de chaînes littérales telles que 'user' et 'theme', qui peuvent entrer en conflit avec un autre fournisseur utilisant la même graphie.
<script setup lang="ts">
// String keys can collide
provide('user', user)
const user = inject('user')
// Magic strings are error-prone
provide('theme', { dark: true })
</script>
Bon
La clé partagée UserKey est créée avec Symbol et annotée comme InjectionKey<User> ; les deux appels passent cette clé au lieu d’une chaîne littérale.
<script lang="ts">
// Define injection key with Symbol
export const UserKey: InjectionKey<User> = Symbol('user')
// Provide with Symbol
provide(UserKey, user)
// Inject with Symbol
const user = inject(UserKey)
</script>
Configuration (Vite+)
import { defineConfig } from "@vizejs/vite-plugin/vite-plus";
export default defineConfig({}).withVue({
linter: {
"preset": "incremental",
"rules": {
"script/require-symbol-provide": "warn"
}
},
});
Lancez ensuite vp run lint.