{"id":24753865,"url":"https://github.com/codeceptjs/helper","last_synced_at":"2025-10-11T00:30:58.504Z","repository":{"id":41786728,"uuid":"297474750","full_name":"codeceptjs/helper","owner":"codeceptjs","description":"Base class for CodeceptJS helpers","archived":false,"fork":false,"pushed_at":"2024-03-07T10:36:19.000Z","size":19,"stargazers_count":1,"open_issues_count":1,"forks_count":4,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-08-27T07:19:08.145Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"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/codeceptjs.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-09-21T22:25:21.000Z","updated_at":"2024-02-10T05:20:26.000Z","dependencies_parsed_at":"2024-04-19T06:33:05.225Z","dependency_job_id":null,"html_url":"https://github.com/codeceptjs/helper","commit_stats":{"total_commits":20,"total_committers":7,"mean_commits":2.857142857142857,"dds":0.75,"last_synced_commit":"bf7fad0f1c78afd3672ef369a51caf03763760c1"},"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"purl":"pkg:github/codeceptjs/helper","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codeceptjs%2Fhelper","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codeceptjs%2Fhelper/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codeceptjs%2Fhelper/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codeceptjs%2Fhelper/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/codeceptjs","download_url":"https://codeload.github.com/codeceptjs/helper/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codeceptjs%2Fhelper/sbom","scorecard":{"id":296054,"data":{"date":"2025-08-11","repo":{"name":"github.com/codeceptjs/helper","commit":"bf7fad0f1c78afd3672ef369a51caf03763760c1"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":3.5,"checks":[{"name":"Code-Review","score":1,"reason":"Found 2/17 approved changesets -- score normalized to 1","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":"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":"Token-Permissions","score":0,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Warn: no topLevel permission defined: .github/workflows/publish-node.js.yml:1","Warn: no topLevel permission defined: .github/workflows/test.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":"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":"Pinned-Dependencies","score":0,"reason":"dependency not pinned by hash detected -- score normalized to 0","details":["Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish-node.js.yml:15: update your workflow using https://app.stepsecurity.io/secureworkflow/codeceptjs/helper/publish-node.js.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish-node.js.yml:16: update your workflow using https://app.stepsecurity.io/secureworkflow/codeceptjs/helper/publish-node.js.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yml:22: update your workflow using https://app.stepsecurity.io/secureworkflow/codeceptjs/helper/test.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yml:24: update your workflow using https://app.stepsecurity.io/secureworkflow/codeceptjs/helper/test.yml/master?enable=pin","Warn: npmCommand not pinned by hash: .github/workflows/publish-node.js.yml:24","Warn: npmCommand not pinned by hash: .github/workflows/test.yml:29","Info:   0 out of   4 GitHub-owned GitHubAction dependencies pinned","Info:   0 out of   2 npmCommand 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":"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":"Vulnerabilities","score":10,"reason":"0 existing vulnerabilities detected","details":null,"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}},{"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":"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":"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":"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 14 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"}}]},"last_synced_at":"2025-08-17T19:31:51.180Z","repository_id":41786728,"created_at":"2025-08-17T19:31:51.180Z","updated_at":"2025-08-17T19:31:51.180Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":279005659,"owners_count":26083942,"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-10T02:00:06.843Z","response_time":62,"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":[],"created_at":"2025-01-28T11:36:37.057Z","updated_at":"2025-10-11T00:30:58.188Z","avatar_url":"https://github.com/codeceptjs.png","language":"TypeScript","readme":"# CodeceptJS Helper\n\nBase class for all CodeceptJS helpers. This class has been moved into a separate package to allow other helpers to be extended from it, without requiring main codeceptjs package.\n\n## Installation\n\n    npm i @codeceptjs/helper --save\n\n## Usage\n\n[Create CodeceptJS helper as described in documentation](https://codecept.io/helpers/).\n\n```js\nconst Helper = require('@codeceptjs/helper');\n\nclass MyHelper extends Helper {\n  // implement custom helper here\n}\n```\n\n## API\n\n\u003c!-- Generated by documentation.js. Update this documentation by updating the source code. --\u003e\n\n#### Table of Contents\n\n-   [Helper](#helper)\n    -   [Parameters](#parameters)\n    -   [\\_validateConfig](#_validateconfig)\n        -   [Parameters](#parameters-1)\n    -   [\\_setConfig](#_setconfig)\n        -   [Parameters](#parameters-2)\n    -   [\\_init](#_init)\n    -   [\\_before](#_before)\n        -   [Parameters](#parameters-3)\n    -   [\\_after](#_after)\n    -   [\\_test](#_test)\n        -   [Parameters](#parameters-4)\n    -   [\\_passed](#_passed)\n        -   [Parameters](#parameters-5)\n    -   [\\_failed](#_failed)\n        -   [Parameters](#parameters-6)\n    -   [\\_beforeStep](#_beforestep)\n        -   [Parameters](#parameters-7)\n    -   [\\_afterStep](#_afterstep)\n        -   [Parameters](#parameters-8)\n    -   [\\_beforeSuite](#_beforesuite)\n        -   [Parameters](#parameters-9)\n    -   [\\_afterSuite](#_aftersuite)\n        -   [Parameters](#parameters-10)\n    -   [\\_finishTest](#_finishtest)\n        -   [Parameters](#parameters-11)\n    -   [\\_useTo](#_useto)\n        -   [Parameters](#parameters-12)\n    -   [helpers](#helpers)\n    -   [debug](#debug)\n        -   [Parameters](#parameters-13)\n    -   [debugSection](#debugsection)\n        -   [Parameters](#parameters-14)\n    -   [\\_config](#_config)\n\n### Helper\n\nAbstract class.\nHelpers abstracts test execution backends.\n\nMethods of Helper class will be available in tests in `I` object.\nThey provide user-friendly abstracted actions over NodeJS libraries.\n\nHooks (methods starting with `_`) can be used to setup/teardown,\nor handle execution flow.\n\nMethods are expected to return a value in order to be wrapped in promise.\n\n#### Parameters\n\n-   `config` **any** \n\n#### \\_validateConfig\n\nAbstract method to validate config\n\n##### Parameters\n\n-   `config` **any** \n\nReturns **any** \n\n#### \\_setConfig\n\nSets config for current test\n\n##### Parameters\n\n-   `opts` **any** \n\n#### \\_init\n\nHook executed before all tests\n\n#### \\_before\n\nHook executed before each test.\n\n##### Parameters\n\n-   `test` **Mocha.Test** \n\n#### \\_after\n\nHook executed after each test\n\n#### \\_test\n\nHook provides a test details\nExecuted in the very beginning of a test\n\n##### Parameters\n\n-   `test` **Mocha.Test** \n\n#### \\_passed\n\nHook executed after each passed test\n\n##### Parameters\n\n-   `test` **Mocha.Test** \n\n#### \\_failed\n\nHook executed after each failed test\n\n##### Parameters\n\n-   `test` **Mocha.Test** \n\n#### \\_beforeStep\n\nHook executed before each step\n\n##### Parameters\n\n-   `step` **CodeceptJS.Step** \n\n#### \\_afterStep\n\nHook executed after each step\n\n##### Parameters\n\n-   `step` **CodeceptJS.Step** \n\n#### \\_beforeSuite\n\nHook executed before each suite\n\n##### Parameters\n\n-   `suite` **Mocha.Suite** \n\n#### \\_afterSuite\n\nHook executed after each suite\n\n##### Parameters\n\n-   `suite` **Mocha.Suite** \n\n#### \\_finishTest\n\nHook executed after all tests are executed\n\n##### Parameters\n\n-   `suite` **Mocha.Suite** \n\n#### \\_useTo\n\nAbstract method to provide common interface to accessing helpers internals inside a test.\n\n##### Parameters\n\n-   `description`  \n-   `fn`  \n\n#### helpers\n\nAccess another configured helper: `this.helpers['AnotherHelper']`\n\nType: any\n\n#### debug\n\nPrint debug message to console (outputs only in debug mode)\n\n##### Parameters\n\n-   `msg` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** \n\n#### debugSection\n\n##### Parameters\n\n-   `section` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** \n-   `msg` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** \n\n#### \\_config\n\nAbstract method to provide required config options\n\nReturns **any** \n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcodeceptjs%2Fhelper","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcodeceptjs%2Fhelper","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcodeceptjs%2Fhelper/lists"}