Testare le pagine con CLI

Quando si utilizza la modalità di input URI del CLI, sono disponibili diverse opzioni aggiuntive per modificare l'ambito e l'insieme di regole di un test. Ad esempio, il codice seguente escluderà l'intestazione e il piè di pagina da un test e disabiliterà la regola del contrasto dei colori:

axe http://example.com --exclude footer,header --disable color-contrast

Opzioni

-a, --axe-source <path>

Percorso verso un axe.js file alternativo. La maggior parte degli utenti non ha bisogno di questa opzione. È destinata a casi d'uso avanzati come testare una versione specifica o aggiornata di axe-core.

--axe-devhub-api-key <your-API-key>

Specifica la chiave API del proprio account Axe per inviare i risultati di accessibilità ad Axe Developer Hub. I risultati sono inviati al progetto associato con l'ID progetto specificato (specificato con l'opzione --axe-devhub-project-id della riga di comando) dopo che il test è stato completato. Sia --axe-devhub-api-key che --axe-devhub-project-id sono necessari per inviare i risultati ad Axe Developer Hub. Vedi Utilizzare il CLI per Inviare i Risultati di Accessibilità ad Axe Developer Hub per ulteriori informazioni.

--axe-devhub-project-id <your-project-ID>

Specifica l'ID progetto di Axe Developer Hub per ricevere i risultati dei test di accessibilità. Sia --axe-devhub-api-key che --axe-devhub-project-id sono necessari per inviare i risultati ad Axe Developer Hub. Vedi Utilizzare il CLI per Inviare i Risultati di Accessibilità ad Axe Developer Hub per ulteriori informazioni.

--axe-devhub-server-url <url>

Specifica l'URL del server Axe Developer Hub. Predefinito: https://axe.deque.com. Equivalente alla variabile d'ambiente AXE_DEVHUB_SERVER_URL . Vedi Utilizzare il CLI per Inviare i Risultati di Accessibilità ad Axe Developer Hub per ulteriori informazioni.

-c, --custom <path>

Specifica un insieme di regole personalizzato da utilizzare. Vedi Insiemi di Regole Personalizzati per dettagli su come generare un file di insiemi di regole.

--chrome-options [options]

Elenco separato da virgole di switch della riga di comando di Chrome da passare al browser. Ad esempio:

axe http://example.com --chrome-options="some-switch,some-other-switch"

--chrome-path <path>

Percorso assoluto dell'eseguibile del browser Chrome. Usalo per puntare axe a un'installazione specifica di Chrome quando il browser predefinito non può essere trovato o è necessario eseguirlo su una versione particolare.

--chromedriver-path <path>

Percorso assoluto dell'eseguibile ChromeDriver. ChromeDriver è un binario separato dal browser Chrome; funge da ponte che traduce i comandi WebDriver di axein istruzioni che Chrome può eseguire.

-d, --dir <path>

La directory in cui il file dei risultati in formato JSON viene salvato. Senza questo flag (o --save o --report), non viene scritto alcun file e i risultati sono stampati sul terminale come un riepilogo leggibile per l'uomo. Vedi anche -j, --stdout se hai bisogno di un output leggibile dalla macchina senza scrivere su disco.

-l, --disable <list>

Elenco separato da virgole degli ID delle regole da disabilitare. Vedi le descrizioni delle regole di axe-core per un elenco completo degli ID delle regole.

axe http://example.com --disable color-contrast,duplicate-id

-e, --exclude <list>

Elenco separato da virgole di selettori CSS per elementi da escludere dal test. Ad esempio:

# Exclude by element type
axe http://example.com --exclude footer,header

# Exclude by class or ID
axe http://example.com --exclude ".ad-banner,#cookie-notice"

# Exclude by attribute
axe http://example.com --exclude "[aria-hidden=true]"

-f, --format <value>

Formato del report generato. Richiede -r, --report. Vedi Creare e Filtrare i Report per dettagli su cosa contiene ogni formato. Predefinito: html.

axe http://example.com --report ./reports --format html+junit+csv

--filter <list>

Elenco separato da virgole dei tipi di risultati da includere nell'output CSV. Verranno visualizzati solo i tipi specificati; tutti gli altri sono esclusi. I valori validi sono passes, violations, incomplete, e inapplicable. Necessita di --format csv.

axe reporter ./axe-reports/json/ --format=csv --filter passes,inapplicable

-i, --include <list>

Elenco separato da virgole di selettori CSS. Quando specificato, axe testa solo gli elementi corrispondenti, e tutto il resto sulla pagina viene ignorato. Questo è altamente restrittivo e la maggior parte degli utenti dovrebbe utilizzare -e, --exclude invece. Utilizzare --include solo quando si desidera isolare il test a un componente specifico, ad esempio durante il debug mirato o i controlli CI a livello di componente.

# Test only the main navigation
axe http://example.com --include nav

# Test only elements with a specific class or ID
axe http://example.com --include ".my-widget,#signup-form"

