{"id":13633795,"url":"https://github.com/codechecks/lighthouse-keeper","last_synced_at":"2025-04-18T14:33:16.892Z","repository":{"id":53403950,"uuid":"201797471","full_name":"codechecks/lighthouse-keeper","owner":"codechecks","description":"Keep an eye on Google Lighthouse score changes directly on GitHub 💡👀","archived":false,"fork":false,"pushed_at":"2021-11-28T07:16:31.000Z","size":12528,"stargazers_count":88,"open_issues_count":10,"forks_count":6,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-04-01T17:45:10.585Z","etag":null,"topics":["accessibility","codechecks","google-lighthouse","lighthouse","performance","score"],"latest_commit_sha":null,"homepage":"https://codechecks.io","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/codechecks.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-08-11T17:56:24.000Z","updated_at":"2024-11-24T23:54:01.000Z","dependencies_parsed_at":"2022-08-20T23:50:59.392Z","dependency_job_id":null,"html_url":"https://github.com/codechecks/lighthouse-keeper","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codechecks%2Flighthouse-keeper","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codechecks%2Flighthouse-keeper/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codechecks%2Flighthouse-keeper/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codechecks%2Flighthouse-keeper/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/codechecks","download_url":"https://codeload.github.com/codechecks/lighthouse-keeper/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":249470201,"owners_count":21277710,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["accessibility","codechecks","google-lighthouse","lighthouse","performance","score"],"created_at":"2024-08-01T23:00:51.829Z","updated_at":"2025-04-18T14:33:15.777Z","avatar_url":"https://github.com/codechecks.png","language":"TypeScript","funding_links":[],"categories":["Frontend development"],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n  \u003cimg src=\"meta/logo.png\" width=\"300\" alt=\"lighthouse-keeper\"\u003e\n  \u003ch3 align=\"center\"\u003eLighthouse keeper\u003c/h3\u003e\n  \u003cp align=\"center\"\u003eKeep an eye on Google Lighthouse score changes directly on GitHub 💡👀\u003c/p\u003e\n  \u003cp align=\"center\"\u003eDiscover performance, accessability, SEO problems before they reach production\u003c/p\u003e\n\n  \u003cp align=\"center\"\u003e\n    \u003ca href=\"https://circleci.com/gh/codechecks/lighthouse-keeper\"\u003e\u003cimg alt=\"Build Status\" src=\"https://circleci.com/gh/codechecks/lighthouse-keeper/tree/master.svg?style=svg\"\u003e\u003c/a\u003e\n    \u003ca href=\"/package.json\"\u003e\u003cimg alt=\"Software License\" src=\"https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square\"\u003e\u003c/a\u003e\n    \u003ca href=\"https://codechecks.io\"\u003e\u003cimg src=\"https://raw.githubusercontent.com/codechecks/docs/master/images/badges/badge-default.svg?sanitize=true\" alt=\"codechecks.io\"\u003e\u003c/a\u003e\n  \u003c/p\u003e\n\u003c/p\u003e\n\n## Demo\n\n[Example Pull Request](https://github.com/krzkaczor/lighthouse-keeper-example/pull/2)\n\n![Demo](meta/demo.gif)\n\n## Features\n\n\u003c!-- prettier-ignore --\u003e\n👉 track changes in performance, accessibility etc. directly in GitHub PR interface\u003cbr\u003e\n👉 get detailed list of new failed audits\u003cbr\u003e\n👉 automatically fail PRs if score is too low\u003cbr\u003e\n👉 works with many different [CI providers](https://github.com/codechecks/docs/blob/master/supported-ci.md)\u003cbr\u003e\n\n## Install\n\n```sh\nnpm install --save-dev @codechecks/lighthouse-keeper\n```\n\n## Usage\n\nLighthouse Keeper is built on [Codechecks](https://codechecks.io) — new open source code review\nautomation platform.\n\nTo use it, you need to install Codechecks GitHub App on a given repository and copy project secret\nto your CI environment.\n\n## Step by step guide\n\n1. Install codechecks client and lighthouse-keeper:\n\n```\nnpm install --save-dev @codechecks/client @codechecks/lighthouse-keeper\n```\n\n2. Create `codechecks.yml` file in a root of your project. It serves as a central configuration for\n   all different codechecks plugins.\n\n```yml\nchecks:\n  - name: lighthouse-keeper\n    options:\n      buildPath: ./build\n```\n\nYou might want to adjust the build path. To learn about all configuration options check out API\nsection of this document. We can dry run `lighthouse-keeper` locally. Just make sure that your build\nexists and run `npx codechecks`.\n\nNow we need to make sure that it runs on CI.\n\n3. Visit [app.codechecks.io](https://app.codechecks.io).\n4. Login with you github account and install Codechecks Github App on a desired repositories. Note:\n   We don't have access to your code.\n5. Find your project on the list and copy secret.\n6. Add new environment variable to your CI configuration `CC_SECRET= \u003cCOPIED_SECRET\u003e`.\n7. Run `npx codechecks` as part of your CI pipeline after building the app.\n8. That's it! 🔥Create your first PR and let codechecks record initial baseline. With Codechecks you\n   can track build size, visual regressions and much more! Check out other plugins at\n   [Awesome Codechecks](https://github.com/codechecks/awesome-codechecks)\n\n## API\n\n### lighthouseKeeper(options: Options): Promise\\\u003cvoid\u003e\n\n#### options\n\n```typescript\ninterface Options {\n  url?: string;\n  buildPath?: string;\n  minScores?: Dictionary\u003cnumber\u003e;\n}\n```\n\n##### url\n\noptional `string`\u003cbr\u003e Provide URL that lighthouse will be ran against. `url` OR `buildPath` MUST be\nprovided.\n\n##### buildPath\n\noptional `string`\u003cbr\u003e Provide relative path to directory with build. It will be served using\n`http-server` package and lighthouse will be ran against it. `url` OR `buildPath` MUST be provided.\n\n##### minScore\n\noptional `Dictionary of numbers`\u003cbr\u003e Provide minimal scores for each metric. Possible keys are:\n\n- performance\n- accessibility\n- best-practices\n- seo\n- pwa\n\n## Contributing\n\nAll contributions are welcomed. Read more in [CONTRIBUTING.md](./CONTRIBUTING.md)\n\n## Licence\n\nMIT @ [codechecks.io](https://codechecks.io)\n\n## Acknowledges\n\nThanks go to @andreasonny83 for his support and creating the\n[lighthouse-ci](https://github.com/andreasonny83/lighthouse-ci)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcodechecks%2Flighthouse-keeper","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcodechecks%2Flighthouse-keeper","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcodechecks%2Flighthouse-keeper/lists"}