# lighthouse-ci-krzkaczor
> CLI implementation for running Lighthouse with any CI tool
Latest version **1.10.5** (published 2019-08-09) · MIT license · 0 weekly downloads
## Install
```sh
npm install lighthouse-ci-krzkaczor
pnpm add lighthouse-ci-krzkaczor
yarn add lighthouse-ci-krzkaczor
bun add lighthouse-ci-krzkaczor
```
Provides the command `lighthouse-ci`.
## Health
**Score 15/100 (F)** — status: abandoned.
Positive: no vulnerabilities.
Warnings: low downloads; no types; no esm support.
Negative: abandoned; low maintenance score.
## Facts
| | |
|---|---|
| Version | 1.10.5 |
| Published | 2019-08-09 |
| First published | 2019-08-09 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=6 |
| Dependencies | 9 |
| Unpacked size | 32.1 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 235 |
| Author | Andrea Sonny |
| Maintainers | krzkaczor |
| Keywords | devtools, lighthouse, ci |
## Links
- npm: https://www.npmjs.com/package/lighthouse-ci-krzkaczor
- Repository: https://github.com/andreasonny83/lighthouse-ci
- Homepage: https://github.com/andreasonny83/lighthouse-ci.git#readme
- Issues: https://github.com/andreasonny83/lighthouse-ci.git/issues
- npm.io page: https://npm.io/package/lighthouse-ci-krzkaczor
## Dependencies (9)
- [ora](https://npm.io/package/ora.md) ^3.4.0
- [meow](https://npm.io/package/meow.md) ^5.0.0
- [mkdirp](https://npm.io/package/mkdirp.md) ^0.5.1
- [rimraf](https://npm.io/package/rimraf.md) ^2.6.3
- [lighthouse](https://npm.io/package/lighthouse.md) ^5.1.0
- [tmp-promise](https://npm.io/package/tmp-promise.md) ^2.0.2
- [markdown-table](https://npm.io/package/markdown-table.md) ^1.1.3
- [chrome-launcher](https://npm.io/package/chrome-launcher.md) ^0.11.1
- [update-notifier](https://npm.io/package/update-notifier.md) ^3.0.1
## Recent versions
- 1.10.5 (latest) — 2019-08-09
- 1.10.4 — 2019-08-09
- 1.10.3 — 2019-08-09
- 1.10.2 — 2019-08-09
- 1.10.1 — 2019-08-09
- 1.10.0 — 2019-08-09
## README
# Lighthouse CI
[](https://travis-ci.com/andreasonny83/lighthouse-ci)
[](#contributors)
[](https://badge.fury.io/js/lighthouse-ci)
[](https://www.npmjs.com/package/lighthouse-ci)
[](https://snyk.io/test/github/andreasonny83/lighthouse-ci?targetFile=package.json)
[](http://commitizen.github.io/cz-cli/)
[](https://github.com/xojs/xo)
[](https://codechecks.io)
> A useful wrapper around Google Lighthouse CLI
## Install
```
$ npm install -g lighthouse-ci
```
## Table of Contents
- [Lighthouse CI](#lighthouse-ci)
- [Install](#install)
- [Table of Contents](#table-of-contents)
- [Usage](#usage)
- [CLI](#cli)
- [Lighthouse flags](#lighthouse-flags)
- [Chrome flags](#chrome-flags)
- [Configuration](#configuration)
- [Performance Budget](#performance-budget)
- [Option 1.](#option-1)
- [Option 2.](#option-2)
- [Option 3.](#option-3)
- [How to](#how-to)
- [Test a page that requires authentication](#test-a-page-that-requires-authentication)
- [Wait for post-load JavaScript to execute before ending a trace](#wait-for-post-load-javascript-to-execute-before-ending-a-trace)
- [Contributors](#contributors)
- [License](#license)
## Usage
```sh
lighthouse-ci --help
```
## CLI
```
$ lighthouse-ci --help
Usage
$ lighthouse-ci
Example
$ lighthouse-ci https://example.com
$ lighthouse-ci https://example.com -s
$ lighthouse-ci https://example.com --score=75
$ lighthouse-ci https://example.com --accessibility=90 --seo=80
$ lighthouse-ci https://example.com --accessibility=90 --seo=80 --report=folder
$ lighthouse-ci https://example.com --report=folder --config-path=configs.json
Options
-s, --silent Run Lighthouse without printing report log
--report= Generate an HTML report inside a specified folder
--filename= Specify the name of the generated HTML report file (requires --report)
-json, --jsonReport Generate JSON report in addition to HTML (requires --report)
--config-path The path to the Lighthouse config JSON (read more here: https://github.com/GoogleChrome/lighthouse/blob/master/docs/configuration.md)
--budget-path The path to the Lighthouse budgets config JSON (read more here: https://developers.google.com/web/tools/lighthouse/audits/budgets)
--score= Specify a score threshold for the CI to pass
--performance= Specify a minimal performance score for the CI to pass
--pwa= Specify a minimal pwa score for the CI to pass
--accessibility= Specify a minimal accessibility score for the CI to pass
--best-practice= [DEPRECATED] Use best-practices instead
--best-practices= Specify a minimal best-practice score for the CI to pass
--seo= Specify a minimal seo score for the CI to pass
--budget.. Specify individual budget threshold (if --budget-path not set)
```
## Lighthouse flags
In addition to listed `lighthouse-ci` configuration flags, it is also possible to pass any native `lighthouse` flags.
To see the full list of available flags, please refer to the official [Google Lighthouse documentation](https://github.com/GoogleChrome/lighthouse#cli-options).
eg.
```sh
# Launches browser, collects artifacts, saves them to disk (in `./test-report/`) and quits
$ lighthouse-ci --gather-mode=test-report https://my.website.com
# skips browser interaction, loads artifacts from disk (in `./test-report/`), runs audits on them, generates report
$ lighthouse-ci --audit-mode=test-report https://my.website.com
```
### Chrome flags
In addition of the lighthouse flags, you can also specify extra chrome flags
comma separated.
eg.
```sh
$ lighthouse-ci --chrome-flags=--cellular-only,--force-ui-direction=rtl https://my.website.com
```
eg.
```sh
$ lighthouse-ci --emulated-form-factor desktop --seo 92 https://my.website.com
```
## Configuration
Lighthouse CI allows you to pass a custom Lighthouse configuration file.
Read [Lighthouse Configuration](https://github.com/GoogleChrome/lighthouse/blob/master/docs/configuration.md)
to learn more about the configuration options available.
Just generate your configuration file. For example this `config.json`
```json
{
"extends": "lighthouse:default",
"audits": [
"user-timings",
"critical-request-chains"
],
"categories": {
"performance": {
"name": "Performance Metrics",
"description": "Sample description",
"audits": [
{"id": "user-timings", "weight": 1},
{"id": "critical-request-chains", "weight": 1}
]
}
}
}
```
Then run Lighthouse CI with the `--config-path` flag
```sh
$ lighthouse-ci https://example.com --report=reports --config-path=config.json
```
The generated report inside `reports` folder will follow the custom configuration listed under the `config.json` file.
## Performance Budget
Lighthouse CI allows you to pass a performance budget configuration file (see [Lighthouse Budgets](https://developers.google.com/web/tools/lighthouse/audits/budgets)).
There are several options to pass performance budget configs:
#### Option 1.
Add configurations to your `config.json` file like and use instructions above.
``` json
{
"extends": "lighthouse:default",
"settings": {
"budgets": [
{
"resourceCounts": [
{ "resourceType": "total", "budget": 10 },
...
],
"resourceSizes": [
{ "resourceType": "total", "budget": 100 },
...
]
}
]
}
}
```
#### Option 2.
Generate `budget.json` with content like:
``` json
[
{
"resourceCounts": [
{ "resourceType": "total", "budget": 10 },
...
],
"resourceSizes": [
{ "resourceType": "total", "budget": 100 },
...
]
}
]
```
Then run Lighthouse CI with the `--budget-path` flag
```sh
$ lighthouse-ci https://example.com --report=reports --budget-path=budget.json
```
#### Option 3.
Pass individual parameters via CLI
```sh
$ lighthouse-ci https://example.com --report=reports --budget.counts.total=20 --budget.sizes.fonts=100000
```
## How to
### Test a page that requires authentication
By default `lighthouse-cli` is just creating the report against a specific URL without letting the engineer to interact with the browser.
Sometimes, however, the page for which you want to generate the report, requires the user to be authenticated.
Depending on the authentication mechanism, you can inject extra header information into the page.
```sh
lighthouse-ci https://example.com --extra-headers=./extra-headers.js
```
Where `extra-headers.json` contains:
```js
module.exports = {
Authorization: 'Bearer MyAccessToken',
Cookie: "user=MySecretCookie;"
};
```
### Wait for post-load JavaScript to execute before ending a trace
Your website might require extra time to load and execute all the JavaScript logic.
It is possible to let LightHouse wait for a certain amount of time, before ending a trace,
by providing a `pauseAfterLoadMs` value to a custom configuration file.
eg.
```sh
lighthouse-ci https://example.com --config-path ./config.json
```
Where `config.json` contains:
```json
{
"extends": "lighthouse:default",
"passes": [{
"recordTrace": true,
"pauseAfterLoadMs": 5000,
"networkQuietThresholdMs": 5000
}]
}
```
## Contributors
Thanks goes to these wonderful people ([emoji key](https://github.com/kentcdodds/all-contributors#emoji-key)):
This project follows the [all-contributors](https://github.com/kentcdodds/all-contributors) specification. Contributions of any kind welcome!
## License
MIT
---
Created with 🦄 by [andreasonny83](https://about.me/andreasonny83)
---
_Source: https://npm.io/package/lighthouse-ci-krzkaczor · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
