{"id":15270318,"url":"https://github.com/akullpp/karma-cucumber-reporter","last_synced_at":"2025-04-12T06:33:10.329Z","repository":{"id":57288394,"uuid":"64943859","full_name":"akullpp/karma-cucumber-reporter","owner":"akullpp","description":"Transforms Karma test output to Cucumber format which can be postprocessed by cucumber-reporting.","archived":false,"fork":false,"pushed_at":"2020-02-12T10:34:05.000Z","size":893,"stargazers_count":5,"open_issues_count":0,"forks_count":1,"subscribers_count":3,"default_branch":"master","last_synced_at":"2024-10-31T10:51:41.067Z","etag":null,"topics":[],"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/akullpp.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":"2016-08-04T15:01:37.000Z","updated_at":"2023-09-16T21:24:11.000Z","dependencies_parsed_at":"2022-09-06T15:42:05.655Z","dependency_job_id":null,"html_url":"https://github.com/akullpp/karma-cucumber-reporter","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/akullpp%2Fkarma-cucumber-reporter","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/akullpp%2Fkarma-cucumber-reporter/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/akullpp%2Fkarma-cucumber-reporter/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/akullpp%2Fkarma-cucumber-reporter/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/akullpp","download_url":"https://codeload.github.com/akullpp/karma-cucumber-reporter/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":223502361,"owners_count":17155938,"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":[],"created_at":"2024-09-30T07:08:13.489Z","updated_at":"2024-11-07T11:05:23.961Z","avatar_url":"https://github.com/akullpp.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Karma Cucumber Reporter\n\nTransforms Karma test output to Cucumber format which can be postprocessed by [cucumber-reporting](https://github.com/damianszczepanik/cucumber-reporting).\n\n## Installation\n\n```\nnpm i -D karma-cucumber-reporter\n```\n\n## Usage\n\nTests have to be written with a specific syntax to be recognized and translated correctly.\n\n```\ndescribe('PREFIX FEATURE', function () {\n  describe('SCENARIO A', function () { //... });\n\n  describe('SCENARIO A', function () { //... });\n});\n```\n\n1. The test is only included if the `PREFIX` string matches with the `prefix` option.\n\n2. There always have to be at least one scenario, i.e. an inner `describe` block.\n\n## Configuration\n\n```\n// karma.conf.js\nmodule.exports = function(config) {\n  config.set({\n    reporters: ['cucumber'],\n  });\n};\n```\n\nIf you use multiple plugins, you have to add `karma-cucumber-reporter` as well:\n\n```\nplugins: [\n  // ...\n  require('karma-cucumber-reporter'),\n],\n```\n\n## Options\n\n### out\n\n**Type:** String\n\nFile location to write to. Defaults to `stdout` if not present.\n\n```\n// karma.conf.js\nmodule.exports = function(config) {\n  config.set({\n    reporters: ['cucumber'],\n    cucumberReporter: {\n      out: './cucumber.json'\n    }\n  });\n};\n```\n\n### prefix\n\n**Type:** String\n\nPrefix which indicates that a test should be include in the report.\n\n```\n// karma.conf.js\nmodule.exports = function(config) {\n  config.set({\n    reporters: ['cucumber'],\n    cucumberReporter: {\n      prefix: 'XYZ'\n    }\n  });\n};\n```\n\n## Example\n\nFor an example, please have a look at the [examples](examples/) folder. It will produce a report like this when you run `npm test`:\n\n![](examples/report.png)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fakullpp%2Fkarma-cucumber-reporter","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fakullpp%2Fkarma-cucumber-reporter","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fakullpp%2Fkarma-cucumber-reporter/lists"}