Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/spatie/lighthouse-php
Run Google Lighthouse using PHP
https://github.com/spatie/lighthouse-php
best-practices google lighthouse performance php seo
Last synced: 7 days ago
JSON representation
Run Google Lighthouse using PHP
- Host: GitHub
- URL: https://github.com/spatie/lighthouse-php
- Owner: spatie
- License: mit
- Created: 2022-11-04T09:05:53.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-04-29T11:33:21.000Z (9 months ago)
- Last Synced: 2024-05-01T11:46:07.002Z (9 months ago)
- Topics: best-practices, google, lighthouse, performance, php, seo
- Language: PHP
- Homepage: https://spatie.be/docs/lighthouse-php
- Size: 729 KB
- Stars: 223
- Watchers: 10
- Forks: 22
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
- Support: docs/support-us.md
Awesome Lists containing this project
README
# Run Google Lighthouse using PHP
[](https://packagist.org/packages/spatie/lighthouse-php)
[](https://github.com/spatie/lighthouse-php/actions/workflows/run-tests.yml)
[](https://packagist.org/packages/spatie/lighthouse-php)
[Google Lighthouse](https://developer.chrome.com/docs/lighthouse/overview/) is an open-source, automated tool for improving the quality of web pages. It has audits for performance, accessibility, progressive web apps, SEO and more.
This package makes it easy to run Lighthouse using PHP. Here's an example on how to get the scores of the five categories of audits that Lighthouse offers.
```php
use Spatie\Lighthouse\Lighthouse;
// returns an instance of Spatie\Lighthouse\LighthouseResult
$result = Lighthouse::url('https://example.com')->run();
$result->scores(); // returns an array like this one:
/*
* [
* 'performance' => 98,
* 'accessibility' => 83,
* 'best-practices' => 90,
* 'seo' => 92,
* 'pwa' => 43,
* ]
*/
```
It's easy to configure various options:
```php
use Spatie\Lighthouse\Lighthouse;
use Spatie\Lighthouse\Enums\Category;
Lighthouse::url('https://example.com')
->userAgent('My user agent')
->headers(['MyExtraHeader' => 'HeaderValue'])
->categories(Category::Performance, Category::Accessibility)
->throttleCpu()
->run();
```
Here's how you can get the results of an audit:
```php
$result->audit('first-contentful-paint') // returns this array
/*
* [
* 'id' => 'first-contentful-paint'
* 'title' => 'First Contentful Paint'
* 'score' => 0.98
* 'scoreDisplayMode' => 'numeric'
* 'numericValue' => 1262.95
* 'numericUnit' => 'millisecond'
* 'displayValue' => '1.3 s'
* ]
*/
```
You can also write a full HTML report to disk:
```php
$result->saveHtml($pathToReport)
```
## Support us
[
](https://spatie.be/github-ad-click/lighthouse-php)
We invest a lot of resources into creating [best in class open source packages](https://spatie.be/open-source). You can support us by [buying one of our paid products](https://spatie.be/open-source/support-us).
We highly appreciate you sending us a postcard from your hometown, mentioning which of our package(s) you are using. You'll find our address on [our contact page](https://spatie.be/about-us). We publish all received postcards on [our virtual postcard wall](https://spatie.be/open-source/postcards).
## Documentation
All documentation is available [on our documentation site](https://spatie.be/docs/lighthouse-php).
## Testing
```bash
composer test
```
## Changelog
Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.
## Contributing
Please see [CONTRIBUTING](https://github.com/spatie/.github/blob/main/CONTRIBUTING.md) for details.
## Security Vulnerabilities
Please review [our security policy](../../security/policy) on how to report security vulnerabilities.
## Credits
- [Freek Van der Herten](https://github.com/freekmurze)
- [All Contributors](../../contributors)
This package contains code copied from [Laravel's `Arr` class](https://github.com/laravel/framework/blob/9.x/src/Illuminate/Collections/Arr.php).
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.