octoper / lighthouse-php
Interface for the Google Lighthouse
Fund package maintenance!
octoper
Requires
- php: ^7.4
- symfony/process: ^5.1
Requires (Dev)
- dms/phpunit-arraysubset-asserts: ^0.2.0
- friendsofphp/php-cs-fixer: ^2.16
- pestphp/pest: ^0.1.5
- phpunit/phpunit: ^9.0
- vimeo/psalm: ^3.11
This package is auto-updated.
Last update: 2024-10-09 00:49:52 UTC
README
This package is a fork of dzava/lighthouse-php
This package provides a PHP interface for Google Lighthouse.
Installation
You can install the package via composer:
composer require octoper/lighthouse-php
Usage
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://example.com');
Output
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://example.com');
Using a custom config
You can provide your own configuration file using the withConfig
method.
use Octoper\Lighthouse\Lighthouse; (new Lighthouse()) ->withConfig('./my-config.js') ->audit('http://example.com');
Customizing node and Lighthouse paths
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://example.com');
Passing flags to Chrome
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://example.com');
Testing
composer test
Security
If you discover any security related issues, please email me@octoper.me instead of using the issue tracker.
Credits
License
The MIT License (MIT). Please see License File for more information.