Configuração Global

Visão Geral da Configuração Global

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

O que é Configuração Global?

A configuração global (a aba Global do Axe Configuration) é um conjunto de controles que determinam como o Axe Watcher opera durante os testes de acessibilidade. Estas configurações incluem:

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

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

Por que usar Configuração Global?

A configuração global resolve vários desafios comuns no teste de acessibilidade empresarial:

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

Como Funciona a Configuração Global

Administradores

Os administradores definem padrões organizacionais e estabelecem quais configurações os usuários podem modificar através da propriedade configurationOverrides (JavaScript/TypeScript) ou método AxeWatcherOptions.setConfgurationOverrides() (Java). Estas configurações estabelecem a base para os testes do Axe Watcher dentro da organização. Essas configurações são alteradas no painel Global do Axe Configuration.

Usuários

Usuários individuais personalizam o Axe Watcher alterando ou adicionando a opção configurationOverrides em seu código de configuração de teste para escolher valores diferentes daqueles configurados pelo administrador da organização (mas somente para configurações onde o administrador marcou a caixa de seleção Permitir que os usuários alterem).

A opção configurationOverrides 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 Sobrescrição 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 enquanto fornece aos usuários a flexibilidade necessária.

A tabela a seguir ilustra 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.

Compreendendo os Resultados

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

Recomendações

1. Sempre prefira configurationOverrides a runOptions.
2. Verifique as configurações da sua empresa antes de configurar as substituições.
3. Somente substitua as configurações quando for 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 substituições para seguir WCAG 2.1 AA, definir axe-core para a versão 4.9.1, e permitir regras experimentais e 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
    }
};

Consulte (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 tanto runOptions.runOnly quanto configurationOverrides, seus testes falharão imediatamente.

Avisos

Usando runOptions com runOnly ou rules

Se você definir as propriedades runOnly ou rules no objeto runOptions, receberá esta mensagem:

This scan was created using runOptions. This may not be aligned with your organization's global configurations.

Usar runOnly ou rules pode permitir que seu código use regras de acessibilidade que não são permitidas pela configuração global que sua organização usa.

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

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

Veja Também

• Configuração do Axe
• (JavaScript/TypeScript) referência de configurationOverrides
• (Java) ConfigurationOverrides Classe