Usando Configurações Globais

This page is not available in the language you requested. You have been redirected to the English version of the page.
Link to this page copied to clipboard

Este artigo descreve como a configuração global do axe Configuration funciona com o axe Developer Hub

Not for use with personal data

Visão Geral das Configurações Globais

O painel Global do axe Configuration fornece uma maneira centralizada de gerenciar e controlar as configurações de testes de acessibilidade em toda a sua organização. Este recurso poderoso permite que administradores empresariais estabeleçam padrões de teste consistentes, enquanto oferecem às equipes e desenvolvedores individuais a flexibilidade necessária para trabalhar de forma eficaz. axe Configuration

O que são Configurações Globais?

Configurações globais (a aba Global do axe Configuration) são um conjunto de controles que determinam como o axe Developer Hub opera durante os testes de acessibilidade. Essas configurações incluem:

  • Quais padrões de acessibilidade testar contra (como WCAG 2.1 AA ou EN 301 549)
  • Se incluir verificações de melhores práticas
  • Se habilitar regras experimentais
  • Qual versão do axe-core usar para testar

Essas configurações podem ser gerenciadas tanto no nível empresarial quanto no nível de usuário individual, criando um ambiente de teste flexível, mas controlado.

Por que Usar Configurações Globais?

As configurações globais resolvem vários desafios comuns nos testes de acessibilidade empresarial:

  • Consistência: Garantir que todas as equipes estejam testando contra os mesmos padrões de acessibilidade
  • Conformidade: Aplicar requisitos específicos de teste em toda a sua organização
  • Flexibilidade: Permitir que as equipes personalizem sua abordagem de teste dentro dos parâmetros aprovados
  • Controle de Versão: Gerenciar quais versões do axe-core podem ser usadas em projetos
  • Garantia de Qualidade: Manter os padrões de teste enquanto permitem otimizações específicas da equipe

Como Funcionam as Configurações Globais

Administradores

Os administradores definem padrões gerais de organização e determinam quais configurações os usuários podem modificar através da opção. Essas configurações estabelecem a linha de base para os testes do axe Developer Hub dentro da organização. Estas configurações são alteradas no painel configurationOverrides opção. Estas configurações estabelecem a linha de base para os testes do axe Developer Hub dentro da organização. Estas configurações são alteradas no painel Global do axe Configuration.

note

Algumas configurações no painel Global atualmente não se aplicam ao axe Developer Hub. Essas configurações incluem:

  • Necessita Revisão Padrão
  • Capturas de Tela de Problemas Compartilhados Padrão
  • Aprendizado de Máquina Padrão
  • Serviço de Uso

Usuários

Em vez de usar o **Painel Global** , usuários individuais personalizam sua configuração de teste alterando ou adicionando a configurationOverrides opção em seu código de configuração de teste. A configurationOverrides opção interage com as configurações no **Painel Global** , conforme definido na tabela em Cenários Comuns de Configuração Global e Sobrescrita de Configuração.

As referências da API incluem mais informações sobre (JavaScript/TypeScript) configurationOverrides ou (Java) ConfigurationsOverrides e suas propriedades.

Cenários Comuns de Configuração Global e Sobrescrita de Configuração

Quando um teste é executado, o axe Developer Hub mescla configurações empresariais e de usuário para criar a configuração final de teste. Isso garante que todas as personalizações permaneçam dentro dos parâmetros aprovados, proporcionando aos usuários a flexibilidade necessária.

A tabela a seguir ilustra os cenários comuns que você encontrará ao trabalhar com configurações globais. Cada cenário mostra como as configurações empresariais interagem com a configuração do seu projeto.

Cenário O Que Você Quer Fazer Configuração Global Seu Código de Configuração Resultado
Uso Básico Usar o padrão padrão WCAG 2.0 AA (invariável na configuração global) Nenhuma configuração especificada ✅ Testes executados usando WCAG 2.0 AA
Sobrescrita Permitida Usar um padrão permitido diferente WCAG 2.0 AA, pode usar 2.1 AA configurationOverrides: { accessibilityStandard: 'WCAG 2.1 AA'} ✅ Testes executados usando WCAG 2.1 AA
Sobrescrita Não Autorizada Usar um padrão não autorizado Apenas WCAG 2.0 AA configurationOverrides: { accessibilityStandard: 'WCAG 2.1 AA' } ❌ Erro: Padrão não permitido
Ativar Melhores Práticas Incluir verificações de melhores práticas Melhores práticas permitidas configurationOverrides: { bestPractices: true } ✅ Testes incluem melhores práticas
Configuração Mista Usar regras personalizadas com padrão WCAG 2.0 AA (invariável) runOptions: { rules: { 'color-contrast': { enabled: false } } } ⚠️ Funciona, mas exibe aviso
Configuração Legada Usar configuração de estilo antigo Qualquer runOptions: { runOnly: { type: 'tag', values: ['WCAG 2.0 A'] } } ⚠️ Funciona, mas exibe aviso
Combinação Inválida Misturar configurações antigas e novas Qualquer Usando ambos configurationOverrides e runOptions.runOnly ❌ Erro: Não é possível usar ambos

Compreendendo os Resultados

  • ✅ Sucesso: A configuração funciona como esperado
  • ⚠️ Aviso: A configuração funciona, mas não é recomendada
  • ❌ Erro: A configuração falhará

Recomendações

  1. Sempre prefira configurationOverrides ao invés de runOptions.
  2. Verifique as configurações da sua empresa antes de configurar sobreposições.
  3. Substitua configurações apenas quando necessário.
  4. Use a configuração mais simples que atenda às suas necessidades.

Exemplo de Substituição de Configuração

Aqui está um exemplo de configuração que demonstra sobreposições para seguir WCAG 2.1 AA e as melhores práticas:

const config = {
  axe: {
    apiKey: 'YOUR_API_KEY',
    projectId: 'YOUR_PROJECT_ID',

    configurationOverrides: {
      accessibilityStandard: 'WCAG 2.1 AA',
      axeCoreVersion: '4.9.1',
      experimentalRules: true,
      bestPractices: true
    }
};

Veja (JavaScript/TypeScript) ConfigurationOverrides Interface ou (Java) ConfigurationOverrides Classe para uma explicação das propriedades.

Erros e Avisos

Erros

Padrão Não Permitido

Se você tentar usar um padrão que não é permitido, receberá um código de resposta do servidor 422, Conteúdo Não Processável. Mensagem de exemplo:

Error: Server responded to https://axe.deque.com/api-pub/watcher/sessions with status code 422: "error": "Invalid accessibility standard: WCAG 2.0 AA. Allowed options: EN 301 549, Trusted Tester v5"
Usando runOptions.runOnly com configurationOverrides

Se você usar ambos runOptions.runOnly com configurationOverrides, seus testes falharão imediatamente. Use apenas configurationOverrides.

Avisos

Usando runOptions.runOnly

Se você usar runOptions.runOnly em sua configuração, você receberá esta mensagem de aviso:

Captura de tela mostrando um aviso no axe Developer Hub ao usar runOptions.runOnly.

@axe-core/watcher Sem Suporte para Configuração Global

Se você usar uma versão de @axe-core/watcher que é muito antiga para ter suporte à configuração global, você receberá esta mensagem:

Captura de tela mostrando a mensagem que ocorre quando o pacote @axe-core/watcher é muito antigo para suportar configurações globais

Veja Também