{"id":15940207,"url":"https://github.com/pxlrbt/website-diff","last_synced_at":"2025-03-21T22:29:25.624Z","repository":{"id":108876957,"uuid":"303111118","full_name":"pxlrbt/website-diff","owner":"pxlrbt","description":"Utility tool that bundles a crawler and BackstopJS for visual regression testing.","archived":false,"fork":false,"pushed_at":"2020-11-20T18:59:02.000Z","size":61,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-01-26T17:12:24.664Z","etag":null,"topics":["backstopjs","crawler","visual-regression-testing"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"lgpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/pxlrbt.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":"2020-10-11T12:01:23.000Z","updated_at":"2024-04-12T02:25:48.000Z","dependencies_parsed_at":"2023-05-01T03:02:15.480Z","dependency_job_id":null,"html_url":"https://github.com/pxlrbt/website-diff","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/pxlrbt%2Fwebsite-diff","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pxlrbt%2Fwebsite-diff/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pxlrbt%2Fwebsite-diff/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pxlrbt%2Fwebsite-diff/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/pxlrbt","download_url":"https://codeload.github.com/pxlrbt/website-diff/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244879169,"owners_count":20525368,"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":["backstopjs","crawler","visual-regression-testing"],"created_at":"2024-10-07T06:40:39.242Z","updated_at":"2025-03-21T22:29:25.603Z","avatar_url":"https://github.com/pxlrbt.png","language":"JavaScript","readme":"# website-diff\n\nTool for crawling a website and running visual regression tests using [BackstopJS](https://github.com/garris/BackstopJS).\n\n## Installation\nClone the repo and install it globally so the `website-diff` command is registered.\n\n```bash\ngit clone https://github.com/pxlrbt/website-diff.git\ncd website-diff\nnpm install\nnpm install -g ./\n```\n\n## Usage\n\n### Initialize\nPublish the config file.\n```bash\nwebsite-diff init\n```\n### Crawl a site\nCrawls a site based on the config in `website-diff.yml` and stores the results in `sites.yml` so it can be modified before generating a config.\n```bash\nwebsite-diff crawl\n```\n\nYou can limit crawling pages with a common root url (e.g /blog/, /products/) with the `limitSimilar` option.\n\n### Generate BackstopJS config\nGenerates the required `backstop.json` from `backstop.yml` template file. You can define a default config for every scenario using `scenario.default` config option.\nA custom config for individual paths can be set with `scenario.custom[/path/to/page]`.\n\n```bash\nwebsite-diff generate\n```\n\n`backstop.yml` supports all options of `backstop.json` plus the additional `scenario` option that will be used as a template for all scenarios.\n\n### Run BackstopJS\nRun the visual regression test with `website-diff run`. This will generate a new config file from your template, your `backstop reference` and `backstop test` in sequence.\n\n## Notes\nThe crawler is a modified version of [backstop-crawl](https://github.com/fffunction/backstop-crawl).\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpxlrbt%2Fwebsite-diff","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpxlrbt%2Fwebsite-diff","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpxlrbt%2Fwebsite-diff/lists"}