Guide de migration Lighthouse v3

Ce guide s'adresse aux utilisateurs de Lighthouse v2 qui:

• Exécutez Lighthouse depuis Node ou la ligne de commande.
• Appuyez-vous sur la sortie JSON de Lighthouse.

Si vous n'êtes pas concerné par ces cas de figure, votre workflow pour exécuter Lighthouse est presque le même. Consultez l'article Annonce de Lighthouse 3.0 pour un aperçu des nouvelles fonctionnalités et des modifications.

Modifications apportées aux invocations

Lighthouse calcule désormais les performances simulées par défaut, et les paramètres de limitation ont été fortement modifiés.

Options de la CLI

Module de nœud

Dans Lighthouse v3, le module Node accepte les mêmes options de configuration que la CLI. Il s'agit d'une modification destructive dans le sens où bon nombre de ces options ont été ignorées dans la version 2, alors qu'elles vont désormais affecter le fonctionnement de Lighthouse.

const fs = require('fs');
const lighthouse = require('lighthouse');
async function run() {
  // `onlyCategories` was previously only available as a config setting.
  // `output` was previously only available in CLI.
  const flags = {onlyCategories: ['performance'], output: 'html'};
  const html = (await lighthouse('https://google.com/', flags)).report;
  fs.writeFileSync('report.html', html);
}

Modifications des sorties

Nouveau format de niveau supérieur dans la sortie JSON

L'objet JSON renvoyé par Lighthouse v3 contient désormais trois propriétés de premier niveau:

• lhr : résultats des audits. Abréviation de "Résultats Lighthouse". Il s'agissait essentiellement de l'objet de niveau supérieur dans la version 2, mais la version 3 introduit également des modifications destructives de la forme de cet objet. Consultez la section Modifications apportées à l'objet "résultats".
• artifacts Données collectées par Chrome lors de l'audit. Auparavant, ces éléments étaient mêlés aux propriétés de la LHR.
• report Rapport formaté HTML/JSON/CSV sous forme de chaîne.

Modifications apportées à l'objet de résultats

Comme indiqué dans la section Nouveau format de premier niveau dans la sortie JSON, les résultats des audits ne sont plus disponibles via la propriété lhr. Dans la version 2, le contenu de cet objet était essentiellement la sortie JSON de premier niveau. Cependant, la forme de cet objet a changé dans la version 3. Le tableau ci-dessous liste toutes les modifications.

• Si une ligne contient une valeur dans les colonnes v2 et v3, cela signifie que vous devez remplacer toute référence à la propriété v2 dans votre code par l'équivalent v3.
• Lorsqu'une ligne ne comporte aucune valeur dans la colonne v3, la colonne Notes décrit les options disponibles.
• Notez que des éléments tels que ID représentent du texte d'espace réservé.