Lighthouse v3 移行ガイド

このガイドは、以下に該当する Lighthouse v2 ユーザーを対象としています。

• Node またはコマンドラインから、Lighthouse を実行します。
• Lighthouse の JSON 出力を利用する。

上記に当てはまらない場合、Lighthouse を実行するためのワークフローはほぼ同じです。新機能と変更点の概要については、Lighthouse 3.0 の発表をご覧ください。

呼び出しの変更

Lighthouse ではパフォーマンスのシミュレーションがデフォルトで計算されるようになりました。また、スロットリングの設定も大幅に変更されました。

CLI フラグ

ノード モジュール

Lighthouse v3 では、Node モジュールで CLI と同じ構成オプションを使用できます。これらのオプションの多くが v2 では無視されましたが、実際には 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);
}

出力の変更

JSON 出力の新しいトップレベル形式

Lighthouse v3 が返す JSON オブジェクトには、次の 3 つのトップレベル プロパティが含まれるようになりました。

• lhr。監査の結果。「Lighthouse の結果」の略称。これは基本的に v2 ではトップレベルのオブジェクトですが、v3 ではオブジェクトの形状にも互換性を破る変更が行われています。結果オブジェクトの変更をご覧ください。
• artifacts。監査中に Chrome から収集されたデータ。これは以前、LHR の特性と混在していました。
• report。フォーマットされたレポートの HTML/JSON/CSV を文字列として返します。

結果オブジェクトの変更

JSON 出力の新しいトップレベル形式で説明したように、監査の結果は lhr プロパティを介して取得することはできません。v2 では、このオブジェクトの内容は基本的にトップレベルの JSON 出力でした。ただし、このオブジェクトの形状は v3 で変更されています。次の表に、すべての変更内容を示します。

• v2 列と v3 列の両方に値がある行の場合、コード内の v2 プロパティへの参照をすべて v3 と同等の値に置き換える必要があります。
• 行の [v3] 列に値がない場合は、[Notes] 列にオプションが記載されています。
• ID などの項目はプレースホルダ テキストを表します。