Istruzioni per WebdriverIO e TypeScript

Nella cartella principale del tuo ambiente di test, installa il pacchetto @axe-core/watcher e tutte le sue dipendenze utilizzando npm o il tuo gestore di pacchetti preferito (ad esempio, yarn o pnpm).

npm install --save-dev @axe-core/watcher

Nei tuoi file di test, importa la funzione wdioConfig(), la funzione wrapWdio() e la classe WdioController da @axe-core/watcher/wdio:

import {
  wdioConfig,
  wrapWdio,
  WdioController
} from '@axe-core/watcher/wdio'

Nel tuo codice di configurazione del test (tipicamente in un blocco before o beforeAll), avvolgi qualsiasi codice esistente per la creazione di un'istanza di browser con una chiamata a wdioConfig(), fornendo la tua chiave API:

const ACCESSIBILITY_API_KEY = process.env.ACCESSIBILITY_API_KEY
const PROJECT_ID = process.env.PROJECT_ID
const SERVER_URL = process.env.SERVER_URL

const browser = await remote(
  wdioConfig({
    axe: {
      apiKey: ACCESSIBILITY_API_KEY,
      projectId: PROJECT_ID,
      serverURL: SERVER_URL
    }
  })
)

Assicurati di impostare ACCESSIBILITY_API_KEY e PROJECT_ID nel tuo ambiente con la tua chiave API personale (trovata nel tuo account axe, nella scheda **API KEYS**) e con il tuo ID progetto (mostrato in cima a queste istruzioni quando hai creato il tuo progetto o disponibile nella pagina Progetti selezionando **Configura progetto** sotto **Impostazioni**). Se la tua organizzazione utilizza una versione regionale, cloud privata o un'istanza Axe Developer Hub on-premises, imposta anche SERVER_URL all'URL base di quella istanza (ad esempio, https://axe-eu.deque.com); altrimenti, ometti SERVER_URL e verrà utilizzato il valore predefinito https://axe.deque.com.

Una volta che hai un'istanza di browser, crea un'istanza della classe WdioController:

const controller = new WdioController(browser);

Avvolgi la tua istanza browser con la funzione wrapWdio(), fornendo l'istanza browser e l'istanza controller:

wrapWdio(browser, controller)

Infine, assicurati che tutti i risultati dei test da axe Watcher siano svuotati. Per farlo, aggiungi il seguente blocco di codice al tuo codice di smontaggio del test (tipicamente in un blocco afterEach):

afterEach(async () => {
  await controller.flush()
})