{"id":15654514,"url":"https://github.com/tlvince/make-coverage-badge","last_synced_at":"2025-04-04T14:04:28.984Z","repository":{"id":23202882,"uuid":"98414027","full_name":"tlvince/make-coverage-badge","owner":"tlvince","description":"Create a coverage badge","archived":false,"fork":false,"pushed_at":"2023-04-24T18:12:22.000Z","size":871,"stargazers_count":27,"open_issues_count":29,"forks_count":213,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-28T13:04:39.937Z","etag":null,"topics":["coverage-badge","istanbul","jest"],"latest_commit_sha":null,"homepage":null,"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/tlvince.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":".github/SECURITY.md","support":".github/SUPPORT.md","governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":"tlvince"}},"created_at":"2017-07-26T11:08:48.000Z","updated_at":"2025-01-06T12:59:00.000Z","dependencies_parsed_at":"2024-06-18T14:06:47.284Z","dependency_job_id":null,"html_url":"https://github.com/tlvince/make-coverage-badge","commit_stats":{"total_commits":101,"total_committers":7,"mean_commits":"14.428571428571429","dds":"0.19801980198019797","last_synced_commit":"aa1725bc9a3474e4a1a230e0c205ad0bfed12490"},"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tlvince%2Fmake-coverage-badge","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tlvince%2Fmake-coverage-badge/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tlvince%2Fmake-coverage-badge/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tlvince%2Fmake-coverage-badge/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/tlvince","download_url":"https://codeload.github.com/tlvince/make-coverage-badge/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247184860,"owners_count":20897844,"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":["coverage-badge","istanbul","jest"],"created_at":"2024-10-03T12:52:11.088Z","updated_at":"2025-04-04T14:04:28.951Z","avatar_url":"https://github.com/tlvince.png","language":"JavaScript","funding_links":["https://github.com/sponsors/tlvince"],"categories":[],"sub_categories":[],"readme":"# make-coverage-badge\n\n[![Build Status][travis-image]][travis-url]\n[![npm version][npm-image]][npm-url]\n[![License][license-image]][license-url]\n\n[travis-url]: https://travis-ci.org/tlvince/make-coverage-badge\n[travis-image]: https://img.shields.io/travis/tlvince/make-coverage-badge.svg\n[npm-url]: https://www.npmjs.com/package/make-coverage-badge\n[npm-image]: https://img.shields.io/npm/v/make-coverage-badge.svg\n[license-url]: https://opensource.org/licenses/MIT\n[license-image]: https://img.shields.io/npm/l/make-coverage-badge.svg\n\n\u003e Create a coverage badge\n\nCreates a code coverage badge like the following:\n\n![Coverage badge][coverage-badge]\n\nCurrently just reads from Istanbul's JSON summary reporter and downloads a badge from https://shields.io/. Don't expect too much! Send a PR if you need configuration etc.\n\n[coverage-badge]: https://img.shields.io/badge/Coverage-100%25-brightgreen.svg\n\n## Usage\n\n(For Create React Apps)\n\n1. Configure Jest (in `package.json`):\n\n```json\n\"jest\": {\n  \"coverageReporters\": [\n    \"json-summary\"\n  ]\n}\n```\n\n2. Run `npm test -- --coverage`\n3. Run `make-coverage-badge`\n\nResulting badge will be in `./coverage/badge.svg`.\n\n## Options\n\n### `--output-path \u003cpath\u003e`\n\nWrites the coverage badge to the given path (relative to project root). Defaults to `./coverage/badge.svg`.\n\n### `--report-path \u003cpath\u003e`\n\nPath to a coverage report file. Defaults to `./coverage/coverage-summary.json`.\n\n## Prior work\n\n- [Coveralls][]: paid for private repos\n- [coverage-badger][]: same approach, but using an XML report and therefore requires XML dependencies\n\n[coveralls]: https://coveralls.io/\n[coverage-badger]: https://github.com/notnotse/coverage-badger\n\n## Author\n\n© 2019 Tom Vincent \u003cgit@tlvince.com\u003e (https://tlvince.com)\n\n## License\n\nReleased under the [MIT license](http://tlvince.mit-license.org).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftlvince%2Fmake-coverage-badge","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftlvince%2Fmake-coverage-badge","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftlvince%2Fmake-coverage-badge/lists"}