# @marco-eckstein/lighthouse-ignore

> A wrapper around Lighthouse that allows you to ignore some audits

Latest version **0.2.0** (published 2018-09-22) · MIT license · 0 weekly downloads

## Install

```sh
npm install @marco-eckstein/lighthouse-ignore
pnpm add @marco-eckstein/lighthouse-ignore
yarn add @marco-eckstein/lighthouse-ignore
bun add @marco-eckstein/lighthouse-ignore
```

Provides the command `lighthouse-ignore`.

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.2.0 |
| Published | 2018-09-22 |
| First published | 2018-09-09 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 8 |
| Unpacked size | 22.2 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Marco Eckstein |
| Maintainers | marco-eckstein |
| Keywords | lighthouse, ignore, baseline, audit |

## Links

- npm: https://www.npmjs.com/package/@marco-eckstein/lighthouse-ignore
- Repository: https://github.com/marco-eckstein/lighthouse-ignore
- Homepage: https://github.com/marco-eckstein/lighthouse-ignore#readme.md
- Issues: https://github.com/marco-eckstein/lighthouse-ignore/issues
- npm.io page: https://npm.io/package/@marco-eckstein/lighthouse-ignore

## Dependencies (8)

- [core-js](https://npm.io/package/core-js.md) ^2.5.4
- [temp-dir](https://npm.io/package/temp-dir.md) ^1.0.0
- [cli-color](https://npm.io/package/cli-color.md) ^1.3.0
- [commander](https://npm.io/package/commander.md) ^2.17.1
- [dateformat](https://npm.io/package/dateformat.md) ^3.0.3
- [lighthouse](https://npm.io/package/lighthouse.md) 3.0.3
- [chrome-launcher](https://npm.io/package/chrome-launcher.md) ^0.10.2
- [source-map-support](https://npm.io/package/source-map-support.md) ^0.5.9

## Recent versions

- 0.2.0 (latest) — 2018-09-22
- 0.1.0 — 2018-09-09

## README

[![npm version](https://badge.fury.io/js/%40marco-eckstein%2Flighthouse-ignore.svg)](https://badge.fury.io/js/%40marco-eckstein%2Flighthouse-ignore)

A wrapper around [Lighthouse](https://www.npmjs.com/package/lighthouse) 3.0.3 that allows you to
ignore some audits.

You can configure it to completely ignore audits and/or define a baseline of audits that allows you to
tolerate failures, including thresholds for performance scores.

# Requirements

Lighthouse requires [Google Chrome](https://www.google.de/chrome/).

# Usage

## Configuration

Lighthouse-Ignore is configured with a JSON file. Its default path is `./lighthouse-ignore-config.json`.
[lighthouse-ignore-config.ts](src/main/lighthouse-ignore-config.ts) defines and documents its schema.

Example:

```
{
    "chromeOptions": {
    },
    "lighthouseOptions": {
        "output": "json"
    },
    "ignored": [
        {
            "auditId": "geolocation-on-start",
            "justification": "The customer requires this."
        }
    ],
    "baseline": [
        {
            "auditId": "link-name",
            "score": 0
        },
        {
            "auditId": "uses-responsive-images",
            "score": 0.86
        },
        {
            "auditId": "first-contentful-paint",
            "score": 0.41
        },
        {
            "auditId": "redirects-http",
            "score": 0
        },
        {
            "auditId": "uses-long-cache-ttl",
            "score": 0.3
        }
    ]
}

```

## Command-line

`lighhouse-ignore <url>`

An example output may be:

```
Launching Chrome and running Lighthouse audits

76 audits have been successful.

This includes the folowing audits from the baseline, which you may want to remove from the baseline now:
- link-name: Links have a discernible name
- uses-responsive-images: Properly size images: 100%

2 audits where unsuccessful but have fulfilled baseline requirements:
- first-contentful-paint: First Contentful Paint: 50%
- redirects-http: Does not redirect HTTP traffic to HTTPS

2 audits have failed:
- uses-long-cache-ttl: Uses inefficient cache policy on static assets: 23%
- uses-http2: Does not use HTTP/2 for all of its resources

See report file for details. (Opens in Chrome)

```

## API

If you are happy with the command-line features of Lighthouse-Ignore, you probably have no use case
for the API. It is intended for people who need something more elaborate than the provided command-line
but still want to take advantage of some of its functionality in their own Lightouse wrappers.

```
import * as lighthouseIgnore from "@marco-eckstein/lighthouse-ignore";

...

const config = lighthouseIgnore.readLighthouseIgnoreConfig();
lighthouseIgnore.filterLighthouseConfig(lighthouseConfig, config);
```

# Development

No global modules other than `npm` are necessary.

- Run `npm install` once after checking out.
- Then, run either `npm test` for a single full build cycle (clean, compile, lint, test), 
  or `npm start` for running the full cycle initially and then watch for file changes which will 
  trigger appropriate parts of the build cycle (compile, lint, test). The watch mode is not bulletproof:
  It works for file updates, but you may get problems if you rename or delete files.
- Publish with `npm publish --access public`. This will run the full build cycle before publishing.

---
_Source: https://npm.io/package/@marco-eckstein/lighthouse-ignore · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
