Vize

script/require-symbol-provide

Recomendar o uso de Symbol como chave de injeção para provide/inject.

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

provide e inject usam chaves de string literal como 'user' e 'theme', que podem colidir com outro provedor que use a mesma grafia.

<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>

Correto

O UserKey compartilhado é criado com Symbol e anotado como InjectionKey<User>; ambas as chamadas passam essa chave em vez de uma string literal.

<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>

Configuração (Vite+)

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

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

Depois, execute vp run lint.

Páginas relacionadas