# Test only elements with a specific attribute
axe http://example.com --include "[data-testid=checkout]"

-j, --stdout

Scrivi i risultati completi come JSON legibile da macchine su stdout anziché il riepilogo leggibile dall'uomo del terminale. Tutto l'altro output è silenziato. Utilizza questo quando si trasmettono i risultati a un altro programma.

--load-delay <n>

Imposta quanto tempo (millisecondi) axe aspetterà dopo il caricamento della pagina prima di eseguire l'audit (predefinito: 0).

--no-git-data

Non riportare le informazioni sul ramo Git e il commit quando si inviano i risultati a Axe Developer Hub. Vedi L'utilizzo della CLI per inviare i risultati di accessibilità a Axe Developer Hub.

--no-reporter

Sopprime l'output del riepilogo delle violazioni (ID delle regole, conteggi, selettori interessati e URL di aiuto) senza silenziare tutto. Messaggi di progresso e risultati scritti su disco tramite --save, --dir, o --report non sono interessati. Principalmente utile nelle pipeline CI in cui si salvano i risultati su un file e si utilizza --exit per il segnalamento pass/fail e non si desiderano dettagli verbosi delle violazioni nel registro di compilazione. Per il silenzio completo con output di risultati JSON, utilizzare -j, --stdout invece.

-q, --exit

Esci con 1 codice di errore se uno dei test di accessibilità fallisce.

-r, --report <output-dir>

La directory in cui viene scritto il rapporto formattato. Funziona con -f, --format per controllare il formato di output (HTML per impostazione predefinita). Utilizza questo quando si desidera un rapporto leggibile dall'uomo o interpretabile dalla macchina anziché il JSON grezzo, ad esempio un rapporto HTML da condividere con gli stakeholder o un file JUnit XML per l'integrazione CI. Per l'output JSON grezzo, utilizzare -d, --dir invece.

--rules <list>

Elenco separato da virgole di ID di regole da eseguire. Solo le regole specificate vengono controllate; tutte le altre vengono saltate. Vedi la descrizione delle regole di axe-core per un elenco completo degli ID delle regole.

axe http://example.com --rules color-contrast,duplicate-id

-s, --save [filename]

Salva i risultati come un file JSON nella directory corrente. Il nome del file è facoltativo; se omesso, il file verrà nominato axe-result.json. Per salvare in una directory specifica invece, utilizzare -d, --dir.

--show-errors

Quando axe incontra un errore di runtime (come un fallimento nell'inizializzazione o un'eccezione lanciata durante l'esecuzione), normalmente stampa un breve messaggio di errore su stderr. Questo flag aggiunge l'intero stack trace a quell'output. Non influisce su come vengono riportate le violazioni di accessibilità. Utilizza questo quando si esegue il debug di un --axe-source file personalizzato, la diagnosi di guasti imprevisti in CI o la raccolta di informazioni per una segnalazione di bug.

-t, --tags <list>

Elenco separato da virgole di tag per filtrare quali regole vengono eseguite. Solo le regole corrispondenti ad almeno uno dei tag specificati sono incluse. Vedi la documentazione sui tag di axe-core per un elenco completo dei tag disponibili.

axe http://example.com --tags wcag2a,wcag2aa

--timer

Stampa tre misurazioni temporali nel terminale dopo ogni esecuzione dei test:

• tempo di caricamento pagina axe: quanto tempo ha impiegato la pagina a caricarsi nel browser
• tempo di esecuzione di axe-core: quanto tempo ha impiegato axe-core ad analizzare la pagina
• Tempo totale del test: tempo trascorso end-to-end per l'esecuzione

Utilizza questo per diagnosticare i test lenti. Ad esempio, usa questa opzione per determinare se il tempo viene speso aspettando che la pagina si carichi o nell'analisi di Axe, o per investigare perché un'esecuzione sta raggiungendo --page-timeout o --script-timeout limiti.

-v, --verbose

Quando vengono trovate delle violazioni, stampa un blocco JSON dopo il riepilogo delle violazioni contenente:

• **Motore di Test**: la versione di axe-core utilizzata
• **Ambiente di Test**: user agent del browser, larghezza e altezza della viewport, e orientamento dello schermo
• **Test Runner**: il nome del runner

Nota che questo output appare solo quando vengono rilevate violazioni. Se una pagina non presenta violazioni, i metadati non vengono stampati. Usa queste informazioni quando hai bisogno di confermare esattamente quale versione di axe-core è stata eseguita, verificare le impostazioni della viewport, o includere i dettagli sull'ambiente in un report di bug.

Opzioni di configurazione

Le seguenti opzioni controllano il comportamento del browser e il timing dei test. A differenza delle opzioni sopra, queste persistono tra le esecuzioni CLI; impostandole una volta, il valore viene salvato in un file di preferenze utilizzato per tutte le esecuzioni future. Possono essere impostate anche in modo interattivo usando axe config-selenium.

Per tutti i dettagli, vedi Opzioni di configurazione.