{"id":13583564,"url":"https://github.com/treosh/lighthouse-plugin-field-performance","last_synced_at":"2025-04-06T07:11:15.218Z","repository":{"id":89054402,"uuid":"185870241","full_name":"treosh/lighthouse-plugin-field-performance","owner":"treosh","description":"Add real-user performance data to your Lighthouse report","archived":false,"fork":false,"pushed_at":"2023-10-14T11:51:48.000Z","size":686,"stargazers_count":238,"open_issues_count":0,"forks_count":9,"subscribers_count":5,"default_branch":"main","last_synced_at":"2025-03-30T06:07:42.949Z","etag":null,"topics":["chrome-ux-report","lighthouse-plugin","pagespeed-insights"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","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/treosh.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,"governance":null,"roadmap":null,"authors":null}},"created_at":"2019-05-09T20:54:04.000Z","updated_at":"2025-01-22T21:53:08.000Z","dependencies_parsed_at":null,"dependency_job_id":"10501100-6905-4120-94c4-0d6a60513526","html_url":"https://github.com/treosh/lighthouse-plugin-field-performance","commit_stats":{"total_commits":100,"total_committers":3,"mean_commits":"33.333333333333336","dds":"0.16000000000000003","last_synced_commit":"a23eb15b5a9a238493075733da441e4fdfedbfab"},"previous_names":[],"tags_count":16,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/treosh%2Flighthouse-plugin-field-performance","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/treosh%2Flighthouse-plugin-field-performance/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/treosh%2Flighthouse-plugin-field-performance/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/treosh%2Flighthouse-plugin-field-performance/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/treosh","download_url":"https://codeload.github.com/treosh/lighthouse-plugin-field-performance/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247445669,"owners_count":20939958,"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":["chrome-ux-report","lighthouse-plugin","pagespeed-insights"],"created_at":"2024-08-01T15:03:35.568Z","updated_at":"2025-04-06T07:11:15.200Z","avatar_url":"https://github.com/treosh.png","language":"JavaScript","readme":"# lighthouse-plugin-field-performance\n\n\u003e Lighthouse plugin that adds field data to your report. It uses real-user data from Chrome UX Report and Core Web Vitals logic to estimate the score.\n\n[An example report for developers.google.com](https://googlechrome.github.io/lighthouse/viewer/?gist=d9072ab8ccb30622deab48e6d5ee229c):\n\n\u003ca href=\"https://googlechrome.github.io/lighthouse/viewer/?gist=d9072ab8ccb30622deab48e6d5ee229c\"\u003e\n  \u003cimg width=\"1162\" alt=\"Lighthouse Field Performance Plugin\" src=\"https://user-images.githubusercontent.com/158189/83353335-27499180-a352-11ea-8ee5-059582117a14.png\"\u003e\n\u003c/a\u003e\n\n\u003cbr /\u003e\n\u003cbr /\u003e\n\nThis plugin adds Core Web Vitals values to your Lighthouse report. The Field Performance category includes real-user data provided by [Chrome UX Report](https://developers.google.com/web/tools/chrome-user-experience-report/). It's similar to the field section in [PageSpeed Insights](https://developers.google.com/speed/pagespeed/insights/).\n\nThe scoring algorithm weighs values for Largest Contentful Paint (LCP), First Input Delay (FID), and Cumulative Layout Shift (CLS). It uses the Core Web Vitals assessment logic that sets 1 if metric is good, 0 if metric is poor, and a value from 0 to 1 if it's between. (_Note_: FCP and the origin values do not affect the score, [see the source](./src/index.js))\n\nCheck out the parity between Field \u0026 Lab performance on mobile:\n\n\u003cimg width=\"973\" alt=\"Field \u0026 lab performance on mobile\" src=\"https://user-images.githubusercontent.com/158189/83353215-31b75b80-a351-11ea-801e-07f5a2b73e51.png\"\u003e\n\nAnd on desktop:\n\n\u003cimg width=\"972\" alt=\"Field \u0026 lab performance on desktop\" src=\"https://user-images.githubusercontent.com/158189/83353212-2ebc6b00-a351-11ea-9cf8-6a04a5f0f903.png\"\u003e\n\nSometimes field data is missing because a URL doesn't have enough anonymous traffic. In this case, the lab data is the only available measurement.\n\n## Install\n\nRequires Node.js `12+` and Lighthouse `8+`.\n\n```bash\n$ npm install lighthouse lighthouse-plugin-field-performance\n```\n\n## Usage\n\nUse the plugin with [Lighthouse CLI](https://github.com/GoogleChrome/lighthouse):\n\n```bash\n$ npx lighthouse https://www.apple.com/ --plugins=lighthouse-plugin-field-performance\n```\n\nTo run more requests, provide your [PageSpeed Insights token](https://developers.google.com/speed/docs/insights/v5/get-started) using a custom config:\n\n```bash\n$ npx lighthouse https://www.apple.com/ --config-path=./config.js\n```\n\n`config.js`\n\n```js\nmodule.exports = {\n  extends: 'lighthouse:default',\n  plugins: ['lighthouse-plugin-field-performance'],\n  settings: {\n    psiToken: 'YOUR_REAL_TOKEN',\n  },\n}\n```\n\n## Credits\n\nSponsored by [Treo.sh - Page speed monitoring made simple](https://treo.sh).\n\n[![](https://github.com/treosh/lighthouse-plugin-field-performance/workflows/CI/badge.svg)](https://github.com/treosh/lighthouse-plugin-field-performance/actions?workflow=CI)\n[![](https://img.shields.io/npm/v/lighthouse-plugin-field-performance.svg)](https://npmjs.org/package/lighthouse-plugin-field-performance)\n[![](https://img.shields.io/badge/license-MIT-blue.svg)](./LICENSE)\n","funding_links":[],"categories":["JavaScript"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftreosh%2Flighthouse-plugin-field-performance","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftreosh%2Flighthouse-plugin-field-performance","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftreosh%2Flighthouse-plugin-field-performance/lists"}