cypress-documentation
cypress-documentation copied to clipboard
Config file for cypress-multi-reporters displayed as Cypress config
Description
Documentation mistakenly displays a custom reporter module's config file (reporter-config.json) as the Cypress configuration.
URL of Issue(s)
https://docs.cypress.io/guides/tooling/reporters#Cypress-configuration-4
Steps to replicate
- I read about how to configure Cypress using
cypress-multi-reportersas a reporter - I saw that the Cypress config indicates that the reporter options are in
reporter-config.json - I looked for an example
reporter-config.json, but couldn't find one - I noticed that two code blocks later, the configuration shown should actually be
reporter-config.json, and neithercypress.config.js, norcypress.json
Browser
Chrome Version 102.0.5005.115
Additional Information
The reporter config file being rendered as the cypress.config.js also leads to the documentation suggesting to wrap it in Cypress' defineConfig function, which is only meant for the Cypress configuration (if I'm not mistaken) and shows a warning about the cypress.json variant being deprecated - even though the cypress-multi-reporters reporter config is not the Cypress config.