Testare le pagine con CLI

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

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

Opzioni

-a, --axe-source <path>

Percorso verso un file axe.js alternativo. La maggior parte degli utenti non ha bisogno di questa opzione. È pensata per casi d'uso avanzati, come i test di una versione specifica o corretta di axe-core.

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

Specifica la chiave API dell'Axe Account da utilizzare per inviare i risultati dell'accessibilità a Axe Developer Hub. I risultati vengono inviati al progetto associato con l'ID del progetto specificato (specificato con l'opzione della riga di comando --axe-devhub-project-id) dopo che il test è stato completato. Sia --axe-devhub-api-key che --axe-devhub-project-id sono necessari per inviare i risultati a Axe Developer Hub. Vedi Utilizzo della CLI per inviare i risultati di accessibilità ad Axe Developer Hub per maggiori informazioni.

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

Specifica l'ID del 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 a Axe Developer Hub. Vedi Utilizzo della CLI per inviare i risultati di accessibilità ad Axe Developer Hub per maggiori informazioni.

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

Specifica l'URL del server di Axe Developer Hub. Predefinito a https://axe.deque.com. Equivale alla variabile d'ambiente AXE_DEVHUB_SERVER_URL. Vedi Utilizzo della CLI per inviare i risultati di accessibilità ad Axe Developer Hub per maggiori informazioni.

-c, --custom <path>

Specifica un set di regole personalizzato da utilizzare. Vedi Set di regole personalizzati per i dettagli su come generare un file di set di regole.

--chrome-options [options]

Elenco separato da virgole di opzioni 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 all'eseguibile del browser Chrome. Usa questo per indirizzare axe verso un'installazione specifica di Chrome quando il browser predefinito non può essere trovato, o se hai bisogno di eseguire una versione particolare.

--chromedriver-path <path>

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

-d, --dir <path>

La directory in cui viene salvato il file dei risultati in formato JSON. Senza questa flag (o --save o --report), nessun file viene scritto e i risultati sono stampati nel terminale come un sommario leggibile da umani. Vedi anche -j, --stdout se hai bisogno di un output leggibile da una macchina senza scrivere su disco.

-l, --disable <list>

Elenco di ID di regole separati da virgola da disabilitare. Vedi il 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 rapporto generato. Richiede -r, --report. Vedi Creare e filtrare i rapporti per i 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. Solo i tipi specificati appariranno; tutti gli altri sono esclusi. I valori validi sono passes, violations, incomplete e inapplicable. Richiede --format csv.

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

-i, --include <list>

Elenco separato da virgole dei selettori CSS. Quando specificato, axe testa solo gli elementi corrispondenti, e tutto il resto sulla pagina viene ignorato. Questa è una restrizione notevole e la maggior parte degli utenti dovrebbe utilizzare -e, --exclude invece. Usa --include solo quando vuoi isolare i test a un componente specifico, come durante il debug mirato o 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 leggibile dalla macchina su stdout invece del sommario leggibile dall'utente nel terminale. Tutto l'altro output è silenziato. Usare questo quando si inviano 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 risultati a Axe Developer Hub. Vedi Utilizzo della CLI per inviare i risultati di accessibilità ad Axe Developer Hub.

--no-reporter

Sopprime l'output del sommario delle violazioni (ID delle regole, conteggi, selettori interessati e URL di aiuto) senza silenziare tutto. I messaggi di progresso e i risultati scritti su disco tramite --save, --dir o --report non sono interessati. È principalmente utile in CI pipeline dove si stanno salvando i risultati in un file e si usa --exit per la segnalazione di pass/fail e non si vogliono dettagli sulle violazioni verbosi nel log di compilazione. Per un silenzio totale con l'output dei risultati JSON, usa -j, --stdout invece.

-q, --exit

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

-r, --report <output-dir>

La directory in cui è scritto il rapporto formattato. Funziona con -f, --format per controllare il formato di output (HTML per impostazione predefinita). Usa questo quando vuoi un rapporto leggibile da umani o analizzabile da una macchina invece di un JSON grezzo, ad esempio, un rapporto HTML da condividere con le parti interessate o un file XML JUnit per l'integrazione CI. Per l'output JSON grezzo, usa -d, --dir invece.

--rules <list>

Elenco di ID delle regole da eseguire separato da virgole. Solo le regole specificate vengono verificate; tutte le altre vengono saltate. Vedi il descrizioni 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 file JSON nella directory corrente. Il nome del file è facoltativo; se omesso, il file è denominato axe-result.json. Per salvare in una directory specifica, usa -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. Questa flag aggiunge l'intera traccia dello stack a quell'output. Non influisce su come vengono riportate le violazioni dell'accessibilità. Usalo durante il debug di un file --axe-source personalizzato, diagnosticando fallimenti inattesi in CI o raccogliendo informazioni per un rapporto di bug.

-t, --tags <list>

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

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

--timer

Stampa tre misurazioni temporali sul terminale dopo ogni esecuzione del test:

• Tempo di caricamento della pagina di Axe: quanto tempo ci è voluto per caricare la pagina nel browser
• Tempo di esecuzione di axe-core: quanto tempo ha impiegato axe-core per analizzare la pagina
• Tempo totale del test: tempo totale trascorso dall'inizio alla fine dell'esecuzione

Utilizza questo per diagnosticare test lenti. Ad esempio, usa questa opzione per determinare se il tempo è speso in attesa che la pagina si carichi o nell'analisi di Axe, o per indagare sul perché un'operazione raggiunge i limiti di --page-timeout o --script-timeout.

--universal-best-practices

Registra bestPracticesEnabled=true nei metadati del formato di output universale. Richiede --format universal.

--universal-ruleset <id>

Specifica l'ID del set di regole da registrare nei metadati del formato di output universale. Predefinito a wcag2.1. Richiede --format universal.

-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 del viewport, e orientamento dello schermo
• Esecutore di Test: il nome del driver

Nota che questo output appare solo quando vengono rilevate violazioni. Se una pagina non ha violazioni, i metadati non vengono stampati. Usalo quando hai bisogno di confermare esattamente quale versione di axe-core è stata eseguita, verificare le impostazioni del viewport o includere i dettagli dell'ambiente in un rapporto di bug.

Opzioni di configurazione

Le seguenti opzioni controllano il comportamento del browser e i tempi di esecuzione dei test. A differenza delle opzioni precedenti, queste persistono tra le esecuzioni del CLI; impostarle una volta salva il valore in un file di preferenze usato per tutte le esecuzioni future. Possono anche essere impostate interattivamente usando axe config-selenium.

Per dettagli completi, vedi Opzioni di configurazione.