Pass projectRoot and configFile to plugins file through config

[chrisbreiding]

• Closes Cypress config object passed to the plugins file should have config filename #5941

User facing changelog

• The plugins file function's config argument now includes projectRoot (absolute path to the root of the project) and configFile (absolute path to the configuration file)

Additional details

Documentation PR: cypress-io/cypress-documentation#2534

How has the user experience changed?

The plugins file config argument now includes projectRoot and configFile:

module.exports = (on, config) => {
  // {
  //  ... other properties ...
  //  configFile: '/Users/me/my-project/cypress.json',
  //  projectRoot: '/Users/me/my-project,
  // }
}

PR Tasks

• Have tests been added/updated?
• Has the original issue been tagged with a release in ZenHub?
• Has a PR for user-facing changes been opened in cypress-documentation?
• Have API changes been updated in the type definitions?
• N/A Have new configuration options been added to the cypress.schema.json?

[cypress-bot]

Thanks for the contribution! Below are some guidelines Cypress uses when doing PR reviews.

• Please write [WIP] in the title of your Pull Request if your PR is not ready for review - someone will review your PR as soon as the [WIP] is removed.
• Please familiarize yourself with the PR Review Checklist and feel free to make updates on your PR based on these guidelines.

PR Review Checklist

If any of the following requirements can't be met, leave a comment in the review selecting 'Request changes', otherwise 'Approve'.

User Experience

• The feature/bugfix is self-documenting from within the product.
• The change provides the end user with a way to fix their problem (no dead ends).

Functionality

• The code works and performs its intended function with the correct logic.
• Performance has been factored in (for example, the code cleans up after itself to not cause memory leaks).
• The code guards against edge cases and invalid input and has tests to cover it.

Maintainability

• The code is readable (too many nested 'if's are a bad sign).
• Names used for variables, methods, etc, clearly describe their function.
• The code is easy to understood and there are relevant comments explaining.
• New algorithms are documented in the code with link(s) to external docs (flowcharts, w3c, chrome, firefox).
• There are comments containing link(s) to the addressed issue (in tests and code).

Quality

• The change does not reimplement code.
• There's not a module from the ecosystem that should be used instead.
• There is no redundant or duplicate code.
• There are no irrelevant comments left in the code.
• Tests are testing the code’s intended functionality in the best way possible.

Internal

• The original issue has been tagged with a release in ZenHub.

[cypress]

---

Test summary

6966 • 0 • 97 • 0

---

Run details

Project	cypress
Status	Passed
Commit	850c1f6
Started	Feb 28, 2020 6:57 PM
Ended	Feb 28, 2020 7:04 PM
Duration	06:23 💡
OS	Linux Debian - 9.11
Browser	Multiple

View run in Cypress Dashboard ➡️

---

This comment has been generated by cypress-bot as a result of this project's GitHub integration settings. You can manage this integration in this project's settings in the Cypress Dashboard

[jennifer-shehane]

I opened an issue about throwing/warning when writing to 'readonly' config values. #6407 We can consider addressing this in this issue or not.

[bahmutov]

I love it, but do we have a TypeScript definition for plugins configuration object? If yes, we need to add these two properties, I assume project root is always a string, and config file is false or a string?

[chrisbreiding]

Working on that now 👍

[bahmutov]

super

[brian-mann]

Is this ready to merge? I approved.

[brian-mann]

conflicts with README.md

[bahmutov]

Another feature!

…

Sent from my iPhone

On Feb 28, 2020, at 13:44, Brian Mann ***@***.***> wrote:  conflicts with README.md — You are receiving this because your review was requested. Reply to this email directly, view it on GitHub, or unsubscribe.