Geavanceerd API-gebruik met Ruby

Dit document bespreekt aangepaste regels, rapportage-opties en de gebruiksservice met Ruby.

Aangepaste Regels

U kunt aangepaste axe-regels specificeren in een JSON bestand.

Aangepaste Regels Configureren via een Omgevingsvariabele

De standaardconfiguratie verwacht dat de locatie van het aangepaste regelbestand config/axe-ruleset.json is, relatief ten opzichte van de huidige werkmap.

U kunt deze locatie overschrijven met de AXE_RULESET_PATH omgevingsvariabele of handmatig via de Axe DevTools-configuratie.

Stel de AXE_RULESET_PATH omgevingsvariabele in om de locatie van uw axe-ruleset.json te wijzigen:

AXE_RULESET_PATH=/path/to/your/axe-ruleset.json

Aangepaste Regels Configureren via Axe DevTools Configuratie

Er is een configuratieobject beschikbaar voor het definiëren van een aangepaste regellocatie met behulp van de AxeDevTools.configure methode als u niet met de AXE_RULESET_PATH omgevingsvariabele wilt werken.

Alle hieronder vermelde instellingen zijn optioneel. U kunt de gehele AxeDevTools.configure aanroep weglaten om de originele standaardwaarden te gebruiken.

AxeDevTools.configure do |config|
  # path to json configuration providing custom rules and checks
  # set defaults to "config/axe-ruleset.json"
  config.axe_ruleset_path = "config/axe-ruleset.json"

  # Configure user pre-defined standard rule sets. Custom
  # rules override these rule sets. See https://github.com/dequelabs/axe-core/blob/develop/doc/rule-descriptions.md
  config.rule_set_id = '508'
end

Rapportage-opties

Rapportage-opties Configureren met Axe DevTools Configuratie

De axe-devtools-* gems maken het mogelijk om testresultaten te loggen. Gebruik de AxeDevTools.Configure aanroep om een globale configuratie voor rapportage in te stellen:

AxeDevTools.configure do |config|
  config.output_directory: 'my-results',
  config.test_machine: 'my-server',
  config.test_suite_name: 'Accessibility Tests For Application',
  config.user_agent: 'Headless Chrome'
end

expect(page).to be_audited_for_accessibility.logging_results({
  ui_state: 'Landing Page Load',
})

De rapportageconfiguratie kan de volgende eigenschappen hebben:

Let ook op dat al de bovenstaande opties voor AxeDevTools.configure kunnen worden doorgegeven bij het configureren van de WebDriver naar keuze. Bijvoorbeeld:

require 'axe-devtools-capybara'

AxeCapybara.configure do |config|
 config.axe_config_path = 'config/my-ruleset.json'
end

Zie ook

• JSON-toegankelijkheidsresultaten uploaden naar Axe Reports beschrijft hoe u uw resultaten naar Axe Reports uploadt.
• Een Axe Reports API-sleutel verkrijgen legt uit hoe u een API-sleutel kunt verkrijgen om te beginnen met het gebruik van Axe Reports.
• Rapporten maken en filteren laat zien hoe u toegankelijkheidsrapporten kunt maken in CSV, XML of HTML op basis van uw JSON-toegankelijkheidsresultaten. U kunt uw output ook filteren op ernst met dit hulpmiddel.
• Hoe JSON-resultaten op schijf worden opgeslagen beschrijft de naamgevingsconventies voor JSON-toegankelijkheidsresultaten.
• De CLI gebruiken om toegankelijkheidsresultaten naar Axe Developer Hub te sturen laat zien hoe u uw .json resultatenbestanden kunt uploaden naar Axe Developer Hub.

Gebruiksdienst

Met de gebruiksservice kunt u inzicht krijgen in de gebruikstrends van Axe DevTools binnen uw organisatie.

Standaard is de gebruiksservice ingeschakeld, en de tracking-URL is https://usage.deque.com.

Gebruiksservice-opties Configureren met AxeDevTools Configuratie

De axe-devtools-* gems bieden de mogelijkheid om de gebruiksservice te configureren via een globale configuratie:

AxeDevTools.configure do |config|
  config.setTrackingUrl: 'https://usage.deque.com',
end

De gebruiksservice specifieke configuratie-eigenschappen zijn:

Merk ook op dat al de bovenstaande opties voor AxeDevTools.configure ook kunnen worden doorgegeven bij het configureren van de gewenste WebDriver. Bijvoorbeeld, voor Capybara:

require 'axe-devtools-capybara'

AxeCapybara.configure do |config|
 config.enableTracking = false
end

Opties voor gebruiksservice configureren met omgevingsvariabelen

Daarnaast kunnen opties voor de gebruiksservice worden geconfigureerd via omgevingsvariabelen.