{"id":20137083,"url":"https://github.com/ctrf-io/codeceptjs-ctrf-json-reporter","last_synced_at":"2026-05-13T04:05:14.977Z","repository":{"id":231404181,"uuid":"751570993","full_name":"ctrf-io/codeceptjs-ctrf-json-reporter","owner":"ctrf-io","description":"A Codeceptjs JSON test results reporter that follows the CTRF schema","archived":false,"fork":false,"pushed_at":"2025-02-16T19:41:57.000Z","size":115,"stargazers_count":0,"open_issues_count":13,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-02-16T20:28:39.456Z","etag":null,"topics":["codeceptjs","codeceptjs-reporter","test-automation","test-reporting"],"latest_commit_sha":null,"homepage":"https://ctrf.io","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/ctrf-io.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","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":"2024-02-01T21:41:59.000Z","updated_at":"2025-02-16T19:42:01.000Z","dependencies_parsed_at":"2024-06-01T11:56:41.006Z","dependency_job_id":"4197e529-810a-45e7-8923-de5f88f4dea1","html_url":"https://github.com/ctrf-io/codeceptjs-ctrf-json-reporter","commit_stats":null,"previous_names":["ctrf-io/codeceptjs-ctrf-json-reporter"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ctrf-io%2Fcodeceptjs-ctrf-json-reporter","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ctrf-io%2Fcodeceptjs-ctrf-json-reporter/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ctrf-io%2Fcodeceptjs-ctrf-json-reporter/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ctrf-io%2Fcodeceptjs-ctrf-json-reporter/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ctrf-io","download_url":"https://codeload.github.com/ctrf-io/codeceptjs-ctrf-json-reporter/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":241582523,"owners_count":19985846,"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":["codeceptjs","codeceptjs-reporter","test-automation","test-reporting"],"created_at":"2024-11-13T21:25:06.347Z","updated_at":"2025-11-29T06:06:29.147Z","avatar_url":"https://github.com/ctrf-io.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Codeceptjs JSON test results report\n\n\u003e Save Codeceptjs test results as a JSON file\n\nA codeceptjs JSON test reporter to create test reports that follow the CTRF standard.\n\n[Common Test Report Format](https://ctrf.io) ensures the generation of uniform JSON test reports, independent of programming languages or test framework in use.\n\n\u003cdiv align=\"center\"\u003e\n\u003cdiv style=\"padding: 1.5rem; border-radius: 8px; margin: 1rem 0; border: 1px solid #30363d;\"\u003e\n\u003cspan style=\"font-size: 23px;\"\u003e💚\u003c/span\u003e\n\u003ch3 style=\"margin: 1rem 0;\"\u003eCTRF tooling is open source and free to use\u003c/h3\u003e\n\u003cp style=\"font-size: 16px;\"\u003eSupport the project by giving it a follow and a star ⭐\u003c/p\u003e\n\n\u003cdiv style=\"margin-top: 1.5rem;\"\u003e\n\u003ca href=\"https://github.com/ctrf-io/codeceptjs-ctrf-json-reporter\"\u003e\n\u003cimg src=\"https://img.shields.io/github/stars/ctrf-io/codeceptjs-ctrf-json-reporter?style=for-the-badge\u0026color=2ea043\" alt=\"GitHub stars\"\u003e\n\u003c/a\u003e\n\u003ca href=\"https://github.com/ctrf-io\"\u003e\n\u003cimg src=\"https://img.shields.io/github/followers/ctrf-io?style=for-the-badge\u0026color=2ea043\" alt=\"GitHub followers\"\u003e\n\u003c/a\u003e\n\u003c/div\u003e\n\u003c/div\u003e\n\n\u003cp style=\"font-size: 14px; margin: 1rem 0;\"\u003e\n\nContributions are very welcome! \u003cbr/\u003e\nExplore more \u003ca href=\"https://www.ctrf.io/integrations\"\u003eintegrations\u003c/a\u003e \u003cbr/\u003e\n\u003ca href=\"https://app.formbricks.com/s/cmefs524mhlh1tl01gkpvefrb\"\u003eLet us know your thoughts\u003c/a\u003e.\n\n\u003c/p\u003e\n\u003c/div\u003e\n\n## Features\n\n- Generate JSON test reports that follow [CTRF](https://ctrf.io)\n- Straightforward integration with codeceptjs\n\n```json\n{\n  \"results\": {\n    \"tool\": {\n      \"name\": \"codeceptjs\"\n    },\n    \"summary\": {\n      \"tests\": 1,\n      \"passed\": 1,\n      \"failed\": 0,\n      \"pending\": 0,\n      \"skipped\": 0,\n      \"other\": 0,\n      \"start\": 1706828654274,\n      \"stop\": 1706828655782\n    },\n    \"tests\": [\n      {\n        \"name\": \"ctrf should generate the same report with any tool\",\n        \"status\": \"passed\",\n        \"duration\": 100\n      }\n    ],\n    \"environment\": {\n      \"appName\": \"MyApp\",\n      \"buildName\": \"MyBuild\",\n      \"buildNumber\": \"1\"\n    }\n  }\n}\n```\n\n## What is CTRF?\n\nCTRF is a universal JSON test report schema that addresses the lack of a standardized format for JSON test reports.\n\n**Consistency Across Tools:** Different testing tools and frameworks often produce reports in varied formats. CTRF ensures a uniform structure, making it easier to understand and compare reports, regardless of the testing tool used.\n\n**Language and Framework Agnostic:** It provides a universal reporting schema that works seamlessly with any programming language and testing framework.\n\n**Facilitates Better Analysis:** With a standardized format, programatically analyzing test outcomes across multiple platforms becomes more straightforward.\n\n## Installation\n\n```bash\nnpm install --save-dev codeceptjs-ctrf-json-reporter\n```\n\nAdd the reporter to your codeceptjs.config.js file:\n\n```javascript\nplugins: {\n  ctrfJsonReporter: {\n    require: 'codeceptjs-ctrf-json-reporter',\n    enabled: true,\n  },\n    // ... other plugins ...\n},\n```\n\nRun your tests:\n\n```bash\nnpm run codeceptjs\n```\n\nYou'll find a JSON file named `ctrf-report.json` in the `ctrf` directory.\n\n## Reporter Options\n\nThe reporter supports several configuration options:\n\n```javascript\nplugins: {\n  ctrfJsonReporter: {\n    require: 'codeceptjs-ctrf-json-reporter',\n    enabled: true,\n    outputFile: 'custom-name.json', // Optional: Output file name. Defaults to 'ctrf-report.json'.\n    outputDir: 'custom-directory',  // Optional: Output directory path. Defaults to 'ctrf'.\n    appName: 'MyApp',               // Optional: Specify the name of the application under test.\n    appVersion: '1.0.0',            // Optional: Specify the version of the application under test.\n    osPlatform: 'linux',            // Optional: Specify the OS platform.\n    osRelease: '18.04',             // Optional: Specify the OS release version.\n    osVersion: '5.4.0',             // Optional: Specify the OS version.\n    buildName: 'MyApp Build',       // Optional: Specify the build name.\n    buildNumber: '100',             // Optional: Specify the build number.\n  }\n}\n```\n\n## Test Object Properties\n\nThe test object in the report includes the following [CTRF properties](https://ctrf.io/docs/schema/test):\n\n| Name       | Type   | Required | Details                                                                             |\n| ---------- | ------ | -------- | ----------------------------------------------------------------------------------- |\n| `name`     | String | Required | The name of the test.                                                               |\n| `status`   | String | Required | The outcome of the test. One of: `passed`, `failed`, `skipped`, `pending`, `other`. |\n| `duration` | Number | Required | The time taken for the test execution, in milliseconds.                             |\n\n## Support Us\n\nIf you find this project useful, consider giving it a GitHub star ⭐ It means a lot to us.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fctrf-io%2Fcodeceptjs-ctrf-json-reporter","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fctrf-io%2Fcodeceptjs-ctrf-json-reporter","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fctrf-io%2Fcodeceptjs-ctrf-json-reporter/lists"}