{"id":16950259,"url":"https://github.com/mischnic/screenshot-tester","last_synced_at":"2026-05-07T14:41:32.271Z","repository":{"id":66274089,"uuid":"131024808","full_name":"mischnic/screenshot-tester","owner":"mischnic","description":"A node testing library for comparing GUI app screenshot","archived":false,"fork":false,"pushed_at":"2020-07-17T09:32:12.000Z","size":4290,"stargazers_count":1,"open_issues_count":3,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-09-23T05:57:44.112Z","etag":null,"topics":["node","nodejs","test","testing","testing-tools","ui"],"latest_commit_sha":null,"homepage":"","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/mischnic.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":"2018-04-25T15:12:18.000Z","updated_at":"2019-07-08T22:06:31.000Z","dependencies_parsed_at":"2023-02-22T06:16:30.967Z","dependency_job_id":null,"html_url":"https://github.com/mischnic/screenshot-tester","commit_stats":{"total_commits":55,"total_committers":3,"mean_commits":"18.333333333333332","dds":"0.036363636363636376","last_synced_commit":"e6f94630195ca1cd02a2dbe6a621cf62590c761d"},"previous_names":[],"tags_count":9,"template":false,"template_full_name":null,"purl":"pkg:github/mischnic/screenshot-tester","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mischnic%2Fscreenshot-tester","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mischnic%2Fscreenshot-tester/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mischnic%2Fscreenshot-tester/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mischnic%2Fscreenshot-tester/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mischnic","download_url":"https://codeload.github.com/mischnic/screenshot-tester/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mischnic%2Fscreenshot-tester/sbom","scorecard":{"id":649493,"data":{"date":"2025-08-11","repo":{"name":"github.com/mischnic/screenshot-tester","commit":"e6f94630195ca1cd02a2dbe6a621cf62590c761d"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":1.5,"checks":[{"name":"Code-Review","score":0,"reason":"Found 0/17 approved changesets -- score normalized to 0","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":"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":"Dangerous-Workflow","score":-1,"reason":"no workflows found","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":"Token-Permissions","score":-1,"reason":"No tokens found","details":null,"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":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"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":"Binary-Artifacts","score":8,"reason":"binaries present in source code","details":["Warn: binary detected: lib/screenshot-cmd/screenshot.exe:1","Warn: binary detected: lib/screenshot/screenshot:1"],"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":"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":"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":"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":"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":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'master'"],"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":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 15 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":"Pinned-Dependencies","score":-1,"reason":"no dependencies found","details":null,"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":"Vulnerabilities","score":0,"reason":"42 existing vulnerabilities detected","details":["Warn: Project is vulnerable to: GHSA-v88g-cgmw-v5xw","Warn: Project is vulnerable to: GHSA-93q8-gq69-wqmw","Warn: Project is vulnerable to: GHSA-v6h2-p8h4-qcjw","Warn: Project is vulnerable to: GHSA-gxpj-cx7g-858c","Warn: Project is vulnerable to: GHSA-fjxv-7rqg-78g4","Warn: Project is vulnerable to: GHSA-896r-f27r-55mw","Warn: Project is vulnerable to: GHSA-f8q6-p94x-37v3","Warn: Project is vulnerable to: GHSA-vh95-rmgr-6w4m","Warn: Project is vulnerable to: GHSA-xvch-5gv4-984h","Warn: Project is vulnerable to: GHSA-hrpp-h998-j3pp","Warn: Project is vulnerable to: GHSA-p8p7-x288-28g6","Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw","Warn: Project is vulnerable to: GHSA-j44m-qm6p-hp7m","Warn: Project is vulnerable to: GHSA-3jfq-g458-7qm9","Warn: Project is vulnerable to: GHSA-5955-9wpr-37jh","Warn: Project is vulnerable to: GHSA-f5x3-32g6-xq36","Warn: Project is vulnerable to: GHSA-r628-mhmh-qjhw","Warn: Project is vulnerable to: GHSA-9r2w-394v-53qc","Warn: Project is vulnerable to: GHSA-qq89-hq3f-393p","Warn: Project is vulnerable to: GHSA-72xf-g2v4-qvf3","Warn: Project is vulnerable to: GHSA-67hx-6x53-jw92","Warn: Project is vulnerable to: GHSA-cwfw-4gq5-mrqx","Warn: Project is vulnerable to: GHSA-g95f-p29q-9xw4","Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg","Warn: Project is vulnerable to: GHSA-9vvw-cc9w-f27h","Warn: Project is vulnerable to: GHSA-w573-4hg7-7wgq","Warn: Project is vulnerable to: GHSA-8r6j-v8pm-fqw3","Warn: Project is vulnerable to: MAL-2023-462","Warn: Project is vulnerable to: GHSA-qqgx-2p2h-9c37","Warn: Project is vulnerable to: GHSA-9c47-m6qq-7p4h","Warn: Project is vulnerable to: GHSA-6c8f-qphg-qjgp","Warn: Project is vulnerable to: GHSA-jf85-cpcp-j695","Warn: Project is vulnerable to: GHSA-p6mc-m468-83gw","Warn: Project is vulnerable to: GHSA-29mw-wpgm-hmr9","Warn: Project is vulnerable to: GHSA-35jh-r3h4-6jhm","Warn: Project is vulnerable to: GHSA-82v2-mx6x-wq7q","Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv","Warn: Project is vulnerable to: GHSA-fhjf-83wg-r2j9","Warn: Project is vulnerable to: GHSA-jv35-xqg7-f92r","Warn: Project is vulnerable to: GHSA-4g88-fppr-53pp","Warn: Project is vulnerable to: GHSA-4jqc-8m5r-9rpr","Warn: Project is vulnerable to: GHSA-cf4h-3jhx-xvhq"],"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-21T13:06:46.591Z","repository_id":66274089,"created_at":"2025-08-21T13:06:46.591Z","updated_at":"2025-08-21T13:06:46.591Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":281386589,"owners_count":26492014,"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","status":"online","status_checked_at":"2025-10-28T02:00:06.022Z","response_time":60,"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":["node","nodejs","test","testing","testing-tools","ui"],"created_at":"2024-10-13T21:57:12.970Z","updated_at":"2025-10-28T05:06:16.924Z","avatar_url":"https://github.com/mischnic.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# screenshot-tester\n\nTake screenshots (= snapshots) of desktop (node) apps (i.e. [libui-node](https://github.com/parro-it/libui-node)) to test for regressions.\n\n![An example report generated by screenshot-tester](report.png \"HTML Report\")\n\n## Usage:\n\n```js\nconst test = require(\"screenshot-tester\")();\n\n(async function(){\n    await test(\"my_example.js\", \"The Window Title\");\n})();\n```\n\nor for native apps:\n\n```js\nconst test = require(\"screenshot-tester\")({raw: true});\n\n(async function(){\n    await test(\"app\", \"The Window Title\");\n})();\n```\n\nThis will:\n- Run `node my_example.js` or `app`.\n- Take a screenshot of the window with the specified title.\n- Close the app.\n- Compare with or create a new reference screenshot.\n\n\nA failed test will generate a diff file, hightlighting the differing areas in red:\n\n```\n─ outDir ('.')\n  ├─ reference\n  │  └─ my_example.js.png\n  └─ tmp\n     ├─ my_example.js.png\n     └─ my_example.js_diff.png\n```\n\n## Reference\n\n```js\nconst test = require(\"screenshot-tester\")({\n        outDir = \".\",\n        raw = false,\n        interactive = false,\n        delay = 0,\n        accuracy = \"0.01%\",\n        logger = require(\"screenshot-tester\").defaultLogger\n    });\n\nasync function test(file, title, {delay, raw, delta = 20}){};\n\nfunction test.generateHTML(){};\n\nasync function test.pushToServer(host, repoId, issue, onlyFailed, osAppend) {};\n```\n\n### Parameters\n\n#### `require(\"screenshot-tester\")(...)`\n- `outDir`: *Optional* - The folder in which the screenshots will be saved (see above).\n- `raw`: *Optional* - Set to `true` to run a binary instead of a node script. It is applied to all following `test()` calls.\n- `interactive`: *Optional* - Whether to prompt the user if the reference image should be updated if a test failed.\n- `delay`: *Optional* - Additional delay after starting the application (in ms). It is applied to all following `test()` calls.\n- `accuracy`: *Optional* - The threshold (`500` or `\"500\"` =\u003e 500px, `\"0.01%\"` =\u003e 0.01%)\n- `logger`: *Optional* - A function to call for logging: `function(type, file, error){}`. Types: `PASSED, FAILED, MISSING, ERROR, REPORT, OS, RETRY, PUSH`\n\n### `test(...)`\n- `file`: The node script/binary to test (or an array to pass arguments).\n- `title`: The title of the window to be captured.\n- `delay`: *Optional* - As above, but only for this call.\n- `raw`: *Optional* - As above, but only for this call.\n- `delta`: *Optional* - How insensitive the color comparison is.\n- `accuracy`: *Optional* - As above, but only for this call.\n\n### `test.generateHTML()`\n\nThis will generate a HTML report (see example image) at `${outDir}/report.html`.\n\n### `test.pushToServer(...)`\n\nSend the result this test to a [screenshot-tester-server](https://github.com/mischnic/screenshot-tester-server) instance.\n\n- `host`: The domain of the server (e.g. `https://example.com`)\n- `repoId`: The GitHub repo of the current pull request(e.g. `owner/repo-name`)\n- `issue`: The PR number (e.g. `2`)\n- `onlyFailed`: Whether to push only failed tests\n- `osAppend`: String to append to the reported OS\n\n## Requirements\n\n- **macOS**: Python 3 and `pip install click pyobjc-framework-Quartz`\n- **Linux**: ImageMagick\n\n## Bundled projects\n\n- for macOS: https://github.com/mischnic/screenshot-native\n- screenshot-cmd for Windows from https://github.com/chuntaro/screenshot-cmd\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmischnic%2Fscreenshot-tester","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmischnic%2Fscreenshot-tester","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmischnic%2Fscreenshot-tester/lists"}