{"id":28515031,"url":"https://github.com/percy/percy-webdriverio","last_synced_at":"2026-03-06T02:38:09.408Z","repository":{"id":23524951,"uuid":"99253357","full_name":"percy/percy-webdriverio","owner":"percy","description":"Visual testing with WebdriverIO and Percy","archived":false,"fork":false,"pushed_at":"2025-12-29T15:02:09.000Z","size":3460,"stargazers_count":27,"open_issues_count":8,"forks_count":22,"subscribers_count":8,"default_branch":"master","last_synced_at":"2025-12-30T17:04:31.714Z","etag":null,"topics":["percy","percy-sdk","visual-regression-testing","visual-testing","visual-tests","webdriver","webdriverio"],"latest_commit_sha":null,"homepage":"https://percy.io","language":"JavaScript","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/percy.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":"CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2017-08-03T16:27:42.000Z","updated_at":"2025-11-26T13:38:27.000Z","dependencies_parsed_at":"2023-12-06T06:28:08.744Z","dependency_job_id":"6d11093d-ffb7-4583-8600-bcfda23a9f7a","html_url":"https://github.com/percy/percy-webdriverio","commit_stats":{"total_commits":781,"total_committers":23,"mean_commits":33.95652173913044,"dds":"0.38412291933418696","last_synced_commit":"acdc5bc9de4f12121c19dad8faee81b0b69e88fc"},"previous_names":[],"tags_count":30,"template":false,"template_full_name":null,"purl":"pkg:github/percy/percy-webdriverio","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/percy%2Fpercy-webdriverio","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/percy%2Fpercy-webdriverio/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/percy%2Fpercy-webdriverio/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/percy%2Fpercy-webdriverio/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/percy","download_url":"https://codeload.github.com/percy/percy-webdriverio/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/percy%2Fpercy-webdriverio/sbom","scorecard":{"id":727720,"data":{"date":"2025-08-11","repo":{"name":"github.com/percy/percy-webdriverio","commit":"8f4cd1e12497360850521e37b9da3cd220aff903"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":4,"checks":[{"name":"Code-Review","score":7,"reason":"Found 15/19 approved changesets -- score normalized to 7","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Dangerous-Workflow","score":10,"reason":"no dangerous workflow patterns detected","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Pinned-Dependencies","score":0,"reason":"dependency not pinned by hash detected -- score normalized to 0","details":["Warn: third-party GitHubAction not pinned by hash: .github/workflows/changelog.yml:9: update your workflow using https://app.stepsecurity.io/secureworkflow/percy/percy-webdriverio/changelog.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/lint.yml:8: update your workflow using https://app.stepsecurity.io/secureworkflow/percy/percy-webdriverio/lint.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/lint.yml:9: update your workflow using https://app.stepsecurity.io/secureworkflow/percy/percy-webdriverio/lint.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/lint.yml:15: update your workflow using https://app.stepsecurity.io/secureworkflow/percy/percy-webdriverio/lint.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:9: update your workflow using https://app.stepsecurity.io/secureworkflow/percy/percy-webdriverio/release.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:10: update your workflow using https://app.stepsecurity.io/secureworkflow/percy/percy-webdriverio/release.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/stale.yml:10: update your workflow using https://app.stepsecurity.io/secureworkflow/percy/percy-webdriverio/stale.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/test.yml:19: update your workflow using https://app.stepsecurity.io/secureworkflow/percy/percy-webdriverio/test.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yml:28: update your workflow using https://app.stepsecurity.io/secureworkflow/percy/percy-webdriverio/test.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yml:29: update your workflow using https://app.stepsecurity.io/secureworkflow/percy/percy-webdriverio/test.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yml:40: update your workflow using https://app.stepsecurity.io/secureworkflow/percy/percy-webdriverio/test.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/typecheck.yml:8: update your workflow using https://app.stepsecurity.io/secureworkflow/percy/percy-webdriverio/typecheck.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/typecheck.yml:9: update your workflow using https://app.stepsecurity.io/secureworkflow/percy/percy-webdriverio/typecheck.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/typecheck.yml:15: update your workflow using https://app.stepsecurity.io/secureworkflow/percy/percy-webdriverio/typecheck.yml/master?enable=pin","Info:   2 out of  14 GitHub-owned GitHubAction dependencies pinned","Info:   0 out of   2 third-party GitHubAction dependencies pinned"],"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"Token-Permissions","score":0,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Info: jobLevel 'contents' permission set to 'read': .github/workflows/Semgrep.yml:22","Info: topLevel 'contents' permission set to 'read': .github/workflows/Semgrep.yml:16","Warn: no topLevel permission defined: .github/workflows/changelog.yml:1","Warn: no topLevel permission defined: .github/workflows/lint.yml:1","Warn: no topLevel permission defined: .github/workflows/release.yml:1","Warn: no topLevel permission defined: .github/workflows/stale.yml:1","Warn: no topLevel permission defined: .github/workflows/test.yml:1","Warn: no topLevel permission defined: .github/workflows/typecheck.yml:1","Info: no jobLevel write permissions found"],"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: MIT License: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Packaging","score":10,"reason":"packaging workflow detected","details":["Info: Project packages its releases by way of GitHub Actions.: .github/workflows/release.yml:6"],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":-1,"reason":"internal error: error during branchesHandler.setup: internal error: githubv4.Query: Resource not accessible by integration","details":null,"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"SAST","score":2,"reason":"SAST tool is not run on all commits -- score normalized to 2","details":["Warn: 6 commits out of 27 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"name":"Vulnerabilities","score":0,"reason":"15 existing vulnerabilities detected","details":["Warn: Project is vulnerable to: GHSA-968p-4wvh-cqc8","Warn: Project is vulnerable to: GHSA-xffm-g5w8-qvg7","Warn: Project is vulnerable to: GHSA-93q8-gq69-wqmw","Warn: Project is vulnerable to: GHSA-v6h2-p8h4-qcjw","Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg","Warn: Project is vulnerable to: GHSA-67mh-4wv8-2f99","Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv","Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw","Warn: Project is vulnerable to: GHSA-f5x3-32g6-xq36","Warn: Project is vulnerable to: GHSA-pq67-2wwv-3xjx","Warn: Project is vulnerable to: GHSA-8cj5-5rvv-wf4v","Warn: Project is vulnerable to: GHSA-52f5-9888-hmc6","Warn: Project is vulnerable to: GHSA-c76h-2ccp-4975","Warn: Project is vulnerable to: GHSA-cxrh-j4jr-qwg3","Warn: Project is vulnerable to: GHSA-f9xv-q969-pqx4"],"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}}]},"last_synced_at":"2025-08-22T13:22:28.926Z","repository_id":23524951,"created_at":"2025-08-22T13:22:28.926Z","updated_at":"2025-08-22T13:22:28.926Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":30159659,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-05T22:39:40.138Z","status":"online","status_checked_at":"2026-03-06T02:00:08.268Z","response_time":250,"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":["percy","percy-sdk","visual-regression-testing","visual-testing","visual-tests","webdriver","webdriverio"],"created_at":"2025-06-09T02:35:16.172Z","updated_at":"2026-03-06T02:38:09.380Z","avatar_url":"https://github.com/percy.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# @percy/webdriverio\n\n[![Version](https://img.shields.io/npm/v/@percy/webdriverio.svg)](https://www.npmjs.com/package/@percy/webdriverio)\n![Test](https://github.com/percy/percy-webdriverio/workflows/Test/badge.svg)\n\n[Percy](https://percy.io) visual testing for [WebdriverIO](http://webdriver.io/).\n\n## Installation\n\n```sh-session\n$ npm install --save-dev @percy/cli @percy/webdriverio\n```\n## Usage\n\nThis is an example using the `percySnapshot()` function in async mode.\n\n```javascript\nconst percySnapshot = require('@percy/webdriverio');\n\ndescribe('webdriver.io page', () =\u003e {\n  it('should have the right title', async () =\u003e {\n    await browser.url('https://webdriver.io');\n    await expect(browser).toHaveTitle('WebdriverIO · Next-gen browser and mobile automation test framework for Node.js');\n    await percySnapshot('webdriver.io page');\n  });\n});\n```\n\nRunning the test above will result in the following log:\n\n```sh-session\n$ wdio wdio.conf.js\n...\n\n[...] webdriver.io page\n[percy] Percy is not running, disabling snapshots\n[...]    ✓ should have the right title\n\n...\n```\n\nWhen running with [`percy\nexec`](https://github.com/percy/cli/tree/master/packages/cli-exec#percy-exec), and your project's\n`PERCY_TOKEN`, a new Percy build will be created and snapshots will be uploaded to your project.\n\n```sh-session\n$ export PERCY_TOKEN=[your-project-token]\n$ percy exec -- wdio wdio.conf.js\n[percy] Percy has started!\n[percy] Created build #1: https://percy.io/[your-project]\n[percy] Running \"wdio wdio.conf.js\"\n...\n\n[...] webdriver.io page\n[percy] Snapshot taken \"webdriver.io page\"\n[...]    ✓ should have the right title\n\n...\n[percy] Stopping percy...\n[percy] Finalized build #1: https://percy.io/[your-project]\n[percy] Done!\n```\n\n### Standalone mode\n\nWhen using WebdriverIO in [standalone mode](https://webdriver.io/docs/setuptypes.html), the browser\nobject must be provided as the first argument to the `percySnapshot` function.\n\n```javascript\nconst { remote } = require('webdriverio');\nconst percySnapshot = require('@percy/webdriverio');\n\n(async () =\u003e {\n  const browser = await remote({\n    logLevel: 'trace',\n    capabilities: {\n      browserName: 'chrome'\n    }\n  });\n\n  await browser.url('https://duckduckgo.com');\n\n  const inputElem = await browser.$('#search_form_input_homepage');\n  await inputElem.setValue('WebdriverIO');\n\n  const submitBtn = await browser.$('#search_button_homepage');\n  await submitBtn.click();\n\n  // the browser object is required in standalone mode\n  percySnapshot(browser, 'WebdriverIO at DuckDuckGo');\n\n  await browser.deleteSession();\n})().catch((e) =\u003e console.error(e));\n```\n\n## Configuration\n\n`percySnapshot(name[, options])`\n\n`percySnapshot(browser, name[, options])` (standalone mode only)\n\n- `browser` (**required**) - The WebdriverIO browser object\n- `name` (**required**) - The snapshot name; must be unique to each snapshot\n- `options` - [See per-snapshot configuration options](https://www.browserstack.com/docs/percy/take-percy-snapshots/overview#per-snapshot-configuration)\n\n## Upgrading\n\n### Automatically with `@percy/migrate`\n\nWe built a tool to help automate migrating to the new CLI toolchain! Migrating\ncan be done by running the following commands and following the prompts:\n\n``` shell\n$ npx @percy/migrate\n? Are you currently using @percy/webdriverio? Yes\n? Install @percy/cli (required to run percy)? Yes\n? Migrate Percy config file? Yes\n? Upgrade SDK to @percy/webdriverio@2.0.0? Yes\n```\n\nThis will automatically run the changes described below for you.\n\n### Manually\n\nIf you're coming from a pre-2.0 version of this package, the `percySnapshot` function is now the default \nexport, and the `browser` argument is now only required when used in standalone mode.\n\n```javascript\n// before \nconst { percySnapshot } = require('@percy/webdriverio');\nawait percySnapshot(browser, 'Snapshot name', options);\n\n// after\nconst percySnapshot = require('@percy/webdriverio');\nawait percySnapshot('Snapshot name', options);\n\n// in standalone mode, browser is still required\nawait percySnapshot(browser, 'Snapshot name', options);\n```\n\n### Migrating Config\n\nIf you have a previous Percy configuration file, migrate it to the newest version with the\n[`config:migrate`](https://github.com/percy/cli/tree/master/packages/cli-config#percy-configmigrate-filepath-output) command:\n\n```sh-session\n$ percy config:migrate\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpercy%2Fpercy-webdriverio","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpercy%2Fpercy-webdriverio","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpercy%2Fpercy-webdriverio/lists"}