Update reports.md: use "reporter" option instead of CLI #5211
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Motivation/Description of the PR
In
docs/reports.md, the examples for Mocha reporter configurations should use the"mocha":{"reporter":"..."}option in codecept.config.js instead of the--reporterCLI option to point out that a reporter is always tied to its options.This eliminates the risk that users forget to specify the correct reporter at some place (package.json scripts, CI scripts, ...).
It is pointless anyway to put the options of one reporter into the config file, and to specify another reporter in the CLI. This may even cause errors/exceptions from the running reporter if it sees invalid config options in the file (seen with mocha-multi).
Applicable helpers:
Applicable plugins:
Type of change
Checklist:
npm run docs)npm run lint)npm test)