Skip to content

Added documentation for the new option --disable-coverage-php #864

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 13, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion docs/Codecoverage.md
Original file line number Diff line number Diff line change
Expand Up @@ -92,10 +92,13 @@ All you need is to execute codeception with `--coverage` option.
To generate a clover xml report or a tasty html report append also `--coverage-xml` and `--coverage-html` options.


```yaml
```bash
php vendor/bin/codecept run --coverage --coverage-xml --coverage-html
```

> note: If you don't need to generate default PHP coverage report (coverage.serialized) you can call `--disable-coverage-php` option.
This option can help you reduce memory usage and fix problems with memory leak on the huge projects.

XML and HTML reports are stored to the `_output` directory. The best way to review report is to open `index.html` from `tests/_output/coverage` in your browser.
XML clover reports are used by IDEs (like PHPStorm) or Continuous Integration servers (like Jenkins).

Expand Down
67 changes: 34 additions & 33 deletions docs/reference/Commands.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,39 +54,40 @@ Arguments:

Options:
-o, --override=OVERRIDE Override config values (multiple values allowed)
--config (-c) Use custom path for config
--report Show output in compact style
--html Generate html with results (default: "report.html")
--xml Generate JUnit XML Log (default: "report.xml")
--phpunit-xml Generate PhpUnit XML Log (default: "phpunit-report.xml")
--no-redirect Do not redirect to Composer-installed version in vendor/codeception
--colors Use colors in output
--no-colors Force no colors in output (useful to override config file)
--silent Only outputs suite names and final results. Almost the same as `--quiet`
--steps Show steps in output
--debug (-d) Alias for `-vv`
--bootstrap Execute bootstrap script before the test
--coverage Run with code coverage (default: "coverage.serialized")
--coverage-html Generate CodeCoverage HTML report in path (default: "coverage")
--coverage-xml Generate CodeCoverage XML report in file (default: "coverage.xml")
--coverage-text Generate CodeCoverage text report in file (default: "coverage.txt")
--coverage-phpunit Generate CodeCoverage PHPUnit report in file (default: "coverage-phpunit")
--coverage-cobertura Generate CodeCoverage Cobertura report in file (default: "coverage-cobertura")
--no-exit Don't finish with exit code
--group (-g) Groups of tests to be executed (multiple values allowed)
--skip (-s) Skip selected suites (multiple values allowed)
--skip-group (-x) Skip selected groups (multiple values allowed)
--env Run tests in selected environments. (multiple values allowed, environments can be merged with ',')
--fail-fast (-f) Stop after nth failure (defaults to 1)
--no-rebuild Do not rebuild actor classes on start
--help (-h) Display this help message.
--quiet (-q) Do not output any message. Almost the same as `--silent`
--verbose (-v|vv|vvv) Increase the verbosity of messages: `v` for normal output, `vv` for steps and debug, `vvv` for Codeception-internal debug
--version (-V) Display this application version.
--ansi Force ANSI output.
--no-ansi Disable ANSI output.
--no-interaction (-n) Do not ask any interactive question.
--seed Use the given seed for shuffling tests
--config (-c) Use custom path for config
--report Show output in compact style
--html Generate html with results (default: "report.html")
--xml Generate JUnit XML Log (default: "report.xml")
--phpunit-xml Generate PhpUnit XML Log (default: "phpunit-report.xml")
--no-redirect Do not redirect to Composer-installed version in vendor/codeception
--colors Use colors in output
--no-colors Force no colors in output (useful to override config file)
--silent Only outputs suite names and final results. Almost the same as `--quiet`
--steps Show steps in output
--debug (-d) Alias for `-vv`
--bootstrap Execute bootstrap script before the test
--coverage Run with code coverage (default: "coverage.serialized")
--disable-coverage-php Don't generate CodeCoverage report in raw PHP serialized format
--coverage-html Generate CodeCoverage HTML report in path (default: "coverage")
--coverage-xml Generate CodeCoverage XML report in file (default: "coverage.xml")
--coverage-text Generate CodeCoverage text report in file (default: "coverage.txt")
--coverage-phpunit Generate CodeCoverage PHPUnit report in file (default: "coverage-phpunit")
--coverage-cobertura Generate CodeCoverage Cobertura report in file (default: "coverage-cobertura")
--no-exit Don't finish with exit code
--group (-g) Groups of tests to be executed (multiple values allowed)
--skip (-s) Skip selected suites (multiple values allowed)
--skip-group (-x) Skip selected groups (multiple values allowed)
--env Run tests in selected environments. (multiple values allowed, environments can be merged with ',')
--fail-fast (-f) Stop after nth failure (defaults to 1)
--no-rebuild Do not rebuild actor classes on start
--help (-h) Display this help message.
--quiet (-q) Do not output any message. Almost the same as `--silent`
--verbose (-v|vv|vvv) Increase the verbosity of messages: `v` for normal output, `vv` for steps and debug, `vvv` for Codeception-internal debug
--version (-V) Display this application version.
--ansi Force ANSI output.
--no-ansi Disable ANSI output.
--no-interaction (-n) Do not ask any interactive question.
--seed Use the given seed for shuffling tests

{% endhighlight %}

Expand Down
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy