laravel-google-lighthouse
This package is based on octoper/lighthouse-php.
This package provides a wrapper for Google Lighthouse to audit the quality of web pages with Laravel.
Installation
You can install the package via Composer:
composer require logiek/laravel-google-lighthouse
The package will automatically register itself. Optionally you can publish the config file with:
php artisan vendor:publish --provider="Logiek\GoogleLighthouse\GoogleLighthouseServiceProvider" --tag="config"
Usage
The following example will perform the default Google Lighthouse audit and store the result in the given path.
use Logiek\GoogleLighthouse\GoogleLighthouse;
(new GoogleLighthouse())
->setOutput('report.html')
->audit('http://example.com');
Categories
Per default the audit will run all the available categories. To run the audit for a specified list of categories you can specify the categories that the audit should run as shown in the example below, any missing category will be skipped.
The available categories are: performance, pwa, bestPractices, accessibility and seo.
use Logiek\GoogleLighthouse\GoogleLighthouse;
(new GoogleLighthouse())
->performance()
->pwa()
->setOutput('report.html')
->audit('http://example.com');
Output
The setOutput method accepts a second argument that can be used to specify the format (based on the configuration). 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, an exception will be thrown.
For the example the following code will create two reports example.report.html and example.report.json.
use Logiek\GoogleLighthouse\GoogleLighthouse;
(new GoogleLighthouse())
->setOutput('example', ['html', 'json'])
->audit('http://example.com');
Options
The setOption method can be used to specify certain options to fine tune Google Lighthouse to your liking.
use Logiek\GoogleLighthouse\GoogleLighthouse;
(new GoogleLighthouse())
->setOption('--throttling.cpuSlowdownMultiplier', 4)
->setOutput('report.html')
->audit('http://example.com');
Changelog
Please see the CHANGELOG for more information about recent changes.
License
This project is open-sourced software licensed under the MIT license.
6 Jun 5, 2023
765 Dec 30, 2022
4 Nov 23, 2022
5 Jul 22, 2022
6 May 31, 2023
41 Nov 19, 2022
14 Dec 15, 2022
2 Apr 24, 2022
4 Sep 27, 2022
16 Nov 11, 2022
103 Dec 19, 2022
4 Dec 15, 2019
4.4k Jan 4, 2023
4 Jan 4, 2022
837 Dec 14, 2022
5 Sep 7, 2022
25 Apr 30, 2021
2 Dec 15, 2022
7 Nov 29, 2022