jeroen-g/lighthouse

Google Lighthouse项目的接口

v0.2 2019-01-25 12:14 UTC

This package is auto-updated.

Last update: 2024-09-21 00:09:15 UTC


README

本包提供用于Google Lighthouse的PHP接口。

以下是一个示例,它将执行默认的Lighthouse审计并将结果存储在report.json文件中(您可以使用Lighthouse Viewer打开报告)

use Dzava\Lighthouse\Lighthouse;

(new Lighthouse())
    ->setOutput('report.json')
    ->accessibility()
    ->bestPractices()
    ->performance()
    ->pwa()
    ->seo()
    ->audit('http://example.com');

输出

setOutput方法接受一个额外的参数,可以用来指定格式(json、html)。如果省略格式参数,则将使用文件扩展名来确定输出格式。如果文件扩展名未指定任何接受的格式,则将使用json格式。

您可以通过传递一个数组作为第二个参数来输出json和html报告。对于示例,以下代码将创建两个报告:example.report.htmlexample.report.json

use Dzava\Lighthouse\Lighthouse;

(new Lighthouse())
    ->setOutput('example', ['html', 'json'])
    ->performance()
    ->audit('http://example.com');

使用自定义配置

您可以使用withConfig方法提供自己的配置文件。

use Dzava\Lighthouse\Lighthouse;

(new Lighthouse())
    ->withConfig('./my-config.js')
    ->audit('http://example.com');

自定义node和Lighthouse路径

如果您需要手动设置这些路径,可以通过调用setNodeBinarysetLighthousePath方法来实现。

use Dzava\Lighthouse\Lighthouse;

(new Lighthouse())
    ->setNodeBinary('/usr/bin/node')
    ->setLighthousePath('./lighthouse.js')
    ->audit('http://example.com');

向Chrome传递标志

使用setChromeFlags方法向Chrome实例传递任何标志。

use Dzava\Lighthouse\Lighthouse;

(new Lighthouse())
    // these are the default flags used
    ->setChromeFlags(['--headless', '--disable-gpu', '--no-sandbox'])
    ->audit('http://example.com');