{"id":17006857,"url":"https://github.com/malaskowski/aet-lighthouse-extension","last_synced_at":"2025-07-18T09:38:47.280Z","repository":{"id":168792152,"uuid":"194646966","full_name":"malaskowski/aet-lighthouse-extension","owner":"malaskowski","description":"AET Extensions providing way to monitor your pages with Lighthouse by providing KPIs","archived":false,"fork":false,"pushed_at":"2022-12-10T22:09:13.000Z","size":156,"stargazers_count":1,"open_issues_count":2,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-01-27T11:21:11.852Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/malaskowski.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"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,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-07-01T09:56:42.000Z","updated_at":"2023-04-07T15:53:42.000Z","dependencies_parsed_at":null,"dependency_job_id":"d285fc58-5f2f-4da9-ae1a-5d326e42d56c","html_url":"https://github.com/malaskowski/aet-lighthouse-extension","commit_stats":null,"previous_names":["malaskowski/aet-lighthouse-extension"],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/malaskowski%2Faet-lighthouse-extension","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/malaskowski%2Faet-lighthouse-extension/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/malaskowski%2Faet-lighthouse-extension/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/malaskowski%2Faet-lighthouse-extension/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/malaskowski","download_url":"https://codeload.github.com/malaskowski/aet-lighthouse-extension/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244952621,"owners_count":20537469,"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":[],"created_at":"2024-10-14T05:23:49.516Z","updated_at":"2025-03-22T11:44:34.619Z","avatar_url":"https://github.com/malaskowski.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"# AET Extension: Lighthouse\nThis repository contains the [Lighthouse](https://developers.google.com/web/tools/lighthouse/) \nextension for the [AET](https://github.com/Cognifide/aet).\n\nContents:\n- bundle that contains Lighthouse Report [Collector](https://github.com/Cognifide/aet/wiki/Collectors) and\n[Comparator](https://github.com/Cognifide/aet/wiki/Comparators),\n- default configuration,\n- [AET Report](https://github.com/Cognifide/aet/tree/master/report) extension for Lighthouse results,\n- simple HTTP Server written in NodeJS that provides Web Endpoint to run Lighthouse\n\n![Lighthouse AET Report](misc/report-screenshot.png)\n\n## Lighthouse Extension\n\n### Lighthouse Collector\nThis collector requires external Lighthouse instance with Web Endpoint configured.\n`lighthouseInstanceUri` property in the [`LighthouseCollectorFactory`](https://github.com/Skejven/aet-lighthouse-extension/blob/master/conf/com.github.skejven.collector.LighthouseCollectorFactory.cfg)\nshould be set to the Web Endpoint under which [Lighthouse Server](https://github.com/Skejven/aet-lighthouse-extension/tree/master/lighthouse-server)\nworks.\nExpected response is a JSON with specification explained in the [Lighthouse Server Endpoint docs](https://github.com/Skejven/aet-lighthouse-extension/tree/master/lighthouse-server#endpoint).\n\nModule name: **`lighthouse`**\n\n#### Collector Parameters\n\nNo parameters so far.\n\n### Lighthouse Comparator\nThis comparator is form of a health-check. It base on the Lighthouse report collected by the \n[AET Lighthouse Collector](#lighthouse-collector) and compares the results against KPI (see the \n[parameters](#comparator-parameters) section below).\nIf the difference between Lighthouse scores (from the collector) and any of `kpi-` parameter \nvalue is negative and bigger than `kpi-threshold`, comparison will end with `FAILED` status. E.g.\n- Let's set `kpi-performance` to `80` and `kpi-threshold` to `10`.\n  1. When the Lighthouse *Performance* audit score will be `60` that means that our KPI failed and the report will be red.\n  2. When the Lighthouse *Performance* audit score will be `72` that means it fit in the threshold and it will pass.\n\nModule name: **`lighthouse`**\n\nResource name: `lighthouse`\n\n#### Comparator Parameters\n\n| Parameter | Value | Description | Mandatory |\n| --------- | ----- | ----------- | --------- |\n| `kpi-threshold` | integer (default: `5`) | Accepted difference between `kpi` values and Lighthouse results | no |\n| `kpi-performance` | integer (default: `75`) | Minimal score for `performance` KPI. | no |\n| `kpi-accessibility` | integer (default: `75`) | Minimal score for `accessibility` KPI. | no |\n| `kpi-best-practices` | integer (default: `75`) | Minimal score for `best-practices` KPI. | no |\n| `kpi-seo` | integer (default: `75`) | Minimal score for `seo` KPI. | no |\n\n### Example usage\nTo use the `lighthouse` plugin simply put `\u003clighthouse /\u003e` tag in `collect` and `compare` sections.\n\nExample suite:\n\n```xml\n\u003c?xml version=\"1.0\" encoding=\"UTF-8\" ?\u003e\n\u003csuite name=\"lighthouse\" company=\"aet\" project=\"lighthouse\"\u003e\n    \u003ctest name=\"max-one-url\"\u003e\n        \u003ccollect\u003e\n            \u003clighthouse/\u003e\n        \u003c/collect\u003e\n        \u003ccompare\u003e\n            \u003clighthouse kpi-threshold=\"10\"/\u003e\n        \u003c/compare\u003e\n        \u003curls\u003e\n            \u003curl href=\"https://github.com\"/\u003e\n        \u003c/urls\u003e\n    \u003c/test\u003e\n\u003c/suite\u003e\n\n```\n\n\u003e Yes, you don't need `\u003copen/\u003e`.\n\n## Building\nSimply run `build` task.\nThe results will be following artifacts:\n- `aet-lighthouse-extension.jar` bundle\n- `aet-lighthouse-report.zip` - containing [AET Report](https://github.com/Cognifide/aet/tree/master/report) \nextension to display Lighthouse findings\n- `aet-lighthouse-config.zip` - containing configs for the module\n- `aet-lighthouse-server.zip` - containing simple HTTP Server written in NodeJS that runs Lighthouse\n\n## Deploying\nToDo\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmalaskowski%2Faet-lighthouse-extension","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmalaskowski%2Faet-lighthouse-extension","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmalaskowski%2Faet-lighthouse-extension/lists"}