This package is a fork of dzava/lighthouse-php
This package provides a PHP interface for Google Lighthouse.
You can install the package via composer:
composer require octoper/lighthouse-php
Here's an example that will perform the default Lighthouse audits and store the result in report.json
(You can use the Lighthouse Viewer to open the report):
use Octoper\Lighthouse\Lighthouse;
(new Lighthouse())
->setOutput('report.json')
->accessibility()
->bestPractices()
->performance()
->pwa()
->seo()
->audit('http:https://example.com');
The setOutput
method accepts a second argument that can be used to specify the format (json,html).
If the format argument is missing then the file extension will be used to determine the output format.
If the file extension does not specify an accepted format, then json will be used.
You can output both the json and html reports by passing an array as the second argument. For the example
the following code will create two reports example.report.html
and example.report.json
.
use Octoper\Lighthouse\Lighthouse;
(new Lighthouse())
->setOutput('example', ['html', 'json'])
->performance()
->audit('http:https://example.com');
You can provide your own configuration file using the withConfig
method.
use Octoper\Lighthouse\Lighthouse;
(new Lighthouse())
->withConfig('./my-config.js')
->audit('http:https://example.com');
If you need to manually set these paths, you can do this by calling the setNodeBinary
and setLighthousePath
methods.
use Octoper\Lighthouse\Lighthouse;
(new Lighthouse())
->setNodeBinary('/usr/bin/node')
->setLighthousePath('./lighthouse.js')
->audit('http:https://example.com');
Use the setChromeFlags
method to pass any flags to the Chrome instance.
use Octoper\Lighthouse\Lighthouse;
(new Lighthouse())
// these are the default flags used
->setChromeFlags(['--headless', '--disable-gpu', '--no-sandbox'])
->audit('http:https://example.com');
composer test
If you discover any security related issues, please email [email protected] instead of using the issue tracker.
The MIT License (MIT). Please see License File for more information.