lighthouse-php

KO | EN

gitlite — search

#javascript #python #hacktoberfest #react #typescript #go #android #deep-learning #macos #java #kubernetes #awesome-list #mcp #open-source

(★ 40)

A PHP interface for Google Lighthouse

lighthouse-php Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Lighthouse

This package provide a php interface for [Google Lighthouse](https://github.com/GoogleChrome/lighthouse).

## Installation

You can install the package via composer: `composer require dzava/lighthouse`

Install Lighthouse `yarn add lighthouse`. Last tested with Lighthouse v8.5.1.

## 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](https://googlechrome.github.io/lighthouse/viewer/) to open the report):

```php
use Dzava\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`.

```php
use Dzava\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.
```php
use Dzava\Lighthouse\Lighthouse;

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

You can also pass a php array to the `withConfig` method containing your configuration.
```php
use Dzava\Lighthouse\Lighthouse;

(new Lighthouse())
    ->withConfig([
         'extends' => 'lighthouse:default',
         'settings' => [
             'onlyCategories' => ['accessibility'],
         ],
     ])
    ->audit('http://example.com');
```
**Note:** in order to use an array to specify the configuration options, php needs to be able to [create and move](https://www.php.net/manual/en/function.tmpfile.php) temporary files.

Details about the configuration options can be found [here](https://github.com/GoogleChrome/lighthouse/blob/master/docs/configuration.md)

### Customizing node and Lighthouse paths

If you need to manually set these paths, you can do this by calling the `setNodeBinary` and `setLighthousePath` methods.

```php
use Dzava\Lighthouse\Lighthouse;

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

### Passing flags to Chrome
Use the `setChromeFlags` method to pass any flags to the Chrome instance.
```php
use Dzava\Lighthouse\Lighthouse;

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

## Troubleshooting

#### Audit of 'url' failed
Use the following snippet to check why the audit fails.

```php
require "./vendor/autoload.php";

use Dzava\Lighthouse\Exceptions\AuditFailedException;
use Dzava\Lighthouse\Lighthouse;

try {
(new Lighthouse())
    ->performance()
    ->audit('http://example.com');
} catch(AuditFailedException $e) {
    echo $e->getOutput();
}
```

lighthouse-php

lighthouse-php Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

lighthouse-php

lighthouse-php Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README