{"id":15008333,"url":"https://github.com/umbrellio/coverspector","last_synced_at":"2025-04-09T16:03:07.881Z","repository":{"id":55542221,"uuid":"222465928","full_name":"umbrellio/coverspector","owner":"umbrellio","description":"This package helps to check that code coverage above minimum value. It can be useful in CI or git hooks.","archived":false,"fork":false,"pushed_at":"2020-12-22T21:22:29.000Z","size":71,"stargazers_count":4,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-04-09T16:01:59.211Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"PHP","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/umbrellio.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":"2019-11-18T14:17:04.000Z","updated_at":"2020-12-22T21:22:02.000Z","dependencies_parsed_at":"2022-08-15T02:50:49.271Z","dependency_job_id":null,"html_url":"https://github.com/umbrellio/coverspector","commit_stats":null,"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/umbrellio%2Fcoverspector","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/umbrellio%2Fcoverspector/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/umbrellio%2Fcoverspector/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/umbrellio%2Fcoverspector/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/umbrellio","download_url":"https://codeload.github.com/umbrellio/coverspector/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248065289,"owners_count":21041871,"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-24T19:17:40.443Z","updated_at":"2025-04-09T16:03:07.839Z","avatar_url":"https://github.com/umbrellio.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Coverspector\n\n[![Github Status](https://github.com/umbrellio/coverspector/workflows/CI/badge.svg)](https://github.com/umbrellio/coverspector/actions)\n[![Coverage Status](https://coveralls.io/repos/github/umbrellio/coverspector/badge.svg?branch=master)](https://coveralls.io/github/umbrellio/coverspector?branch=master)\n[![Latest Stable Version](https://poser.pugx.org/umbrellio/coverspector/v/stable.png)](https://packagist.org/packages/umbrellio/coverspector)\n[![Total Downloads](https://poser.pugx.org/umbrellio/coverspector/downloads.png)](https://packagist.org/packages/umbrellio/coverspector)\n[![Code Intelligence Status](https://scrutinizer-ci.com/g/umbrellio/coverspector/badges/code-intelligence.svg?b=master)](https://scrutinizer-ci.com/code-intelligence)\n[![Build Status](https://scrutinizer-ci.com/g/umbrellio/coverspector/badges/build.png?b=master)](https://scrutinizer-ci.com/g/umbrellio/coverspector/build-status/master)\n[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/umbrellio/coverspector/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/umbrellio/coverspector/?branch=master)\n\nThis package helps to check that code coverage above minimum value. It can be useful in CI or git hooks.\n\n## Features\n - Fail CI/hook when code coverage is less than minimal value.\n - Print list of uncovered files\n \n \n## Installation\nRun this command to install:\n```bash\ncomposer require umbrellio/coverspector\n```\n## Usage\nAllow coverage toll to print info about uncovered files.\nIn case of phpunit, add to phpunit config:\n```\naddUncoveredFilesFromWhitelist=\"true\"\n```\nIn case of codeception:\n```yml\nshow_uncovered: true\n```\n\nIn your CI, dump coverage output into file\n```bash\nvendor/bin/codecept run --coverage | tee coverage.txt\n```\n\nThan, run coverspector with minimum code coverage value\n```bash\nvendor/bin/coverspector --file=coverage.txt --min=100\n```\nIf coverage will be less, coverspector will fail the job and print list of all not totaly covered files\n\n## CI Coverage Artifacts\nIf you still want to save coverage report as CI artifact - you should set \n```\nwhen: on_failure\n```\nin your CI config.\n\n## License\n\nReleased under MIT License.\n\n## Authors\n\nCreated by Makin Vladislav.\n\n## Contributing\n\n- Fork it ( https://github.com/umbrellio/coverspector )\n- Create your feature branch (`git checkout -b feature/my-new-feature`)\n- Commit your changes (`git commit -am 'Add some feature'`)\n- Push to the branch (`git push origin feature/my-new-feature`)\n- Create new Pull Request\n\n\u003ca href=\"https://github.com/umbrellio/\"\u003e\n\u003cimg style=\"float: left;\" src=\"https://umbrellio.github.io/Umbrellio/supported_by_umbrellio.svg\" alt=\"Supported by Umbrellio\" width=\"439\" height=\"72\"\u003e\n\u003c/a\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fumbrellio%2Fcoverspector","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fumbrellio%2Fcoverspector","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fumbrellio%2Fcoverspector/lists"}