{"id":23672744,"url":"https://github.com/wongelz/guidebook","last_synced_at":"2026-04-16T02:31:59.828Z","repository":{"id":57724062,"uuid":"101065313","full_name":"wongelz/guidebook","owner":"wongelz","description":"Pretty reports for selenium","archived":false,"fork":false,"pushed_at":"2022-06-16T12:08:22.000Z","size":255,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-05-21T07:47:34.992Z","etag":null,"topics":["scalatest","selenium"],"latest_commit_sha":null,"homepage":"","language":"Scala","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/wongelz.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}},"created_at":"2017-08-22T13:21:39.000Z","updated_at":"2022-06-16T11:56:20.000Z","dependencies_parsed_at":"2022-09-02T06:54:43.049Z","dependency_job_id":null,"html_url":"https://github.com/wongelz/guidebook","commit_stats":null,"previous_names":[],"tags_count":16,"template":false,"template_full_name":null,"purl":"pkg:github/wongelz/guidebook","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wongelz%2Fguidebook","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wongelz%2Fguidebook/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wongelz%2Fguidebook/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wongelz%2Fguidebook/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/wongelz","download_url":"https://codeload.github.com/wongelz/guidebook/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wongelz%2Fguidebook/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31868493,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-15T15:24:51.572Z","status":"online","status_checked_at":"2026-04-16T02:00:06.042Z","response_time":69,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["scalatest","selenium"],"created_at":"2024-12-29T11:18:32.308Z","updated_at":"2026-04-16T02:31:59.808Z","avatar_url":"https://github.com/wongelz.png","language":"Scala","funding_links":[],"categories":[],"sub_categories":[],"readme":"Guidebook\n=========\n\nGuidebook is an extension library and style guide for [Scalatest Selenium DSL](http://www.scalatest.org/user_guide/using_selenium)\nfor even simpler regression testing and producing a guidebook-style report for your tests.\n\n![](docs/screenshot1.png) ![](docs/screenshot2.png)\n\nExamples\n========\n\n[Sample project](https://github.com/wongelz/guidebook-examples/)\n\n[Sample report](https://wongelz.github.io/guidebook-examples/index.html)\n\nUsage\n-----\n1. Add the following to your build.sbt\n\n```\n\nlibraryDependencies ++= Seq(\n  \"com.github.wongelz\"           %% \"guidebook\"                % \"0.4.5\"  % Test\n)\n\ntestOptions in Test ++= Seq(\n  Tests.Argument(TestFrameworks.ScalaTest, \"-o\"),\n  Tests.Argument(TestFrameworks.ScalaTest, \"-C\", \"com.github.wongelz.guidebook.GuidebookReporter\")\n)\n```\n\n(Optional) If parallel browser windows (suite executions) are causing problems\n\n```\nparallelExecution in Test := false\n\n```\n\n2. Your test classes should extend `Guidebook`\n\n3. Run your tests using sbt. You need to specify a webdriver location for each browser you are testing.\neg. to test using Chrome and Firefox (gecko):\n\n```\nsbt -Dwebdriver.chrome.driver=/path/to/chromedriver -Dwebdriver.gecko.driver=/path/to/geckodriver test\n```\n\n4. Your test report will be available in `target/guidebook/index.html`.\n\nConfiguration\n-------------\n\n1. Changing the default screen size\n```\ntestOptions in Test += Tests.Argument(TestFrameworks.ScalaTest, \"-Dscreen.default.size=640x1024\")\n```\n\n2. Additional screen sizes\n\nGuidebook can resize the browser to different sizes at the conclusion of each test and take a screenshot at each size.\n\nAn additional report will be generated for each additional size, giving you view of how your site appears on different screen sizes.\nNote that there is no test execution under these sizes.\n\nUp to 5 additional sizes can be configured.\n\n```\ntestOptions in Test ++= Seq(\n  Tests.Argument(TestFrameworks.ScalaTest, \"-Dscreen.1.size=640x1024\"),\n  Tests.Argument(TestFrameworks.ScalaTest, \"-Dscreen.2.size=600x400\"),\n  ...\n  Tests.Argument(TestFrameworks.ScalaTest, \"-Dscreen.5.size=2000x1000\")\n)\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwongelz%2Fguidebook","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fwongelz%2Fguidebook","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwongelz%2Fguidebook/lists"}