{"id":19714639,"url":"https://github.com/quavedev/performance-audit","last_synced_at":"2026-05-10T20:32:40.606Z","repository":{"id":39975117,"uuid":"257905388","full_name":"quavedev/performance-audit","owner":"quavedev","description":null,"archived":false,"fork":false,"pushed_at":"2023-01-06T07:11:32.000Z","size":1237,"stargazers_count":2,"open_issues_count":14,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-02-10T16:06:36.584Z","etag":null,"topics":["audit","lighthouse","performance","scores"],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/quavedev.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-04-22T13:11:34.000Z","updated_at":"2023-10-20T12:00:39.000Z","dependencies_parsed_at":"2023-02-05T14:46:31.165Z","dependency_job_id":null,"html_url":"https://github.com/quavedev/performance-audit","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/quavedev%2Fperformance-audit","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/quavedev%2Fperformance-audit/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/quavedev%2Fperformance-audit/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/quavedev%2Fperformance-audit/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/quavedev","download_url":"https://codeload.github.com/quavedev/performance-audit/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":241035831,"owners_count":19898082,"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":["audit","lighthouse","performance","scores"],"created_at":"2024-11-11T22:34:33.083Z","updated_at":"2026-05-10T20:32:35.567Z","avatar_url":"https://github.com/quavedev.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Performance Audit by Quave\n\nEasily check the performance of a web address according to Google's PageSpeed and compare with an expected baseline. To know more about the scores, see https://developers.google.com/web/tools/lighthouse.\nThis test is designed to run on a CI to monitor the scores over time and notify when a regression occurs.\n\n## Installation\n\n`npm install @quave/performance-audit`\n\n## How to use\n\nPass a array of tests to the `checkPerformance` function.\n\nTest object structure:\n- `url`: The link to test\n- `stategy`: Should be `desktop` or `mobile`\n- `threshold`: How much the results need to differ to trigger a fail \n- `pwa`, `bestPractices`, `accessibility`, `seo`, `performance`: Scores baselines for the tests (optional)\n- `appJsTransferSize`, `appCssTransferSize`: Sizes baselines of the js and css bundles (optional)\n- `jsIdentifier`, `cssIdentifier`: String used to identify your app's bundle. (required if using `appJsTransferSize` or `appCssTrasnferSize`)\n\nAdditionally, you may pass a `options` as a second argument, to use values commom for all tests.\n\n#### Example\n```js\n// Example file app.slow.test.js\nimport { checkPerformance } from \"@quave/performance-audit\";\n\ncheckPerformance({\n  applications: [\n    {\n      url: \"https://www.meteor.com\",\n      strategy: \"desktop\",\n      pwa: 0.69,\n      bestPractices: 0.77,\n      accessibility: 0.55,\n      seo: 0.6,\n      performance: 0.2,\n      appJsTransferSize: 2168542,\n      appCssTransferSize: 4513,\n    },\n  ],\n  options: {\n    threshold: 0.95,\n    jsIdentifier: '.js?meteor_js_resource=true',\n    cssIdentifier: '.css?meteor_css_resource=true',\n  },\n)\n```\n\n## Jest\nThe library uses jest to run the test. It is set as a peer dependency, so you may choose which\nversion to install.\n\n## Slow tests\nThis test usually takes several seconds to complete, and that is not great. We recommend creating a new test group e.g. _slow_ group:\n\n```js\n//File jest.slow.config.js\nmodule.exports = {\n  ...\n  testRegex: '(/__tests__/.*|(\\\\.|/)(slow\\\\.test))\\\\.jsx?$',\n  ...\n};\n```\n\nAnd then creating the performance tests in a file with the suffix `slow.test.js`.\nThese tests then can be executed by calling `jest -c jest.slow.config.js`.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fquavedev%2Fperformance-audit","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fquavedev%2Fperformance-audit","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fquavedev%2Fperformance-audit/lists"}