{"id":13651332,"url":"https://github.com/ennjin/wdio-visual-regression","last_synced_at":"2025-07-02T14:33:53.159Z","repository":{"id":42096529,"uuid":"236575352","full_name":"ennjin/wdio-visual-regression","owner":"ennjin","description":"Visual regression tool for webdriver.io","archived":false,"fork":false,"pushed_at":"2023-11-06T11:07:45.000Z","size":1232,"stargazers_count":3,"open_issues_count":17,"forks_count":3,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-05-12T12:44:06.412Z","etag":null,"topics":["image-compare","nodejs","visual-regression-testing","webdriverio-plugin"],"latest_commit_sha":null,"homepage":"","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/ennjin.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}},"created_at":"2020-01-27T19:31:39.000Z","updated_at":"2024-11-04T16:35:09.000Z","dependencies_parsed_at":"2024-04-15T05:41:32.734Z","dependency_job_id":"b789426e-a17e-406b-b45a-a26eda660995","html_url":"https://github.com/ennjin/wdio-visual-regression","commit_stats":{"total_commits":68,"total_committers":7,"mean_commits":9.714285714285714,"dds":"0.47058823529411764","last_synced_commit":"6d48631fabe5ee31770922f646601c5f7e9ddcfc"},"previous_names":[],"tags_count":17,"template":false,"template_full_name":null,"purl":"pkg:github/ennjin/wdio-visual-regression","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ennjin%2Fwdio-visual-regression","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ennjin%2Fwdio-visual-regression/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ennjin%2Fwdio-visual-regression/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ennjin%2Fwdio-visual-regression/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ennjin","download_url":"https://codeload.github.com/ennjin/wdio-visual-regression/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ennjin%2Fwdio-visual-regression/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":260028648,"owners_count":22947993,"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":["image-compare","nodejs","visual-regression-testing","webdriverio-plugin"],"created_at":"2024-08-02T02:00:48.114Z","updated_at":"2025-07-02T14:33:53.119Z","avatar_url":"https://github.com/ennjin.png","language":"TypeScript","funding_links":[],"categories":["Tools and frameworks (a-z↓)"],"sub_categories":[],"readme":"# wdio-visual-regression\nVisual regression tool for webdriver.io based on [resemble.js](https://github.com/rsmbl/Resemble.js). PR's are welcome!\n\n[![npm](https://img.shields.io/npm/v/wdio-visual-regression)](https://www.npmjs.com/package/wdio-visual-regression)\n[![GitHub](https://img.shields.io/github/license/ennjin/wdio-visual-regression)](https://github.com/ennjin/wdio-visual-regression/blob/master/LICENSE)\n\n\n### Features\n- [x] Default matchers for compare active viewport and elements\n- [x] Simple and flexible API for creating custom matcher\n- [x] Output report (Jasmine, Mocha, Cucumber) in JSON format ([example](docs/REPORT_EXAMPLE.md))\n\n### How to use\n1. Install the package\n```bash\nnpm install --save-dev wdio-visual-regression\n```\n2. Import `VisualRegression` class and add it to service option in your webdriverio config file\n```js\nconst { VisualRegression } = require('wdio-visual-regression');\n\nexports.config = {\n  // other configuration\n    services: [\n        [VisualRegression, {/* options */}]\n    ]\n}\n```\n**Note:** You can find out all available options [here](docs/OPTIONS.md)\n\n3. Use available commands:\n```ts\nbrowser.matchElement(name: string, element: WebdriverIO.Element): Promise\u003cnumber\u003e\nbrowser.matchViewport(name: string): Promise\u003cnumber\u003e\n```\n\nOr create your own custom matcher for comparing anything that you need. See how to do it [here](docs/CUSTOM_MATCHERS.md)\n\nAlso, you can take a look at example usage [here](e2e/main.e2e-spec.ts)\n\n## Getting Started\nFollow to commands below for start dev environment\n\n```bash\ngit clone git@github.com:ennjin/wdio-visual-regression.git\ncd wdio-visual-regression\nnpm ci\n```\nFor start development\n```bash\nnpm run start\n```\nFor production build\n```bash\nnpm run build\n```\n\n## Running the tests\nFor running the tests type command\n```bash\nnpm run e2e\n```\n\n## Built With\n* [node-canvas](https://github.com/Automattic/node-canvas) - HTML5 canvas implementation for nodejs\n* [Resemble.js](https://github.com/rsmbl/Resemble.js) - Image analysis and comparison\n\n## License\nThis project is licensed under the MIT License - see the [LICENSE.md](LICENSE) file for details\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fennjin%2Fwdio-visual-regression","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fennjin%2Fwdio-visual-regression","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fennjin%2Fwdio-visual-regression/lists"}