GoogleChrome / GoogleChrome/lighthouse

Gatherers should have ids

Open
#2,087 4 comments 1 reaction 0 assignees View on GitHub
internals P3
Dominant language
JavaScript
Stars
30.8k
Forks
9.8k
Avg merge
1d 20h
Merged PRs (30d)
19

Description

Currently we use filenames to refer to gatherers within the project. And we also publicly display the their classes `[[ClassName]]` like in this message:

> status Loading page & waiting for onload +332ms HTTPRedirect, HTMLWithoutJavaScript

IMO there's benefit to each gatherer providing an id and a readable name. (As Audits do with with `.name` and `.description` respectively)

Possible uses:

* use instead of [[classname]] when logging our loading/gather activity to the user
* For the [--do=GAR proposal](https://github.com/GoogleChrome/lighthouse/issues/1806#issuecomment-297843024), know what to name the `/artifacts/` files on disk

Adding this mostly means adding a `static get meta() {` on the gatherer classes, returning an object with some properties (a la audits). Also a test in gather-runner to assert these exist.

We can put them to real use in a 2nd PR.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.