{"id":20827692,"url":"https://github.com/peridot-php/peridot-code-coverage-reporters","last_synced_at":"2025-05-07T21:04:46.837Z","repository":{"id":21629528,"uuid":"24950080","full_name":"peridot-php/peridot-code-coverage-reporters","owner":"peridot-php","description":"Code coverage reporters for Peridot.","archived":false,"fork":false,"pushed_at":"2017-09-18T09:29:48.000Z","size":34,"stargazers_count":2,"open_issues_count":2,"forks_count":5,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-05-07T21:04:40.858Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"http://peridot-php.github.io/","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/peridot-php.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2014-10-08T16:38:06.000Z","updated_at":"2025-01-30T18:03:09.000Z","dependencies_parsed_at":"2022-08-23T20:51:01.400Z","dependency_job_id":null,"html_url":"https://github.com/peridot-php/peridot-code-coverage-reporters","commit_stats":null,"previous_names":[],"tags_count":7,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/peridot-php%2Fperidot-code-coverage-reporters","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/peridot-php%2Fperidot-code-coverage-reporters/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/peridot-php%2Fperidot-code-coverage-reporters/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/peridot-php%2Fperidot-code-coverage-reporters/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/peridot-php","download_url":"https://codeload.github.com/peridot-php/peridot-code-coverage-reporters/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252954432,"owners_count":21830903,"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-11-17T23:12:45.859Z","updated_at":"2025-05-07T21:04:46.814Z","avatar_url":"https://github.com/peridot-php.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Peridot Code Coverage Reporters\n\n[![Packagist Version](https://img.shields.io/packagist/v/peridot-php/peridot-code-coverage-reporters.svg?style=flat-square \"Packagist Version\")](https://packagist.org/packages/peridot-php/peridot-code-coverage-reporters)\n[![Build Status](https://img.shields.io/travis/peridot-php/peridot-code-coverage-reporters/master.svg?style=flat-square \"Build Status\")](https://travis-ci.org/peridot-php/peridot-code-coverage-reporters)\n[![Scrutinizer Code Quality](https://img.shields.io/scrutinizer/g/peridot-php/peridot-code-coverage-reporters.svg?style=flat-square \"Scrutinizer Code Quality\")](https://scrutinizer-ci.com/g/peridot-php/peridot-code-coverage-reporters/?branch=master)\n[![Codecov Coverage](https://img.shields.io/codecov/c/github/peridot-php/peridot-code-coverage-reporters/master.svg?style=flat-square \"Codecov Coverage\")](https://codecov.io/gh/peridot-php/peridot-code-coverage-reporters)\n[![Gitter Chat](https://img.shields.io/gitter/room/peridot-php/lobby.svg?style=flat-square \"Gitter Chat\")](https://gitter.im/peridot-php/lobby)\n\n## Installation\n\nAdd this package as a dependency:\n\n    composer require --dev peridot-php/peridot-code-coverage-reporters\n\nThen register the reporters in your `peridot.php` configuration:\n\n```php\nuse Evenement\\EventEmitterInterface;\nuse Peridot\\Reporter\\CodeCoverage\\CodeCoverageReporter;\nuse Peridot\\Reporter\\CodeCoverageReporters;\n\nreturn function (EventEmitterInterface $emitter) {\n    $coverage = new CodeCoverageReporters($emitter);\n    $coverage-\u003eregister();\n\n    $emitter-\u003eon('code-coverage.start', function (CodeCoverageReporter $reporter) {\n        $reporter-\u003eaddDirectoryToWhitelist(__DIR__ . '/src');\n    });\n};\n```\n\n## Usage\n\nThis package provides several *Peridot* reporters that can be used via the\n`--reporter` option:\n\n- `html-code-coverage`\n- `text-code-coverage`\n- `clover-code-coverage`\n- `xml-code-coverage`\n- `crap4j-code-coverage`\n- `php-code-coverage`\n\nThese reporters are all driven by [php-code-coverage], which requires the use of\neither the `phpdbg` executable, or the `xdebug` PHP extension in order to\nproduce coverage reports.\n\n### With `phpdbg`\n\nWhere available, `phpdbg` is generally recommended for faster coverage\nreporting. Most system-level package management tools should be able to install\na version of `phpdbg` with minimal hassle. Under [Homebrew], for example,\n`phpdbg` can be installed like so:\n\n    brew tap homebrew/homebrew-php \u0026\u0026 brew install php71 --with-phpdbg\n\nOnce installed, `phpdbg -qrr` can be used in place of `php` when executing\nscripts, including the `peridot` binary, allowing code coverage to be generated:\n\n    phpdbr -qrr vendor/bin/peridot --reporter spec --reporter html-code-coverage\n\nThe above command will print spec-style output while the suite runs, and\ngenerate an HTML coverage report once the suite has completed.\n\n### With `xdebug`\n\nUse of `xdebug` is no longer recommended, because of the significantly worse\nperformance compared to `phpdbg`. If `phpdbg` is not an option, simply make sure\nthe `xdebug` extension is enabled when running `peridot`:\n\n    vendor/bin/peridot --reporter spec --reporter html-code-coverage\n\nThe above command will print spec-style output while the suite runs, and\ngenerate an HTML coverage report once the suite has completed.\n\n[homebrew]: https://brew.sh/\n[php-code-coverage]: https://github.com/sebastianbergmann/php-code-coverage\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fperidot-php%2Fperidot-code-coverage-reporters","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fperidot-php%2Fperidot-code-coverage-reporters","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fperidot-php%2Fperidot-code-coverage-reporters/lists"}