{"id":30127706,"url":"https://github.com/sourceallies/coveralls-merge","last_synced_at":"2025-08-10T17:10:02.855Z","repository":{"id":54203435,"uuid":"65749817","full_name":"sourceallies/coveralls-merge","owner":"sourceallies","description":"A tool for sending test coverage information to Coveralls.io","archived":false,"fork":false,"pushed_at":"2021-03-03T11:06:53.000Z","size":47,"stargazers_count":8,"open_issues_count":2,"forks_count":3,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-08-02T09:27:50.617Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/sourceallies.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-15T17:08:13.000Z","updated_at":"2022-09-01T03:21:34.000Z","dependencies_parsed_at":"2022-08-13T09:10:23.774Z","dependency_job_id":null,"html_url":"https://github.com/sourceallies/coveralls-merge","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/sourceallies/coveralls-merge","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sourceallies%2Fcoveralls-merge","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sourceallies%2Fcoveralls-merge/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sourceallies%2Fcoveralls-merge/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sourceallies%2Fcoveralls-merge/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/sourceallies","download_url":"https://codeload.github.com/sourceallies/coveralls-merge/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sourceallies%2Fcoveralls-merge/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":269658378,"owners_count":24455071,"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-08-09T02:00:10.424Z","response_time":111,"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-08-10T17:10:01.651Z","updated_at":"2025-08-10T17:10:02.831Z","avatar_url":"https://github.com/sourceallies.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# coveralls-merge\nA tool that can be used to parse test coverage results, merge reports together, and POST them to coveralls.io.\n\n## The Problem\nCoveralls is a great service that allows you to easily display test coverage results for a codebase.\nIntegration is usually painless, as there are\n[several supported languages](https://coveralls.zendesk.com/hc/en-us/sections/200330349-Languages),\nand a bunch of user-written modules that can simplify the process of sending your test coverage data to Coveralls.\n\nHowever, most of these modules work off the assumption that your codebase *only uses one language*, which may\nnot always be the case. For example, if you're working on a web application that uses JavaScript for client-sided code, and\nsome other language (Java, Python, Ruby) for server-sided code, and you're interested in displaying coverage\nreports for both parts of the codebase, then this tool may be for you.\n\n## Installation\n\n``` bash\nnpm i @sourceallies/coveralls-merge --save-dev\n```\n\n## Usage\n\n### API\n\n```js\nconst coveralls = require('@sourceallies/coveralls-merge');\n\n// Create reports and options\n\ncoveralls.sendReports(reports, options);\n```\n\n`reports` is an array of Objects representing a coverage report:\n\n| key              | value                                                                                                                                                                                                                                                                                          | required |\n|------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------|\n| `type`             | String representing the type of coverage report. See [Supported Report Formats](#supported-report-formats)                                                                                                                                                                                       | yes      |\n| `reportFile`       | Path to the coverage report file, relative to the project root                                                                                                                                                                                                                                 | yes      |\n| `workingDirectory` | Path representing the working directory of the coverage report,  relative to the project root.  This is added as a prefix to the paths specified in the coverage report, and used by Coveralls to determine the location of the source file.  The default value is the project root directory. | no       |\n\n`options` is an optional parameter, which is an Object with the following configuration values:\n\n| key         | value                                                                         | default |\n|-------------|-------------------------------------------------------------------------------|---------|\n| `projectRoot` | The root directory of the project, relative to the current working directory. | `'.'`   |\n\n### Repo Token\n\nThis tool reads the Coveralls repository token from the environment variable `COVERALLS_REPO_TOKEN`.  Failing to set this environment variable will cause the tool to throw an error.\n\n## Supported Report Formats\n\n- LCOV: `lcov`\n- JaCoCo XML: `jacoco`\n\nThis tool was initially written to support the languages I needed at the time, but it is implemented in a way that\nmakes adding additional formats painless. If the format you need is not currently supported, feel free to open an\nissue or submit a PR to add it yourself.\n\n## License\n\n[Apache Public License v2.0](https://github.com/sourceallies/cover-alls/blob/master/LICENSE)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsourceallies%2Fcoveralls-merge","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsourceallies%2Fcoveralls-merge","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsourceallies%2Fcoveralls-merge/lists"}